Application API

Version: 1.0.0

Status:

Application interface for Thunder framework.

(Defined with IApplication in IApplication.h)

Table of Contents

• Introduction
• Description
• Methods
• Properties
• Notifications

Introduction

Scope

This document describes purpose and functionality of the Application interface (version 1.0.0). It includes detailed specification about its methods and properties as well as sent notifications.

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

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

Application interface methods:

Method	Description
reset	Resets application data

reset ^method

Resets application data.

Parameters

Name	Type	M/O	Description
params	string	mandatory	Type of reset to perform (must be one of the following: Cache, Credentials, Factory, Recordings)

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Example

Request

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

Response

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

Properties

The following properties are provided by the Application interface:

Application interface properties:

Property	R/W	Description
identifier	read-only	Application-specific identification string
contentlink	write-only	URI of the associated application-specific content
launchpoint	read/write	Application launching point
visible	read/write	Current application visibility
language	read/write	Current application user interface language

identifier ^property

Provides access to the application-specific identification string.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Identifier string

Example

Get Request

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

Get Response

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

contentlink ^property

Provides access to the URI of the associated application-specific content.

This property is write-only.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Content URI

Example

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.contentlink",
  "params": "https://youtube.com"
}

Set Response

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

launchpoint ^property

Provides access to the application launching point.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Application launching point (must be one of the following: ApplicationList, ApplicationPromotion, BannerAd, ChannelBar, ChannelNumber, ChannelZap, DedicatedButton, DedicatedIcon, Dial, EpgGrid, IntegratedTile, PowerOn, PowerOnFromDedicatedButton, Restart, ResumedFromScreenSaver, ResumedFromStandby, SearchContinuation, SearchResult, SuspendedPowerOn, SuspendedRestart, TitleRecommendation, TouchGesture, Undefined, VisualGesture, VoiceControl, VoiceSearchResult, WebBrowser)

Example

Get Request

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

Get Response

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

Set Request

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

Set Response

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

visible ^property

Provides access to the current application visibility.

Value

Name	Type	M/O	Description
(property)	boolean	mandatory	Current application visibility

Example

Get Request

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

Get Response

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

Set Request

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

Set Response

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

language ^property

Provides access to the current application user interface language.

Value

Name	Type	M/O	Description
(property)	string	mandatory	Language string as per RFC5646

Example

Get Request

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

Get Response

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

Set Request

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

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

Application interface events:

Notification	Description
visibilitychange	Application visibility changes

visibilitychange ^notification

Application visibility changes.

Notification Parameters

Name	Type	M/O	Description
params	boolean	mandatory	Denotes if application is currently hidden

Example

Registration

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

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.visibilitychange",
  "params": false
}

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