Skip to content

BrowserScripting API

Version: 1.0.0

Status: ⚫⚪⚪

BrowserScripting interface for Thunder framework.

(Defined with IBrowserScripting in IBrowser.h)

Table of Contents

Introduction

Scope

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

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

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

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

Response

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