fuchsia.web

PROTOCOLS

ContextProvider

Defined in fuchsia.web/context.fidl

The top-level service interface which allows for the creation of Context resources.

Create

Creates a new browser Context whose state is wholly independent and isolated from other Contexts.

context: An interface request which will receive a bound Context service.

Request

Name	Type
params	CreateContextParams
context	request<Context>

Context

Defined in fuchsia.web/context.fidl

Manages browsing state (e.g. LocalStorage, cookies, etc) associated with a set of Frames.

CreateFrame

Creates a new frame under this Context. Destruction of a Context triggers the destruction of all of its associated Frames. Frames can be transferred to another component but cannot be shared across multiple components.

frame: An interface request that will be bound to the created Frame.

Request

Name	Type
frame	request<Frame>

GetCookieManager

Used to observe cookies for sites hosted under this Context.

Request

Name	Type
manager	request<CookieManager>

GetRemoteDebuggingPort

Returns the port used for remote debugging. The ContextError will be set to REMOTE_DEBUGGING_PORT_NOT_OPENED if |remote_debugging_port| was not set in CreateContextParams or the remote debugging service failed to start.

Request

Name	Type

Response

Name	Type
result	Context_GetRemoteDebuggingPort_Result

CookieManager

Defined in fuchsia.web/cookie.fidl

Provides methods for monitoring and accessing browser cookie state.

ObserveCookieChanges

Observe changes to all cookies named name that would be sent in a request to url.

If neither url nor name are set then all cookies are observed. If only url is set then all cookies for that URL are observed. If both are set then only cookies matching both fields are observed.

|changes| iterates over a stream of cookie changes. Additions or updates are expressed as complete cookies, while deletions are expressed as cookies with no |value| set.

Request

Name	Type
url	string[65536]?
name	string?
changes	request<CookiesIterator>

GetCookieList

Returns a list of Cookies, optionally limited to those matching url, and optionally name. |cookies| iterates over the matching cookies, including their |value|s.

Request

Name	Type
url	string[65536]?
name	string?
cookies	request<CookiesIterator>

CookiesIterator

Defined in fuchsia.web/cookie.fidl

Used to iterator over a set of cookies, or a stream of changes to cookies.

GetNext

Fetches the next batch of cookies, or of changes to cookies.

Request

Name	Type

Response

Name	Type
changed_cookies	vector<Cookie>

Debug

Defined in fuchsia.web/debug.fidl

The debug service which allows to enable the DevTools service on Contexts.

EnableDevTools

Enables the DevTools service on every subsequent Context creation and and delivers subsequent DevTools events to the supplied listener. The callback indicates when the WebEngine is in a debuggable state. Events will be sent to every listener registered with this method.

Request

Name	Type
listener	DevToolsListener

Response

Name	Type

DevToolsListener

Defined in fuchsia.web/debug.fidl

Interface used to observe DevTools service availability events.

OnContextDevToolsAvailable

Called when the DevTools service is available on a new Context.

listener: Channel over which DevTools events for the new Context will be delivered. This channel will disconnect when the Context is detroyed.

Request

Name	Type
listener	request<DevToolsPerContextListener>

DevToolsPerContextListener

Defined in fuchsia.web/debug.fidl

Interface supplied by the debugging component to observe the DevTools service opening event.

OnHttpPortOpen

Called when the DevTools service starts accepting TCP connections on port. port will remain open until the Context is destroyed.

port: The port used by the service.

Request

Name	Type
port	uint16

Frame

Defined in fuchsia.web/frame.fidl

CreateView

Creates a new view using the specified view_token. Caller should pass the other end of the token to CreateViewHolderCmd() to attach the new view to a the view tree.

view_token: Token for the new view.

Request

Name	Type
view_token	fuchsia.ui.views/ViewToken

GetMediaPlayer

