Skip to content

BrowserResources API

Version: 1.0.0

Status: ⚫⚪⚪

BrowserResources interface for Thunder framework.

(Defined with IBrowserResources in IBrowser.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the BrowserResources interface (version 1.0.0). It includes detailed specification about its 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

BrowserResources JSON-RPC interface.

Properties

The following properties are provided by the BrowserResources interface:

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

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

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.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": "<callsign>.1.userStyleSheets"
}

Get Response

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

Set Request

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

Set Response

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