TBA Plugin Specification "Editor" 5.0.0 documentation

TBA Plugin Specification "Editor" 5.0.0

This is one part of the TBA Plugin Standards.

Operations

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

Operation IDvoeReadyNotification
Accepts the following message:
object
metadata
required
string
Via this property, the editor sends the stringified metadata object defined 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 voeStartCommand
Start Command
The application sends parameters for editing the unit and commands the start of user interaction.

Operation IDvoeStartCommand
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.

unitDefinition
string
format: byte
The definition of the unit (if given) to be edited.

unitDefinitionType
string
This lets the editor the unit definition format know. This might avoid UI mess after getting old definitions.

object
directDownloadUrl
string
After starting the editor and loading the unit definition, it might be necessary to load additional code or data from the server. This data is identified by an resource ID (usually a file name). The editor can download this resource by itself without further interaction with the host frontend. The property directDownloadUrl provides the url for download. The editor extends this url by an url separator '/' and the resource ID (uri-encoded if needed).

role
string
Specifies the access level of the editing person ('super' = maximal)

Allowed values:
"GUEST"
"COMMENTATOR"
"DEVELOPER"
"MAINTAINER"
"SUPER"
array<object>
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.

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

value
string
Value of the parameter.

Additional properties are allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "unitDefinition": "iqb-scripted::1.4.0\ntitle::Testscript Title2??Hilfetext2\nmultiple-choice::mc_var1::1::Multiple Choice Feld: ::Choice1##Choice2##Choice3??Hilfetext1\ndrop-down::dd_var1::1::Dropdown Feld: ::Choice1##Choice2##Choice3??Hilfetext1\ncheckbox::check_var1::0::Ja klick mal!\nif-start::dd_var1::1\n input-text::java::sap oxa\nif-else\n input-text::java_22::sap oxa U\n text::NOT Choice1\nif-end\n", "unitDefinitionType": "iqb-scripted@1.4.0", "editorConfig": { "directDownloadUrl": "https://www.iqb-studio.de/download/iskeid-34e845-didmmemdkek", "role": "GUEST", "sharedParameters": [ { "key": "KEYBOARD_USE", "value": "INTERNAL_ONLY" } ] } }

This example has been generated automatically.
SEND voeDefinitionChangedNotification
Definition Changed Notification
The definition of the unit has changed.

Operation IDvoeDefinitionChangedNotification
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.

unitDefinition
string
format: byte
To be stored.

unitDefinitionType
string
In order to understand the definition outside the editor, the type of the definition should be known. This helps to select a suitable player to run the unit.

array<object [Infos of a base variable to support link to item and coding]>
Variable data help to prepare the processing of answers (coding scheme).

object [Infos of a base variable to support link to item and coding]
uid: verona-variable-info@2.1
id
required
string
must match: ^[0-9A-Za-z_-]+$non-empty
Identifier for the variable

alias
string
must match: ^[0-9A-Za-z_-]+$non-empty
Alternative identifier for the variable

type
required
string
Data type of the variable value

Allowed values:
"STRING"
"INTEGER"
"NUMBER"
"BOOLEAN"
"ATTACHMENT"
"JSON"
"NO_VALUE"
"CODED"
format
string
Data type format

Allowed values:
"TEXT_SELECTION"
"IMAGE"
"CAPTURE_IMAGE"
"AUDIO"
"GGB_FILE"
"NON_NEGATIVE"
"LATEX"
"MATH_ML"
"MATH_TABLE"
"MATH_TEXT_MIX"
"GGB_VARIABLE"
"CHEM_ELEMENT_SYMBOLS"
"CHEM_MOLECULE"
""
multiple
boolean
Can the value be of type Array?

Default value:false
nullable
boolean
Can the value be null?

Default value:false
array<object>
List of possible values

object
value
required
string | number | boolean
label
string
Additional properties are NOT allowed.
array<string>
Labels of the positions if the value is of type array

Items:
string
valuesComplete
boolean
Are the given values all possible values?

Default value:false
Additional properties are NOT allowed.
array<object>
Files to provide or services to keep accessible during the presentation of the unit.