Returns a Player interface through which media (i.e. video/audio) playback in the frame may be observed, and/or controlled. Only one media Player may be active at a time, for each Frame.

Request

Name	Type
player	request<fuchsia.media.sessions2/Player>

GetNavigationController

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.

Request

Name	Type
controller	request<NavigationController>

ExecuteJavaScript

Executes a UTF-8 encoded script in the frame if the frame's URL has an origin which matches entries in origins. At least one origins entry must be specified. If a wildcard "*" is specified in origins, then the script will be evaluated unconditionally.

Returns the result of executing |script|, as a JSON-encoded string.

Note that scripts share the same execution context as the document, meaning that document may modify variables, classes, or objects set by the script in arbitrary or unpredictable ways.

If an error occured, the FrameError will be set to one of these values: BUFFER_NOT_UTF8: script is not UTF-8 encoded. INVALID_ORIGIN: The Frame's current URL does not match any of the values in origins or origins is an empty vector.

Request

Name	Type
origins	vector<string>
script	fuchsia.mem/Buffer

Response

Name	Type
result	Frame_ExecuteJavaScript_Result

ExecuteJavaScriptNoResult

Variant of ExecuteJavaScript() which executes the supplied script without returning a result.

Request

Name	Type
origins	vector<string>
script	fuchsia.mem/Buffer

Response

Name	Type
result	Frame_ExecuteJavaScriptNoResult_Result

AddBeforeLoadJavaScript

Executes a UTF-8 encoded script for every subsequent page load where the frame's URL has an origin reflected in origins. The script is executed early, prior to the execution of the document's scripts.

Scripts are identified by a client-managed identifier id. Any script previously injected using the same id will be replaced.

The order in which multiple bindings are executed is the same as the order in which the bindings were Added. If a script is added which clobbers an existing script of the same id, the previous script's precedence in the injection order will be preserved.

At least one origins entry must be specified. If a wildcard "*" is specified in origins, then the script will be evaluated for all documents.

If an error occured, the FrameError will be set to one of these values: BUFFER_NOT_UTF8: script is not UTF-8 encoded. INVALID_ORIGIN: origins is an empty vector.

Request

Name	Type
id	uint64
origins	vector<string>
script	fuchsia.mem/Buffer

Response

Name	Type
result	Frame_AddBeforeLoadJavaScript_Result

RemoveBeforeLoadJavaScript

Removes a previously added JavaScript snippet identified by id. This is a no-op if there is no JavaScript snippet identified by id.

Request

Name	Type
id	uint64

PostMessage

Posts a message to the frame's onMessage handler.

target_origin restricts message delivery to the specified origin. If target_origin is "*", then the message will be sent to the document regardless of its origin. See html.spec.whatwg.org/multipage/web-messaging.html sect. 9.4.3 for more details on how the target origin policy is applied.

If an error occured, the FrameError will be set to one of these values: INTERNAL_ERROR: The WebEngine failed to create a message pipe. BUFFER_NOT_UTF8: The script in message's data property is not UTF-8 encoded. INVALID_ORIGIN: origins is an empty vector. NO_DATA_IN_MESSAGE: The data property is missing in message.

Request

Name	Type
target_origin	string[65536]
message	WebMessage

Response

Name	Type
result	Frame_PostMessage_Result

SetNavigationEventListener

Sets the listener for handling page navigation events.

listener: The observer to use. Unregisters any existing listener if null.

Request

Name	Type
listener	NavigationEventListener?

SetJavaScriptLogLevel

If set to a value other than NONE, allows web content to log messages to the system logger using the console APIs (debug(), log(), info(), warn() and error()). When logged to the system logger: * debug(), log() and info() logs are logged with LogLevelFilter.INFO severity level. * warn() logs are logged with LogLevelFilter.WARN severity level. * error() logs are logged with LogLevelFilter.ERROR severity level.

Request

Name	Type
level	ConsoleLogLevel

SetEnableInput

