Verona Inferfaces Specification "Widget" 1.0.1 documentation

Verona Inferfaces Specification "Widget" 1.0.1

This is one part of the TBA Plugin Standards.

Operations

SEND vowReadyNotification
Ready Notification
The widget announces that it's code is loaded and initialized so the communication can start.

Operation IDvowReadyNotification
Accepts the following message:
object
metadata
required
string
Via this property, the widget sends the stringified metadata object definied as json-ld in the header of the html file. See here for more information.

Additional properties are NOT allowed.
Examples
{ "metadata": "string" }

This example has been generated automatically.
RECEIVE vowStartCommand
Start Command
The application sends execution parameters.

Operation IDvowStartCommand
Accepts the following message:
application/json
object
sessionId
required
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.

array<object>
This object structure is used to modify the behavior and/or design of the widget at its start.

object
key
required
string
>= 2 characters
Identifier to find or set the parameter.

value
required
string
Value of the parameter.

Additional properties are allowed.
array<object>
This object structure is used to share data between instances of the module. The host may collect all shared data sent by modules and provide it to every module.

object
key
required
string
>= 2 characters
Identifier to find or set the parameter.

value
required
string
Value of the parameter.

Additional properties are allowed.
state
string
format: byte
Additional properties are NOT allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "parameters": [ { "key": "CODE_MODE", "value": "INSTRUCTIONS_ONLY" } ], "sharedParameters": [ { "key": "CODE_MODE", "value": "INSTRUCTIONS_ONLY" } ], "state": "string" }

This example has been generated automatically.
SEND vowStateChangedNotification
State Changed Notification
The widget sends state data.

Operation IDvowStateChangedNotification
Accepts the following message:
application/json
object
sessionId
required
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.

timeStamp
required
string
format: date-time
Ensures, that later arriving states are ignored.

array<object>
This object structure is used to share data between instances of the module. The host may collect all shared data sent by modules and provide it to every module.

object
key
required
string
>= 2 characters
Identifier to find or set the parameter.

value
required
string
Value of the parameter.

Additional properties are allowed.
state
string
format: byte
Additional properties are NOT allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "timeStamp": "2019-08-24T14:15:22Z", "sharedParameters": [ { "key": "CODE_MODE", "value": "INSTRUCTIONS_ONLY" } ], "state": "string" }

This example has been generated automatically.
SEND vowReturnRequested
Close Requested
The widget calls for closing the widget dialog.

Operation IDvowReturnRequested
Accepts the following message:
application/json
object
sessionId
required
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.

timeStamp
required
string
format: date-time
Ensures, that later arriving states are ignored.

array<object>
object
key
required
string
>= 2 characters
Identifier to find or set the parameter.

value
required
string
Value of the parameter.

Additional properties are allowed.
state
string
format: byte
saveState
boolean
If true, the host is requested to send the final state to the player. If false, no vopWidgetReturn message will be sent to the player.

Default value:true
Additional properties are NOT allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "timeStamp": "2019-08-24T14:15:22Z", "sharedParameters": [ { "key": "CODE_MODE", "value": "INSTRUCTIONS_ONLY" } ], "state": "string", "saveState": true }

This example has been generated automatically.

Schemas

SessionIdString
string
The session id flags all communication. If a message has no or empty session id, it's not processed. The session id is unique and was generated by the application. Any simple algorithm would work. The session id helps to link the correct unit with the data of the message. Using the id of the editor hosting html element is less reliable, because the element could be reused with another unit.
object
key
required
string
>= 2 characters
Identifier to find or set the parameter.

value
required
string
Value of the parameter.

Additional properties are allowed.

Verona Inferfaces Specification "Widget" 1.0.1

Operations

SEND vowReadyNotification

Examples

This example has been generated automatically.

RECEIVE vowStartCommand

Examples

This example has been generated automatically.

SEND vowStateChangedNotification

Examples

This example has been generated automatically.

SEND vowReturnRequested

Examples

This example has been generated automatically.

Schemas