Notifications¶
Outgoing Messages¶
SetIndicator¶
Notifies the platform implementation of whether a notification indicator should be rendered.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Notifications",
"action": "SetIndicator"
}
},
"payload": {
"state": {{IndicatorState}}
}
}
Payload¶
Property | Type | Required | Description | Example |
---|---|---|---|---|
state | IndicatorState | Yes | The new notification indicator state. |
OnNotificationReceived¶
Notifies the platform implementation of notification received.
JSON Structure¶
{
"header": {
"version": "4.0",
"messageType": "Publish",
"id": {{String}},
"messageDescription": {
"topic": "Notifications",
"action": "OnNotificationReceived"
}
}
}
Enums¶
IndicatorState¶
Values¶
Value | Description |
---|---|
"OFF" | The notification indicator should be turned off. |
"ON" | The notification indicator should be turned on. |
"UNKNOWN" | The notification indicator state is unknown. |