Used at runtime to enable or disable user input processing (e.g. keyboard, mouse, touch) on a Frame. Input is enabled by default.

Request

Name	Type
enable_input	bool

SetAdditionalHeadersProvider

Sets additional headers on all HTTP requests, except for top-frame navigations initiated via LoadUrl(). The callback must be processed before the first call to NavigationController.LoadUrl(). The underlying channel for provider must remain open for the entirety of the Frame lifetime. Invalid usage will result in closure of the Frame channel with ERR_INVALID_ARGS.

Request

Name	Type
provider	AdditionalHeadersProvider

Response

Name	Type

SetPopupFrameCreationListener

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.

Request

Name	Type
listener	PopupFrameCreationListener?

SetUrlRequestRewriteRules

Supplies a set of fuchsia.web.UrlRequestRewriteRule to apply on every subsequent URL request. * rules are cumulative and applied in order. * rules will be validated before being applied. If rules are invalid, the fuchsia.web.Frame will be closed with ERR_INVALID_ARGS. * fuchsia.web.Frame/SetUrlRequestRewriteRules must not be called again until its acknowledgement callback has been processed. If this happens, the fuchsia.web.Frame will be closed with ERR_BAD_STATE.

Request

Name	Type
rules	vector<UrlRequestRewriteRule>[4096]

Response

Name	Type

AdditionalHeadersProvider

Defined in fuchsia.web/frame.fidl

GetHeaders

Returns a set of headers to include in network requests. The returned headers may be cached and applied to further network requests until expiry. If expiry is in the past then headers should be used once but not cached.

Request

Name	Type

Response

Name	Type
headers	vector<fuchsia.net.http/Header>
expiry	int64

MessagePort

Defined in fuchsia.web/frame.fidl

Represents one end of an HTML5 MessageChannel. Can be used to send and exchange Messages with the peered MessagePort in the Frame's script context. The port is destroyed when either end of the MessagePort channel is torn down.

PostMessage

Sends a WebMessage to the peer. These are processed in order, one at a time. It is not necessary for the caller to wait for the completion callback before calling PostMessage() again.

If an error occured, the FrameError will be set to this value: BUFFER_NOT_UTF8: The script in message's data property is not UTF-8 encoded. NO_DATA_IN_MESSAGE: The data property is missing in message.

Request

Name	Type
message	WebMessage

Response

Name	Type
result	MessagePort_PostMessage_Result

ReceiveMessage

Asynchronously reads the next message from the channel. The client should invoke the callback when it is ready to process another message. Unreceived messages are buffered on the sender's side and bounded by its available resources.

Request

Name	Type

Response

Name	Type
message	WebMessage

PopupFrameCreationListener

Defined in fuchsia.web/frame.fidl

OnPopupFrameCreated

Called when a Frame has created a new popup |frame|. Information about the popup frame, and how it was created, is provided via |info|. Additional popup frames are delivered after the the acknowledgement callback is invoked.

Request

Name	Type
frame	Frame
info	PopupFrameCreationInfo

Response

Name	Type

NavigationEventListener

Defined in fuchsia.web/navigation.fidl

Interface supplied by the embedder for receiving notifications about navigation events in a Frame.

OnNavigationStateChanged

Called when user-visible navigation state has changed since Frame creation or the last acknowledgement callback, whichever occurred last. change will contain all the differences in navigation state since the last acknowledgement. Any unchanged properties will be left unset in change. Implementer must call the acknowledgement callback to receive new navigation events.

Request

Name	Type
change	NavigationState

Response

Name	Type

NavigationController

Defined in fuchsia.web/navigation.fidl

Provides methods for controlling and querying the navigation state of a Frame.

LoadUrl

Tells the Frame to navigate to a url. * url: The address to navigate to. * params: Additional parameters that affect how the resource will be loaded (e.g. cookies, HTTP headers, etc.)

