Skip to content

Store2 API

Version: 1.0.0

Status: ⚫⚪⚪

Store2 interface for Thunder framework.

(Defined with IStore2 in IStore2.h)

Table of Contents

Introduction

Scope

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

Store2 JSON-RPC interface.

Methods

The following methods are provided by the Store2 interface:

Built-in methods:

Method Description
exists Checks if a JSON-RPC method or property exists
register Registers for an asynchronous JSON-RPC notification
unregister Unregisters from an asynchronous JSON-RPC notification

Store2 interface methods:

Method Description
setValue / setValue
getValue / getValue
deleteKey / deleteKey
deleteNamespace / deleteNamespace

exists method

Checks if a JSON-RPC method or property exists.

Description

This method will return True for the following methods/properties: exists, register, unregister, setValue, getValue, deleteKey, deleteNamespace.

Parameters

Name Type M/O Description
params object mandatory ...
params.method string mandatory Name of the method or property to look up

Result

Name Type M/O Description
result boolean mandatory Denotes if the method exists or not

Example

Request

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

Response

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

register method

Registers for an asynchronous JSON-RPC notification.

Description

This method supports the following event names: valueChanged.

Parameters

Name Type M/O Description
params object mandatory ...
params.event string mandatory Name of the notification to register for
params.id string mandatory Client identifier

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_FAILED_REGISTERED Failed to register for the notification (e.g. already registered)

Example

Request

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

Response

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

unregister method

Unregisters from an asynchronous JSON-RPC notification.

Description

This method supports the following event names: valueChanged.

Parameters

Name Type M/O Description
params object mandatory ...
params.event string mandatory Name of the notification to register for
params.id string mandatory Client identifier

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_FAILED_UNREGISTERED Failed to unregister from the notification (e.g. not yet registered)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.unregister",
  "params": {
    "event": "eventName",
    "id": "myapp"
  }
}

Response

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

setValue method

setValue is an alternative name for this method.

Parameters

Name Type M/O Description
params object mandatory ...
params.scope string mandatory ... (must be one of the following: account, device)
params.namespace string mandatory ...
params.key string mandatory ...
params.value string mandatory ...
params.ttl integer mandatory ...

Result

Name Type M/O Description
result null mandatory Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.setValue",
  "params": {
    "scope": "account",
    "namespace": "...",
    "key": "...",
    "value": "...",
    "ttl": 0
  }
}

Response

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

getValue method

getValue is an alternative name for this method.

Parameters

Name Type M/O Description
params object mandatory ...
params.scope string mandatory ... (must be one of the following: account, device)
params.namespace string mandatory ...
params.key string mandatory ...

Result

Name Type M/O Description
result object mandatory ...
result.value string mandatory ...
result.ttl integer mandatory ...

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.getValue",
  "params": {
    "scope": "account",
    "namespace": "...",
    "key": "..."
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "value": "...",
    "ttl": 0
  }
}

deleteKey method

deleteKey is an alternative name for this method.

Parameters

Name Type M/O Description
params object mandatory ...
params.scope string mandatory ... (must be one of the following: account, device)
params.namespace string mandatory ...
params.key string mandatory ...

Result

Name Type M/O Description
result null mandatory Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.deleteKey",
  "params": {
    "scope": "account",
    "namespace": "...",
    "key": "..."
  }
}

Response

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

deleteNamespace method

deleteNamespace is an alternative name for this method.

Parameters

Name Type M/O Description
params object mandatory ...
params.scope string mandatory ... (must be one of the following: account, device)
params.namespace string mandatory ...

Result

Name Type M/O Description
result null mandatory Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.deleteNamespace",
  "params": {
    "scope": "account",
    "namespace": "..."
  }
}

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

Store2 interface events:

Notification Description
valueChanged / onValueChanged

valueChanged notification

onValueChanged is an alternative name for this notification.

Notification Parameters

Name Type M/O Description
params object mandatory ...
params.scope string mandatory ... (must be one of the following: account, device)
params.namespace string mandatory ...
params.key string mandatory ...
params.value string mandatory ...

Example

Registration

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

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.valueChanged",
  "params": {
    "scope": "account",
    "namespace": "...",
    "key": "...",
    "value": "..."
  }
}

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