Skip to content

BrowserCookieJar API

Version: 1.0.0

Status: ⚫⚪⚪

BrowserCookieJar interface for Thunder framework.

(Defined with IBrowserCookieJar in IBrowser.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the BrowserCookieJar 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

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

BrowserCookieJar interface properties:

Property R/W Description
cookiejar read/write Get/Set CookieJar config details

cookiejar property

Provides access to the get/Set CookieJar config details.

Value

Name Type M/O Description
(property) object mandatory Get/Set CookieJar config details
(property).version integer mandatory Version of payload format
(property).checksum integer mandatory The checksum of the string used for payload creation
(property).payload string mandatory Base64 string representation of compressed and encrypted cookies
Name Type M/O Description
(property) object mandatory Config info CookieJar
(property).version integer mandatory Version of payload format
(property).checksum integer mandatory The checksum of the string used for payload creation
(property).payload string mandatory Base64 string representation of compressed and encrypted cookies

Example

Get Request

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

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "version": 0,
    "checksum": 0,
    "payload": "..."
  }
}

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.cookiejar",
  "params": {
    "version": 0,
    "checksum": 0,
    "payload": "..."
  }
}

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

BrowserCookieJar interface events:

Notification Description
cookiejarchanged Notifies that cookies were added, removed or modified

cookiejarchanged notification

Notifies that cookies were added, removed or modified.

Notification Parameters

This notification carries no parameters.

Example

Registration

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

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.cookiejarchanged"
}

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