If an error occured, the fuchsia.web.NavigationControllerError will be set: * INVALID_URL: The url parameter is invalid. * INVALID_HEADER: At least one of the headers in fuchsia.web.LoadUrlParams/headers is invalid.

Request

Name	Type
url	string[65536]
params	LoadUrlParams

Response

Name	Type
result	NavigationController_LoadUrl_Result

GoBack

Request

Name	Type

GoForward

Request

Name	Type

Stop

Request

Name	Type

Reload

Request

Name	Type
type	ReloadType

GetVisibleEntry

Returns information for the currently visible content regardless of loading state, or an empty entry if no content is being displayed.

Request

Name	Type

Response

Name	Type
entry	NavigationState

STRUCTS

Context_GetRemoteDebuggingPort_Response

generated

Name	Type	Description	Default
port	uint16		No default

Frame_ExecuteJavaScript_Response

generated

Name	Type	Description	Default
result	fuchsia.mem/Buffer		No default

Frame_ExecuteJavaScriptNoResult_Response

generated

Name	Type	Description	Default

Frame_AddBeforeLoadJavaScript_Response

generated

Name	Type	Description	Default

Frame_PostMessage_Response

generated

Name	Type	Description	Default

MessagePort_PostMessage_Response

generated

Name	Type	Description	Default

NavigationController_LoadUrl_Response

generated

Name	Type	Description	Default

ENUMS

ContextError

Type: int32

Defined in fuchsia.web/context.fidl

Name	Value	Description
REMOTE_DEBUGGING_PORT_NOT_OPENED	1

ConsoleLogLevel

Type: int32

Defined in fuchsia.web/frame.fidl

Name	Value	Description
NONE	100
DEBUG	-1
INFO	0
WARN	1
ERROR	2

FrameError

Type: int32

Defined in fuchsia.web/frame.fidl

Represents the return status of a Frame method.

Name	Value	Description
INTERNAL_ERROR	1
BUFFER_NOT_UTF8	2
INVALID_ORIGIN	3
NO_DATA_IN_MESSAGE	4

NavigationControllerError

Type: int32

Defined in fuchsia.web/navigation.fidl

Represents the return status of a NavigationController method.

Name	Value	Description
INVALID_URL	1
INVALID_HEADER	2

ReloadType

Type: uint32

Defined in fuchsia.web/navigation.fidl

Characterizes the type of reload.

Name	Value	Description
PARTIAL_CACHE	0
NO_CACHE	1

LoadUrlReason

Type: uint32

Defined in fuchsia.web/navigation.fidl

Characterizes the origin of a LoadUrl request.

Name	Value	Description
LINK	0
TYPED	1

PageType

Type: uint32

Defined in fuchsia.web/navigation.fidl

Characterizes the page type in a NavigationState.

Name	Value	Description
NORMAL	0
ERROR	1

TABLES

ContentDirectoryProvider

Defined in fuchsia.web/context.fidl

Defines a provider which hosts resources from a fuchsia.io.Directory. Content can GET resource files via the provider, but not enumerate directories. Resources can be accessed by their URLs:

content://<provider-name>/<path/to/resource>

By default the MIME types of files are determined automatically by "sniffing" the contents of the files. No content encoding will be declared, which browsers will interpret as meaning "text/plain". Content type and encoding metadata may optionally be specified explicitly by metadata/ files which reside alongside the file. Metadata is expressed in JSON files, named are the files they describe with a "._metadata" suffix. For example, the file "index.html" would have the a metadata file called "index.html._metadata", with the following contents: { "charset": "utf-8", "mime": "text/html" }

Ordinal	Name	Type	Description
1	name	string[255]	Name of the provider. Must be non-empty and composed solely of alphanumerics, dots, and dashes.
2	directory	fuchsia.io/Directory	Directory containing the files served by this provider.

CreateContextParams

Defined in fuchsia.web/context.fidl