object
id
required
string
type
required
string
Allowed values:
"FILE"
"STREAM"
"STREAM_TO_UNPACK"
"FILE_TO_UNPACK"
"WIDGET"
Additional properties are NOT allowed.
array<object>
Files to provide or services to keep accessible to enable the editing of the unit.

object
id
required
string
type
required
string
Allowed values:
"FILE"
"STREAM"
"STREAM_TO_UNPACK"
"FILE_TO_UNPACK"
"WIDGET"
Additional properties are NOT allowed.
array<object>
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.

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

value
string
Value of the parameter.

Additional properties are allowed.
Additional properties are NOT allowed.
Examples
{ "sessionId": "idk8ur5jf9ru5jk", "timeStamp": "2019-08-24T14:15:22Z", "unitDefinition": "string", "unitDefinitionType": "iqb-scripted@1.4.0", "variables": [ { "id": "string", "alias": "string", "type": "STRING", "format": "TEXT_SELECTION", "multiple": false, "nullable": false, "values": [ { "value": "string", "label": "string" } ], "valuePositionLabels": [ "string" ], "valuesComplete": false } ], "dependenciesToPlay": [ { "id": "GeoGebra.itcr.zip", "type": "FILE" } ], "dependenciesToEdit": [ { "id": "GeoGebra.itcr.zip", "type": "FILE" } ], "sharedParameters": [ { "key": "KEYBOARD_USE", "value": "INTERNAL_ONLY" } ] }

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
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.

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

value
string
Value of the parameter.

Additional properties are allowed.
object
directDownloadUrl
string
After starting the editor and loading the unit definition, it might be necessary to load additional code or data from the server. This data is identified by an resource ID (usually a file name). The editor can download this resource by itself without further interaction with the host frontend. The property directDownloadUrl provides the url for download. The editor extends this url by an url separator '/' and the resource ID (uri-encoded if needed).

role
string
Specifies the access level of the editing person ('super' = maximal)

Allowed values:
"GUEST"
"COMMENTATOR"
"DEVELOPER"
"MAINTAINER"
"SUPER"
array<object>
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.

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

value
string
Value of the parameter.

Additional properties are allowed.
Additional properties are NOT allowed.
object
id
required
string
type
required
string
Allowed values:
"FILE"
"STREAM"
"STREAM_TO_UNPACK"
"FILE_TO_UNPACK"
"WIDGET"
Additional properties are NOT allowed.
object [Infos of a base variable to support link to item and coding]
uid: verona-variable-info@2.1
id
required
string
must match: ^[0-9A-Za-z_-]+$non-empty
Identifier for the variable

alias
string
must match: ^[0-9A-Za-z_-]+$non-empty
Alternative identifier for the variable

type
required
string
Data type of the variable value

Allowed values:
"STRING"
"INTEGER"
"NUMBER"
"BOOLEAN"
"ATTACHMENT"
"JSON"
"NO_VALUE"
"CODED"
format
string
Data type format

Allowed values:
"TEXT_SELECTION"
"IMAGE"
"CAPTURE_IMAGE"
"AUDIO"
"GGB_FILE"
"NON_NEGATIVE"
"LATEX"
"MATH_ML"
"MATH_TABLE"
"MATH_TEXT_MIX"
"GGB_VARIABLE"
"CHEM_ELEMENT_SYMBOLS"
"CHEM_MOLECULE"
""
multiple
boolean
Can the value be of type Array?

Default value:false
nullable
boolean
Can the value be null?

Default value:false
array<object>
List of possible values

object
value
required
string | number | boolean
label
string
Additional properties are NOT allowed.
array<string>
Labels of the positions if the value is of type array

Items:
string
valuesComplete
boolean
Are the given values all possible values?

Default value:false
Additional properties are NOT allowed.

TBA Plugin Specification "Editor" 5.0.0

Operations

SEND voeReadyNotification

Examples

This example has been generated automatically.

RECEIVE voeStartCommand

Examples

This example has been generated automatically.

SEND voeDefinitionChangedNotification

Examples

This example has been generated automatically.

Schemas