Skip to content

ScriptEngine API

Version: 1.0.0

Status: ⚫⚪⚪

ScriptEngine interface for Thunder framework.

(Defined with IScriptEngine in IScriptEngine.h)

Table of Contents

Introduction

Scope

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

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

ScriptEngine JSON-RPC interface.

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

Properties

The following properties are provided by the ScriptEngine interface:

ScriptEngine interface properties:

Property R/W Description
url read/write Script to be loaded into the engine and to be executed

url property

Provides access to the script to be loaded into the engine and to be executed.

Value

Name Type M/O Description
(property) object mandatory Script to be loaded into the engine and to be executed
(property).value string mandatory ...
Name Type M/O Description
(property) string mandatory Loaded URL

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.url"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.url",
  "params": {
    "value": "..."
  }
}

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

ScriptEngine interface events:

Notification Description
urlchanged Signal changes on the subscribed namespace

urlchanged notification

Signal changes on the subscribed namespace..

Notification Parameters

Name Type M/O Description
params object mandatory ...
params.url string mandatory Loaded URL

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.register",
  "params": {
    "event": "urlchanged",
    "id": "myid"
  }
}

Notification

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

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