Ordinal	Name	Type	Description
1	service_directory	fuchsia.io/Directory	Service directory to be used by the context.
2	data_directory	fuchsia.io/Directory	Handle to the directory that will contain the Context's persistent data. If it is left unset, then the created Context will be stateless, with all of its data discarded upon Context destruction. If set, `data_directory` must not be shared with any other Context.
3	user_agent_product	string	Optional suffix to append to the UserAgent string, to describe the embedder's product & version. See the User-Agent HTTP header specification at https://tools.ietf.org/html/rfc7231#section-5.5.3
4	user_agent_version	string
5	remote_debugging_port	uint16	Port to be used for remote debugging for connection via the DevTools protocol. Setting this to 0 will make the Context use an ephemeral port, which can be then queried via the Context.GetRemoteDebuggingPort() API. This is only for testing purposes and should not be set in production code.
6	content_directories	vector<ContentDirectoryProvider>[100]	List of providers whose contents will be served by content:// URLs.

CookieId

Defined in fuchsia.web/cookie.fidl

Ordinal	Name	Type	Description
1	name	string	The name of the cookie. An arbitrary string defined by the website.
2	domain	string	Specifies the host that is allowed to receive the cookie.
3	path	string	Specifies the URL path prefix which is required to receive the cookie.

Cookie

Defined in fuchsia.web/cookie.fidl

Ordinal	Name	Type	Description
1	id	CookieId	A table with fields to identify a cookie.
2	value	string	The cookie value.

WebMessage

Defined in fuchsia.web/frame.fidl

Ordinal	Name	Type	Description
1	data	fuchsia.mem/Buffer	The message payload, encoded as an UTF-8 string. This is a required property.
2	incoming_transfer	vector<IncomingTransferable>	Optional list of objects transferred into the MessagePort from the FIDL client.
3	outgoing_transfer	vector<OutgoingTransferable>	Optional list of objects transferred out of the MessagePort to the FIDL client.

PopupFrameCreationInfo

Defined in fuchsia.web/frame.fidl

Specifies additional information about a newly created popup frame.

Ordinal	Name	Type	Description
1	initial_url	string[65536]	The URL to which the popup frame was initially navigated.
2	initiated_by_user	bool	Set if the popup frame was created in response to UI interaction from the user (e.g. a link was clicked).

LoadUrlParams

Defined in fuchsia.web/navigation.fidl

Additional parameters for modifying the behavior of LoadUrl().

Ordinal	Name	Type	Description
1	type	LoadUrlReason	Provides a hint to the browser UI about how LoadUrl was triggered.
2	referrer_url	string[65536]	The URL that linked to the resource being requested.
3	was_user_activated	bool	Should be set to true to propagate user activation to the frame. User activation implies that the user is interacting with the web frame. It enables some web features that are not available otherwise. For example autoplay will work only when this flag is set to true.
4	headers	vector<fuchsia.net.http/Header>	Custom HTTP headers.

NavigationState

Defined in fuchsia.web/navigation.fidl

Contains information about the Frame's navigation state.

Ordinal	Name	Type	Description
1	url	string[65536]	The page's URL.
2	title	string	The user-visible page title.
3	page_type	PageType	Indicates whether this was a navigation to an error page.
4	can_go_forward	bool	Indicates if there is a following navigation.
5	can_go_back	bool	Indicates if there is a previous navigation.
6	is_main_document_loaded	bool	Indicates that the main document's statically declared resources have been loaded.

UrlRequestRewriteRule

Defined in fuchsia.web/url_request_rewrite_rules.fidl

Ordinal	Name	Type	Description
1	hosts_filter	vector<string>[4096]	Set of hosts to apply the rules to. If not set, the rule will apply to every request, independent of host.
2	schemes_filter	vector<string>[4096]	Set of schemes to apply the rules to. If not set, the rule will apply to every request, independent of scheme.
3	rewrites	vector<UrlRequestRewrite>[4096]	URL request rewrites to apply.

