Skip to content

WebBrowserExt API

Version: 1.0.0

Status: ⚫⚪⚪

WebBrowserExt interface for Thunder framework.

(Defined with IWebBrowserExt in IBrowser.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the WebBrowserExt interface (version 1.0.0). It includes detailed specification about its methods and properties provided.

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

WebBrowserExt JSON-RPC interface.

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 WebBrowserExt interface:

WebBrowserExt interface methods:

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

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": "<callsign>.1.delete",
  "params": {
    "path": ".cache/wpe/disk-cache"
  }
}

Response

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

Properties

The following properties are provided by the WebBrowserExt interface:

WebBrowserExt interface properties:

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

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": "<callsign>.1.languages"
}

Get Response

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

Set Request

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

Set Response

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