template <>
class WireWeakOnewayClientImpl
Defined at line 10582 of file fidling/gen/sdk/fidl/fuchsia.web/fuchsia.web/cpp/fidl/fuchsia.web/cpp/wire_messaging.h
Public Methods
::fidl::OneWayStatus CreateView (::fuchsia_ui_views::wire::ViewToken && view_token)
Creates a new view using the specified `view_token`. Caller should pass the other end of
the token to [`fuchsia.ui.gfx/ViewHolderArgs`] to attach the new view to a view tree.
See the description of [`CreateContextParams.service_directory`] for additional services
that must be present when using this method.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus CreateViewWithViewRef (::fuchsia_ui_views::wire::ViewToken && view_token, ::fuchsia_ui_views::wire::ViewRefControl && view_ref_control, ::fuchsia_ui_views::wire::ViewRef && view_ref)
Creates a new view using the specified `view_token`. Caller should pass the other end of
the token to [`fuchsia.ui.gfx/ViewHolderArgs`] to attach the new view to a view tree.
`view_ref` can be cloned before passing it to this method, which will allow clients to
track the view.
`view_ref_control` must not have the `ZX_RIGHT_DUPLICATE` set, or view creation will fail
and `view_token` will be closed.
See the description of [`CreateContextParams.service_directory`] for additional services
that must be present when using this method.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus CreateView2 (::fuchsia_web::wire::CreateView2Args args)
Creates a new Flatland view using the specified `view_creation_token` defined under `args`.
Caller should pass the other end of the token to
[`fuchsia.ui.composition/Flatland.CreateViewport`] to attach the new Flatland view to its
graph.
Allocates 56 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus EnableHeadlessRendering ()
Enables headless rendering of the Frame.
This is used when content depends on layout and/or animation events firing normally.
May only be used on a Context created with [`ContextFeatureFlags.HEADLESS`].
Allocates 32 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus DisableHeadlessRendering ()
Stops headless rendering of the Frame.
May only be used on a Context created with [`ContextFeatureFlags.HEADLESS`].
Allocates 32 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus GetMediaPlayer (::fidl::ServerEnd< ::fuchsia_media_sessions2::Player> && player)
Returns a [`fuchsia.media.sessions2/Player`] interface through which media (i.e.
video/audio) playback in the frame may be observed, and/or controlled. Only one
[`fuchsia.media.sessions2/Player`] may be active at a time, for each [`Frame`].
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus GetNavigationController (::fidl::ServerEnd< ::fuchsia_web::NavigationController> && controller)
Returns an interface through which the [`Frame`] may be navigated to a desired URL,
reloaded, etc.
- `controller`: An asynchronous interface request for the [`Frame`]'s
[`NavigationController`].
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus RemoveBeforeLoadJavaScript (uint64_t id)
Removes a previously added JavaScript snippet identified by `id`. This is a no-op if there
is no JavaScript snippet identified by `id`.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetNavigationEventListener (::fidl::ClientEnd< ::fuchsia_web::NavigationEventListener> && listener)
Sets the listener for handling page navigation events.
- `listener`: The observer to use. Unregisters any existing listener if null.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetNavigationEventListener2 (::fidl::ClientEnd< ::fuchsia_web::NavigationEventListener> && listener, ::fuchsia_web::wire::NavigationEventListenerFlags flags)
Sets the listener for handling page navigation events. The listener will receive the
current navigation state immediately. After that, it's notified whenever the state changes.
- `listener`: The observer to use. Unregisters any existing listener if null.
- `flags`: Flags for optional features that should be enabled for the listener.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetJavaScriptLogLevel (::fuchsia_web::wire::ConsoleLogLevel level)
If set to a value other than [`ConsoleLogLevel.NONE`], allows web content to log messages
to the [`fuchsia.logger/LogSink`] configured for this [`Frame`], via the
`console` object (e.g. using `debug()`, `log()`, `info()`, `warn()` and
`error()`).
The default value is [`ConsoleLogLevel.NONE`].
As the system log may be persisted, it is recommended that [`ConsoleLogLevel.NONE`] be used
in Incognito and other private browsing modes.
Log lines are written to the [`fuchsia.logger/LogsSink`] configured
for this [`fuchsia.web/Frame`], with severities mapped as follows:
- `debug()`, `log()` and `info()` are logged at [`fuchsia.logger/LogLevelFilter.INFO`]
severity.
- `warn()` is logged at [`fuchsia.logger/LogLevelFilter.WARN`] severity.
- `error()` is logged at [`fuchsia.logger/LogLevelFilter.ERROR`] severity.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetConsoleLogSink (::fidl::ClientEnd< ::fuchsia_logger::LogSink> && sink)
Specifies where to emit `console` log output to. By default log output will be routed to a
[`fuchsia.logger/LogSink`] obtained via the [`fuchsia.web/Context`]'s service directory.
- `sink`: The [`fuchsia.logger/LogSink`] to use to emit logs. Passing a `null` handle
resets logging to use the default [`fuchsia.logger/LogSink`].
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus ConfigureInputTypes (::fuchsia_web::wire::InputTypes types, ::fuchsia_web::wire::AllowInputState allow)
Enables or disables the processing of the specified `types` of user inputs.
`allow` specifies whether to enable or disable the specified `types`.
All input types are enabled by default.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetPopupFrameCreationListener (::fidl::ClientEnd< ::fuchsia_web::PopupFrameCreationListener> && listener)
Sets the listener for handling popup frame opened by web content. If no listener is
present, then any new popup frame will be blocked.
- `listener`: The listener to use. Unregisters any existing listener if null.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetMediaSettings (::fuchsia_web::wire::FrameMediaSettings settings)
Sets [`fuchsia.media/FrameMediaSettings`] for the frame. The specified parameters are
applied to audio streams that started after this message is processed. Should be called
before the Frame is navigated to content in order to ensure that the settings applied to
all media streams. Due to request pipelining, this means doing so before calling
[`Frame.GetNavigationController()`] and [`NavigationController.LoadUrl()`].
Allocates 80 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus ForceContentDimensions (::fidl::ObjectView< ::fuchsia_ui_gfx::wire::Vec2> web_dips)
Overrides the dimensions reported to web content. The devicePixelRatio reported to
web content will be adjusted in response to changes in the pixel size of the View,
rather than changing the size reported to the content. Call with null `web_dips` to
remove any prior forced content dimensions.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetPermissionState (::fuchsia_web::wire::PermissionDescriptor permission, ::fidl::StringView web_origin, ::fuchsia_web::wire::PermissionState state)
Sets the permission state for the specified `permission` and `web_origin`. By default, all
permissions are denied.
Allocates 16 bytes of response buffer on the stack. Request is heap-allocated.
::fidl::OneWayStatus SetBlockMediaLoading (bool blocked)
Sets whether to block all HTMLMediaElements in the frame from fetching and loading media
resources.
May be used, for example, to prevent loading media in frames that are not visible.
While media loading is blocked, elements with `autoplay` set to `true` will not start
playback. The promises returned by calls to `play()` will remain unresolved until loading is
unblocked by a call to this method.
When media loading is unblocked, elements will begin fetching, resource, loading, and
playing as appropriate.
Any elements that have begun fetching or loading media resources for the current source
before media loading was blocked will continue to fetch, load, and start playback as
appropriate. This includes calls to `play()` even after media loading is blocked.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetNavigationPolicyProvider (::fuchsia_web::wire::NavigationPolicyProviderParams params, ::fidl::ClientEnd< ::fuchsia_web::NavigationPolicyProvider> && provider)
Sets the navigation policy provider for the [`Frame`]. When set, the [`Frame`] sends
[`NavigationPolicyProvider.EvaluateRequestedNavigation`] when processing navigation
requests. `params` defines when the message is sent. After sending the
`EvaluateRequestedNavigation` message, the [`Frame`] blocks the corresponding navigation
until it receives a response.
Should be called before `GetNavigationController` to ensure that it is applied to all
navigations including the first [`NavigationController.LoadURL`] request.
Allocates 72 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus SetContentAreaSettings (::fuchsia_web::wire::ContentAreaSettings settings)
Sets various settings for how web content should be run in the Frame. May be called at any
time, including after the URL has loaded. Each call changes only the specified fields,
overwriting any prior value.
This method will fail with `ZX_ERR_NOT_SUPPORTED` if any value in [`ContentAreaSettings`]
is not supported by the Frame.
Allocates 80 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus ResetContentAreaSettings ()
Reset the Frame's [`ContentAreaSettings`] to default values.
Allocates 32 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::OneWayStatus Close (::fuchsia_web::wire::FrameCloseRequest FrameCloseRequest)
Request graceful or immediate teardown of the Frame content and notification of completion
via Frame epitaph.
Graceful teardown allows unload and cleanup tasks in the implementation and web content
(e.g., `unload` event handlers) to run for up to the specified period of time. Immediate
teardown only runs the minimum cleanup tasks in the implementation and does not allow web
content to run event handlers.
* If `timeout` is zero, an immediate teardown is initiated. The channel will close with
`ZX_OK`. This is equivalent to the caller closing the Frame channel.
* If `timeout` is non-zero, a graceful teardown is initiated. The channel will close with
`ZX_OK` if the Frame closes within the specified `timeout` and with `ZX_ERR_TIMED_OUT`
otherwise.
* If `timeout` is not specified, a reasonable implementation-specific timeout is applied.
Subsequent calls to `Close()` will override any previously specified `Close()` timeout.
Allocates 64 bytes of message buffer on the stack. No heap allocation necessary.