WebKit Browser Plugin

Version: 1.0

Status:

WebKitBrowser plugin for Thunder framework.

Introduction

Scope

This document describes purpose and functionality of the WebKitBrowser plugin. It includes detailed specification about its configuration, methods and properties as well as sent notifications.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym	Description
API	Application Programming Interface
HTTP	Hypertext Transfer Protocol
JSON	JavaScript Object Notation; a data interchange format
JSON-RPC	A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term	Description
callsign	The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID	Description
HTTP	HTTP specification
JSON-RPC	JSON-RPC 2.0 specification
JSON	JSON specification
Thunder	Thunder API Reference

Description

The WebKitBrowser plugin provides web browsing functionality based on the WebKit engine.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: WebKitBrowser)
classname	string	mandatory	Class name: WebKitBrowser
locator	string	mandatory	Library name: libThunderWebKitBrowser.so
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework
configuration	object	optional	...
configuration?.useragent	string	optional	The UserAgent used during communication with the web server
configuration?.url	string	optional	The URL that is loaded upon starting the browser
configuration?.injectedbundle	string	optional	The name of the .so loaded to extend the HTML5 with customized JavaScript handlers
configuration?.cookiestorage	string	optional	Post-fixed path to the persistent location on where cookies will be stored
configuration?.localstorage	string	optional	Post-fixed path to the persistent location on where local-storage will be stored
configuration?.certificatecheck	boolean	optional	If enabled, SSL certificate error will lead to a page error
configuration?.javascript	object	optional	...
configuration?.javascript?.useLLInt	boolean	optional	Enable Low Level Interpreter
configuration?.javascript?.useJIT	boolean	optional	Enable JIT
configuration?.javascript?.useDFG	boolean	optional	Enable Data-Flow-Graph-JIT compiler
configuration?.javascript?.useFTL	boolean	optional	Enable Faster-Than-Light-JIT compiler
configuration?.javascript?.useDOM	boolean	optional	Enable the DOM-JIT compiler
configuration?.javascript?.dumpOptions	string	optional	Dump options: 0 = None, 1 = Overridden only, 2 = All, 3 = Verbose
configuration?.secure	boolean	optional	If false, every domain can access any other domain, otherwise fill in fields in whitelist definition table
configuration?.whitelist	object	optional	...
configuration?.whitelist?.origin	string	optional	Origin domain allowed to access domains in domain
configuration?.whitelist?.domain	array	optional	...
configuration?.whitelist?.domain[#]	string	mandatory	Domain allowed to access from origin
configuration?.whitelist?.subdomain	string	optional	Whether it is also OK to access subdomains of domains listed in domain
configuration?.localstorageenabled	boolean	optional	Controls the local storage availability
configuration?.logtosystemconsoleenabled	boolean	optional	Enable page logging to system console (stderr)
configuration?.watchdogchecktimeoutinseconds	integer	optional	How often to check main event loop for responsiveness (0 - disable)
configuration?.watchdoghangthresholdtinseconds	integer	optional	The amount of time to give a process to recover before declaring a hang state
configuration?.loadblankpageonsuspendenabled	boolean	optional	Load 'about:blank' before suspending the page

Interfaces

This plugin implements the following interfaces:

IWebBrowser (IBrowser.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IWebBrowserExt (IBrowser.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IBrowserResources (IBrowser.h) (version 1.0.0) (uncompliant-extended format)
IBrowserSecurity (IBrowser.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IBrowserScripting (IBrowser.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.
IBrowserCookieJar (IBrowser.h) (version 1.0.0) (uncompliant-extended format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the WebKitBrowser plugin:

WebBrowser interface methods:

Method	Description
collectgarbage	Initiate garbage collection

WebBrowserExt interface methods:

Method	Description
delete / deletedir	Removes contents of a directory from the persistent storage

BrowserScripting interface methods:

Method	Description
runjavascript	Run javascript in main frame
adduserscript	Add user script to be executed at document start
removealluserscripts	Remove all user scripts

collectgarbage ^method

Initiate garbage collection.

Parameters

This method takes no parameters.

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.collectgarbage"
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

delete ^method

Removes contents of a directory from the persistent storage.

deletedir is an alternative name for this method. This name is deprecated and may be removed in the future. It is not recommended for use in new implementations.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.path	string	mandatory	Path to directory (within the persistent storage) to delete contents of

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Errors

Message	Description
`ERROR_UNKNOWN_KEY`	The given path cannot be empty

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.delete",
  "params": {
    "path": ".cache/wpe/disk-cache"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

runjavascript ^method

Run javascript in main frame.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.script	string	mandatory	Utf8 encoded JS code string

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.runjavascript",
  "params": {
    "script": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

adduserscript ^method

Add user script to be executed at document start.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.script	string	mandatory	Utf8 encoded JS code string
params.topframeonly	boolean	mandatory	Enable only top frame

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.adduserscript",
  "params": {
    "script": "...",
    "topframeonly": false
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

removealluserscripts ^method

Remove all user scripts.

Parameters

This method takes no parameters.

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.removealluserscripts"
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

Properties

The following properties are provided by the WebKitBrowser plugin:

WebBrowser interface properties:

Property	R/W	Description
url	read/write	Page loaded in the browser
visibility	read/write	Browser window visibility state
fps	read-only	Current framerate the browser is rendering at
headers	read/write	Headers to send on all requests that the browser makes
useragent	read/write	UserAgent string used by the browser
localstorageenabled	read/write	Controls the local storage availability
httpcookieacceptpolicy	read/write	HTTP cookies accept policy
bridgereply	write-only	Response for legacy $badger
bridgeevent	write-only	Send legacy $badger event

WebBrowserExt interface properties:

Property	R/W	Description
languages	read/write	User preferred languages

BrowserResources interface properties:

Property	R/W	Description
userScripts	read/write	User scripts used by the browser
userStyleSheets	read/write	User style sheets used by the browser

BrowserSecurity interface properties:

Property	R/W	Description
securityprofile	read/write	Security profile for secure connections
mixedcontentpolicy	read/write	Mixed content policy

BrowserCookieJar interface properties:

Property	R/W	Description
cookiejar	read/write	Get/Set CookieJar config details

url ^property

Provides access to the page loaded in the browser.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Page loaded in the browser

Name	Type	M/O	Description
(property)	string	mandatory	Loaded URL

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.url"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "https://example.com"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.url",
  "params": "..."
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

visibility ^property

Provides access to the browser window visibility state.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Browser window visibility state (must be one of the following: hidden, visible)

Name	Type	M/O	Description
(property)	string	mandatory	Visiblity state (must be one of the following: hidden, visible)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.visibility"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "visible"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.visibility",
  "params": "visible"
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

fps ^property

Provides access to the current framerate the browser is rendering at.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	integer	mandatory	Current FPS

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.fps"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}

headers ^property

Provides access to the headers to send on all requests that the browser makes.

Value

Name	Type	M/O	Description
(property)	opaque object	mandatory	Headers to send on all requests that the browser makes

Name	Type	M/O	Description
(property)	opaque object	mandatory	Single string containing a list of headers

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.headers"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {}
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.headers",
  "params": {}
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

useragent ^property

Provides access to the userAgent string used by the browser.

Value

Name	Type	M/O	Description
(property)	string	mandatory	UserAgent string used by the browser

Name	Type	M/O	Description
(property)	string	mandatory	UserAgent value

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.useragent"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "Mozilla/5.0 (Linux; x86_64 GNU/Linux) AppleWebKit/601.1 (KHTML, like Gecko) Version/8.0 Safari/601.1 WP"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.useragent",
  "params": "..."
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

localstorageenabled ^property

Provides access to the controls the local storage availability.

Value

Name	Type	M/O	Description
(property)	boolean	mandatory	Controls the local storage availability

Name	Type	M/O	Description
(property)	boolean	mandatory	Controls the local storage availability

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.localstorageenabled"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": false
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.localstorageenabled",
  "params": false
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

httpcookieacceptpolicy ^property

Provides access to the HTTP cookies accept policy.

Value

Name	Type	M/O	Description
(property)	string	mandatory	HTTP cookies accept policy (must be one of the following: always, exclusivelyfrommaindocumentdomain, never, onlyfrommaindocumentdomain)

Name	Type	M/O	Description
(property)	string	mandatory	HTTP Cookie Accept Policy Type (must be one of the following: always, exclusivelyfrommaindocumentdomain, never, onlyfrommaindocumentdomain)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.httpcookieacceptpolicy"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "always"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.httpcookieacceptpolicy",
  "params": "never"
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

bridgereply ^property

Provides access to the response for legacy $badger.

This property is write-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Base64 encoded JSON string response to be delivered to $badger.callback

Example

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.bridgereply",
  "params": "..."
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

bridgeevent ^property

Provides access to the send legacy $badger event.

This property is write-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Base64 encoded JSON string response to be delivered to window.$badger.event

Example

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.bridgeevent",
  "params": "..."
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

languages ^property

Provides access to the user preferred languages.

Value

Name	Type	M/O	Description
(property)	array	mandatory	User preferred languages
(property)[#]	string	mandatory	...

Name	Type	M/O	Description
(property)	array	mandatory	List of langauges preferred by the user
(property)[#]	string	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.languages"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.languages",
  "params": [
    "..."
  ]
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

userScripts ^property

Provides access to the user scripts used by the browser.

Value

Name	Type	M/O	Description
(property)	array	mandatory	User scripts used by the browser
(property)[#]	string	mandatory	...

Name	Type	M/O	Description
(property)	array	mandatory	JSON array containing URIs pointing to user scripts, supported protocols: file://
(property)[#]	string	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.userScripts"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.userScripts",
  "params": [
    "..."
  ]
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

userStyleSheets ^property

Provides access to the user style sheets used by the browser.

Value

Name	Type	M/O	Description
(property)	array	mandatory	User style sheets used by the browser
(property)[#]	string	mandatory	...

Name	Type	M/O	Description
(property)	array	mandatory	JSON array containing URIs pointing to user style sheets, supported protocols: file://
(property)[#]	string	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.userStyleSheets"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.userStyleSheets",
  "params": [
    "..."
  ]
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

securityprofile ^property

Provides access to the security profile for secure connections.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Security profile for secure connections

Name	Type	M/O	Description
(property)	string	mandatory	Security profile for secure connections

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.securityprofile"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "compatible"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.securityprofile",
  "params": "..."
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

mixedcontentpolicy ^property

Provides access to the mixed content policy.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Mixed content policy (must be one of the following: allowed, blocked)

Name	Type	M/O	Description
(property)	string	mandatory	Mixed content policy type (must be one of the following: allowed, blocked)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.mixedcontentpolicy"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": "blocked"
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.mixedcontentpolicy",
  "params": "blocked"
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

cookiejar ^property

Provides access to the get/Set CookieJar config details.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Get/Set CookieJar config details
(property).version	integer	mandatory	Version of payload format
(property).checksum	integer	mandatory	The checksum of the string used for payload creation
(property).payload	string	mandatory	Base64 string representation of compressed and encrypted cookies

Name	Type	M/O	Description
(property)	object	mandatory	Config info CookieJar
(property).version	integer	mandatory	Version of payload format
(property).checksum	integer	mandatory	The checksum of the string used for payload creation
(property).payload	string	mandatory	Base64 string representation of compressed and encrypted cookies

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.cookiejar"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "version": 0,
    "checksum": 0,
    "payload": "..."
  }
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.cookiejar",
  "params": {
    "version": 0,
    "checksum": 0,
    "payload": "..."
  }
}

Set Response

{
    "jsonrpc": "2.0",
    "id": 42,
    "result": "null"
}

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the WebKitBrowser plugin:

WebBrowser interface events:

Notification	Description
loadfinished	Initial HTML document has been completely loaded and parsed
loadfailed	Browser failed to load page
urlchange	Signals a URL change in the browser
visibilitychange	Signals a visibility change of the browser
pageclosure	Notifies that the web page requests to close its window
bridgequery	A Base64 encoded JSON message from legacy $badger bridge

BrowserCookieJar interface events:

Notification	Description
cookiejarchanged	Notifies that cookies were added, removed or modified

loadfinished ^notification

Initial HTML document has been completely loaded and parsed.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.url	string	mandatory	The URL that has been loaded
params.httpstatus	integer	mandatory	The response code of main resource request

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "loadfinished",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.loadfinished",
  "params": {
    "url": "https://example.com",
    "httpstatus": 200
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.loadfinished.

loadfailed ^notification

Browser failed to load page.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.url	string	mandatory	The URL that has been failed to load

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "loadfailed",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.loadfailed",
  "params": {
    "url": "https://example.com"
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.loadfailed.

urlchange ^notification

Signals a URL change in the browser.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.url	string	mandatory	The URL that has been loaded or requested
params.loaded	boolean	mandatory	Loaded (true) or not (false)

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "urlchange",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.urlchange",
  "params": {
    "url": "https://example.com",
    "loaded": false
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.urlchange.

visibilitychange ^notification

Signals a visibility change of the browser.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.hidden	boolean	mandatory	Hidden (true) or Visible (false)

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "visibilitychange",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.visibilitychange",
  "params": {
    "hidden": false
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.visibilitychange.

pageclosure ^notification

Notifies that the web page requests to close its window.

Notification Parameters

This notification carries no parameters.

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "pageclosure",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.pageclosure"
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.pageclosure.

bridgequery ^notification

A Base64 encoded JSON message from legacy $badger bridge.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.message	string	mandatory	Requested action

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "bridgequery",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.bridgequery",
  "params": {
    "message": "..."
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.bridgequery.

cookiejarchanged ^notification

Notifies that cookies were added, removed or modified.

Notification Parameters

This notification carries no parameters.

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "WebKitBrowser.1.register",
  "params": {
    "event": "cookiejarchanged",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.cookiejarchanged"
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.cookiejarchanged.

WebKit Browser Plugin

Table of Contents

Introduction

Scope

Case Sensitivity

Acronyms, Abbreviations and Terms

References

Description

Configuration

Interfaces

Methods

collectgarbage method

Parameters

Result

Example

Request

Response

delete method

Parameters

Result

Errors

Example

Request

Response

runjavascript method

Parameters

Result

Example

Request

Response

adduserscript method

Parameters

Result

Example

Request

Response

removealluserscripts method

Parameters

Result

Example

Request

Response

Properties

url property

Value

Example

Get Request

Get Response

Set Request

Set Response

visibility property

Value

Example

Get Request

Get Response

Set Request

Set Response

fps property

Value

Example

Get Request

Get Response

headers property

Value

Example

Get Request

Get Response

Set Request

Set Response

useragent property

Value

Example

Get Request

Get Response

Set Request

Set Response

localstorageenabled property

Value

Example

Get Request

collectgarbage ^method

delete ^method

runjavascript ^method

adduserscript ^method

removealluserscripts ^method

url ^property

visibility ^property

fps ^property

headers ^property

useragent ^property

localstorageenabled ^property

httpcookieacceptpolicy ^property

bridgereply ^property

bridgeevent ^property

languages ^property

userScripts ^property

userStyleSheets ^property

securityprofile ^property

mixedcontentpolicy ^property

cookiejar ^property

loadfinished ^notification

loadfailed ^notification