Development Guide
System Messages¶
Lead
Description of system messages in Convergence Framework
Contents
All system messages are in JSON format.
TV Application System Messages¶
Quit TV Application¶
The Quit TV predefined message format is:
{
"SystemCommand": {
"Type": "QuitTVApp",
"AppID": "SampleWidget"
}
}
This message can be generated in this situations:
- Client pushes the predefined message to the TV application using the URI /ws/app/{appID}/queue.
TV application should quit execution when receives this message.
Client Application System Messages¶
Application Exit Notification¶
The TV application information is usually client driven. When the TV application quits, the system generates a broadcast message to notify all the connected clients that the application running status is changed to “TERMINATED”. For example:
{
"widgetInfo": {
"ID": "Canvas_NewOCI",
"Version": "0.930",
"Status": "TERMINATED",
"widgetname": "sampleWidget"
}
}
On receiving the above message, the client should stops communication with the TV and the long polling process.
Disconnect Client¶
The Disconnect client predefined message is:
{
"SystemCommand": {
"Type": "DisconnectClient",
"AppID": "SampleWidget"
}
}
On receiving the above message, the client should stops communication with the TV and the long polling process.