UrlRequestRewriteAddHeaders

Defined in fuchsia.web/url_request_rewrite_rules.fidl

Adds headers to the URL request. If a header is already present in the original URL request, it will be overwritten. * headers must be set. * Each fuchsia.net.http.Header in headers must have a valid HTTP header name and value, per RFC 7230 section 3.2.

Ordinal	Name	Type	Description
1	headers	vector<fuchsia.net.http/Header>[4096]

UrlRequestRewriteRemoveHeader

Defined in fuchsia.web/url_request_rewrite_rules.fidl

If query_pattern in the URL query, removes header_name from the list of headers. If query_pattern is not set, removes header_name from the list of headers unconditionally. * header_name must be set. * header_name must be a valid HTTP header name, per RFC 7230 section 3.2.

Ordinal	Name	Type	Description
1	query_pattern	string[65536]
2	header_name	vector<uint8>[4096]

UrlRequestRewriteSubstituteQueryPattern

Defined in fuchsia.web/url_request_rewrite_rules.fidl

If pattern is found in the URL request query, replaces it with substitution. * pattern and substitution must be set. * substitution must be a valid URL unit.

Ordinal	Name	Type	Description
1	pattern	string[65536]
2	substitution	string[65536]

UrlRequestRewriteReplaceUrl

Defined in fuchsia.web/url_request_rewrite_rules.fidl

If the URL in the URL request ends with url_ends_with, rewrites the URL to new_url. * url_ends_with and new_url must be set. * url_ends_with must be a valid path-relative-URL string. * new_url must be a valid URL string.

Ordinal	Name	Type	Description
1	url_ends_with	string[65536]
2	new_url	string[65536]

UNIONS

Context_GetRemoteDebuggingPort_Result

generated

Name	Type	Description
response	Context_GetRemoteDebuggingPort_Response
err	ContextError

Frame_ExecuteJavaScript_Result

generated

Name	Type	Description
response	Frame_ExecuteJavaScript_Response
err	FrameError

Frame_ExecuteJavaScriptNoResult_Result

generated

Name	Type	Description
response	Frame_ExecuteJavaScriptNoResult_Response
err	FrameError

Frame_AddBeforeLoadJavaScript_Result

generated

Name	Type	Description
response	Frame_AddBeforeLoadJavaScript_Response
err	FrameError

Frame_PostMessage_Result

generated

Name	Type	Description
response	Frame_PostMessage_Response
err	FrameError

MessagePort_PostMessage_Result

generated

Name	Type	Description
response	MessagePort_PostMessage_Response
err	FrameError

NavigationController_LoadUrl_Result

generated

Name	Type	Description
response	NavigationController_LoadUrl_Response
err	NavigationControllerError

XUNIONS

OutgoingTransferable

Defined in fuchsia.web/frame.fidl

Name	Type	Description
message_port	request<MessagePort>

IncomingTransferable

Defined in fuchsia.web/frame.fidl

Name	Type	Description
message_port	MessagePort

UrlRequestRewrite

Defined in fuchsia.web/url_request_rewrite_rules.fidl

Name	Type	Description
add_headers	UrlRequestRewriteAddHeaders	Adds a set of headers to a URL request.
remove_header	UrlRequestRewriteRemoveHeader	Removes a header based on the presence of a pattern in the URL query.
substitute_query_pattern	UrlRequestRewriteSubstituteQueryPattern	Substitutes a pattern in the URL query.
replace_url	UrlRequestRewriteReplaceUrl	Replaces a URL if the original URL ends with a pattern.

CONSTANTS

Name	Value	Type	Description
MAX_URL_LENGTH	65536	int32
MAX_URL_SCHEME_NAME_LENGTH	255	int32
MAX_HOST_LENGTH	255	int32
MAX_HEADERS_COUNT	4096	int32
MAX_RULE_COUNT	4096	int32