UI (user notification)
Role
Use this method to send a notification to the user through the service.
Prototype
URL : /service/ui
Method : POST
URL Params : None
Request data :
Field name | Type | Status | Description |
---|---|---|---|
Text |
string | required | The text of the message |
Icon |
string | option | The icon of the notification window, eithernone : no iconinfo : information signwarning : warning signerror : error sign |
Title |
string | option | The title of the message. If absent or null , defaults to “SpringCard Companion”. |
Time |
integer | option | The duration of the message, in seconds. If absent or 0 , defaults to 5s. |
Success Response
Code : 200 OK
Content : a SUCCESS object.
Error Response
See Error Responses.
Example
{
"Text": "Hello, world",
"Icon": "info",
"Title": "A message from Companion's client"
}