com.webos.notification

API Summary

Manages the system notifications.

Overview of the API

Enables apps or services to manage system notifications. The main types of notifications supported are:

  • Toast: This is an info alert that displays the message and title. It gets dismissed automatically after a few seconds. When creating the toast, it can be decided if it must be persisted in the Notification Center App.
  • Alert: This is a dialog message with at least one action button. It can be a modal or non-modal alert. For a modal alert, all interaction with the UI will be blocked until the alert is dismissed.

Methods

createAlert

Description

Creates a system alert notification.

Parameters

Name

Required

Type

Description

iconUrlOptionalString

The file path of the alert icon. The file path must be local to the device.

titleOptionalString

A brief title for the alert notification. 

messageRequiredString

A detailed message for the alert notification.

modalOptionalBoolean

Indicates whether to display a modal or non-modal alert notification. Possible values are:

  • true: Display a modal alert notification
  • false: Display a non-modal alert notification

Note: The default value is false.

buttonsRequiredObject array: button

Defines the button label, and onclick action. Button specification is given in an array. An example is:

"buttons":[
        {"label":"button1", "onclick":"luna://com.webos.service.applicationmanager/launch", "params":{"id":"com.webos.app.settings"}},
        {"label":"button2", "focus":true},
        {"label":"button3"}
]

oncloseOptionalObject: onclose

Defines the close action to be performed when an alert is closed.

typeOptionalString

Defines the button type in the alert. Possible values are: 

  • confirm
  • warning
isSysReqOptionalBoolean

Indicates whether the notification has come from an app or system

  • true : notification comes from system
  • false : notification comes from an app
onfailOptionalObject: onfail

Action to be performed on failure to create an alert.

Call Returns

Name

Required

Type

Description

alertIdOptionalString

The ID of the created alert notification. This would be sourceId + "-" + Timestamp.

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorText" field for details.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneUnknown Source

This message implies that the system was unable to retrieve the app's sourceId from the system bus message.

NonePermission Denied

This message implies that the app does not have permission to create system alerts.

NoneMessage is not parsed

This message implies that a JSON message parsing error occured. One of the following situations can cause the parsing error:

  • The Request object was not formatted correctly.
  • One ore more of the required fields are missing.
  • One or more of the values provided were not the expected data type, for example a string was expected, however the app passed a number instead.
NoneMessage can't be empty

This message implies that the field message in the request message is empty.

NoneInvalid Service Uri in the onclick

This message implies that the service URI given in the onclick object is invalid.

Example

# luna-send -n 1 -f -a com.webos.surfacemanager luna://com.webos.notification/createAlert '{
   "message":"hello world",
   "buttons":[
      {
         "label":"launch",
         "params":{
            "id":"youtube.leanback.v4"
         }
      }
   ]
}'

Response:

{
   "alertId":"com.webos.surfacemanager-1582247038454",
   "returnValue":true
}

getAlertNotification

Description

Subscribe to create alert notifications.

Note: This method should only be used by the Surface Manager.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribed for notifications.
  • false: Not subscribed

Default: false

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.

Note: This method always returns returnValue as true.

subscribedOptionalBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribed for notifications.
  • false: Not subscribed

Note: No explicit error message will be sent out when the subscription fails because this method is intended for one specific client that is the Surface Manager.

Subscription Returns

Name

Required

Type

Description

alertInfoRequiredObject: alertInfo

Contains alert info.

timestampRequiredString

Indicates the timestamp string.

Note: It indicates epoch time as milliseconds.

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.

Note: This method always returns returnValue as true.

alertActionRequiredString

Indicates the action that the subscriber should take.

Possible alert types are:

  • open: Indicates that the SystemUI should show the alert.
  • close: Indicates that the SystemUI should close the currently open alert. 
onFailActionOptionalObject: onFailAction

Indicates the action to be performed on failure to create an alert.

Example

# luna-send -i -f -a com.webos.surfacemanager luna://com.webos.notification/getAlertNotification '{"subscribe":true}'

Response:

{
   "subscribed": true,
   "returnValue": true
}

Subscription Response:

{
    "alertInfo": {
        "alertId": "com.webos.surfacemanager-1583462810158",
        "message": "Hello World",
        "sourceId": "com.webos.surfacemanager",
        "isNotiSave": false,
        "buttons": [
            {
                "focus": false,
                "action": {
                },
                "label": "Yes"
            },
            {
                "focus": false,
                "label": "No"
            }
        ],
        "modal": false,
        "onFailAction": {
        },
        "isSysReq": false,
        "onCloseAction": {
        }
    },
    "timestamp": "1583462810158",
    "returnValue": true,
    "alertAction": "open"
}

closeAlert

Description

Closes the currently displayed alert notification.

Parameters

Name

Required

Type

Description

alertIdRequiredString

The ID of the alert notification to close.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorText" field for details.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneMessage is not parsed

 This message implies that a JSON message parsing error occured. One of the following situations can cause the parsing error:

  • The Request object was not formatted correctly.
  • One or more of the required fields are missing.
  • One or more of the values provided were not the expected data type, for example a string was expected, however the app passed a number instead.
NoneAlert ID can't be empty

This message implies that the alertId field in the message is empty or missing.

NoneAlert ID parse error

       This message implies that the alertId is not formatted properly.

Example

# luna-send -n 1 -f -a com.webos.surfacemanager luna://com.webos.notification/closeAlert '{"alertId":"com.webos.surfacemanager-1582876366095"}'

Response:

{
    "returnValue": true
}

closeAllAlerts

Description

Closes all the open alerts.

Note: This method is only used by com.webos.service.battest during BAT test. If the caller is not com.webos.service.battest, the method will fail.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorText" field for details.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the Error Codes Reference of this method for more details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneUnknown Source

This message implies that the system was unable to retrieve the app source ID from the system bus message.

NoneMessage is not parsed

This message implies that a JSON message parsing error occured. One of the following situations can cause the parsing error:

  • The Request object was not formatted correctly.
  • One ore more of the required fields are missing.
  • One or more of the values provided were not the expected data type, for example a string was expected, however the app passed a number instead.
NoneInvalid source ID specified

If call is not from com.webos.service.battest, notification refuses API request with this error.

Example

Example for a successful call:

# luna-send -n 1 -f -a com.webos.service.battest luna://com.webos.notification/closeAllAlerts '{}'

 

Response:


  "returnValue":true
}

 

Example for a failed call:

# luna-send -n 1 -f luna://com.webos.notification/closeAllAlerts '{}'

 

Response:


  "returnValue":false,
  "errorText":"Unknown Source"
}

removeAllNotification

Description

Removes all notifications that are currently being displayed.

Parameters

Name

Required

Type

Description

displayIdOptionalNumber

Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed. Check the "errorText" field for details.
removeAllNotiIdRequiredBoolean

Indicates whether all notifications were removed successfully.

Possible values are: 

  • true: Notifications were removed successfully.
  • false: Notification removal failed.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

displayIdRequiredNumber

Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Error Codes Reference

Error Code

Error Text

Error Description

NonePermission Denied

This error message implies that calling App or source is not previleged source for this method. Only SystemUI component is allowed to call this method.

Example

# luna-send -a com.webos.surfacemanager -n 1 luna://com.webos.notification/removeAllNotification '{"displayId": 0}'

Response:

{
    "removeAllNotiId":true,
    "returnValue":true
}

createToast

Description

Creates a toast notification.

Parameters

Name

Required

Type

Description

sourceIdOptionalString

The ID of the application or service that creates the toast notification.

iconUrlOptionalString

The file path of the alert icon. The file path must be local to the device.

NOTE​: The icon must be 80 x 80 and in the PNG format.

messageRequiredString

The detailed message to be displayed as part of the toast notification. The message can be up to 60 characters long.

onclickOptionalObject: onclick

Defines the toast action. An example is: 

{"appId":"com.webos.app.test"}

noactionOptionalBoolean

Indicates no action is required. Possible values are:

  • true: If no action is required
  • false: If action is defined.

Note: The default value is false.

staleOptionalBoolean

Possible values are:

  • true: To indicate the toast notification is old and does not need to be displayed.
  • false: If the toast notification is current and should be displayed.

Note: The default value is false.

persistentOptionalBoolean

Indicates whether the toast message should be saved in the database. If persistent is set to true, the toast message will be saved in the database.

isSysReqOptionalBoolean

Defines notification comes from app or system

  • true : notification comes from system
  • false : notification comes from app
scheduleOptionalObject: schedule

Creates a toast notification as a persistent message and defines its schedule.

typeOptionalString

Defines the toast type.

extraOptionalObject array: image

Defines extra toast resource.

onlyToastOptionalBoolean

Indicates if notification to be created is just a simple toast.

Possible values are:

  • true: Shows simple information
  • false: Calls createNotification API and notiInfo is added in notification list

Default: true

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.
toastIdOptionalString

The id of the created toast notification. This would be sourceId + "-" + Timestamp.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneUnknown Source

Indicates that the system was unable to retrieve the app source id from the System Bus message.

NoneMessage is not parsed

Indicates that the JSON message parsing error occured.

Possible situations that can cause the parsing error:

  • Request object was not formatted correctly.
  • One ore more of the required fields are missing.
  • One or more of the values provided were not the expected data type, for example a string was expected, however the app passed a number instead.
NoneInvalid id specified

Indicates that the app is missing from the requested message.

NoneInvalid source id specified

Indicates that the app Id given in the requested message does not match with the system bus caller Id.

NoneMessage can't be empty

Indicates that the message​ field in the requested message is empty.

Example

# luna-send -n 1 -f -a com.webos.app.test luna://com.webos.notification/createToast '{
      "sourceId":"com.webos.app.test",
      "onclick": {"appId":"com.webos.app.test"},
      "message":"hello world",
      "noaction": false,
      "persistent":true
}'

Response:

{
    "toastId": "com.webos.app.test-1435192659892",
    "returnValue": true
}

getToastNotification

Description

​​Subscribe to created toast notification. 

Note: This method should only be used by Surface Manager only.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribe for notifications
  • false: Not subscribed

Default: false

Call Returns

Name

Required

Type

Description

subscribedOptionalBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribe for notifications
  • false: Not subscribed

Note: No explicit error message will be sent out when subscription fails because this method is intended for one speicific client that is the Surface Manager.

returnValueRequiredBoolean

Indicates the status of the operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.

Note: This method always returns returnValue as true.

Subscription Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of the operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.

Note: This method always returns returnValue as true.

messageRequiredString

Contains the message to be displayed.

typeOptionalString

Indicates the type of the toast message.

Note: This is optional parameter and currently not used. This is reserved for future purpose.

titleOptionalString

Contains the title information to be displayed for the toast.

isCradleReqOptionalBoolean

Indicates if this is a Cradle Request or not. Cradle Request is used for Battery Notifications only. So, it will be set to false for all other cases.

Note:

  • A Cradle is used for charging the watch wirelessly. When a watch is put on an inductive charger, it sends a notification indicating the current battery level.
  • A Cradle Request is used for showing that notification.
sourceIdRequiredString

Contains the source Id of the requester. 

timestampRequiredString

Indicates the time stamp string. It indicates epoch time as milliseconds.

isSysReqRequiredBoolean

Indicates if the notification comes from an app or system.

Possible values are:

  • true: Notification comes from system.
  • false: Notification comes from app.
iconUrlRequiredString

Contains the file path to icon to be displayed.

actionOptionalObject: action

Contains the action parameter.

scheduleOptionalObject: schedule

Describes the toast schedule.

iconPathRequiredString

Specifies the path of the icon. It should be absolute local file system path.

userOptionalString

Indicates the names of the user logged in to the corresponding session. If the user is logged in as guest user, the value will be "guest".

_kindOptionalString

Displays the db kind in which the toast is stored.

Note: It is an internal parameter.

onlyToastRequiredBoolean

Indicates if notification is created as a simple toast.

Note: It is set when creating the toast.

Example

# luna-send -i -f -a com.webos.surfacemanager luna://com.webos.notification/getToastNotification '{
   "subscribe":true
}'

Response:

{
   "subscribed": true,
   "returnValue": true
}

Subscription Response:

{
    "message": "hello world",
    "iconPath": "/usr/palm/notificationmgr/images/toast-notification-icon.png",
    "type": "standard",
    "returnValue": true,
    "user": "guest",
    "title": "",
    "isCradleReq": false,
    "sourceId": "com.webos.app.notification",
    "timestamp": "1583463281128",
    "onlyToast": true,
    "isSysReq": false,
    "schedule": {
        "expire": 1586055281
    },
    "iconUrl": "file:///usr/palm/notificationmgr/images/toast-notification-icon.png",
    "action": {
        "launchParams": {
            "id": "com.webos.app.notification"
        },
        "serviceMethod": "launch",
        "serviceURI": "luna://com.webos.service.applicationmanager/"
    }
}

getToastList

Description

Lists the toasts created for the app/client based on the user logged into the particular session.

Parameters

Name

Required

Type

Description

displayIdOptionalNumber

Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of the operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.
toastInfoRequiredObject array: toastInfo

Contains information of the stored toasts.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneUnknown Source

Indicates that the system was unable to retrieve the app/service's source id from the system bus message.

NonePermission Denied

Indicates that the app/service does not have permission to query toast list.

NoneMessage is not parsed

Indicates that the required parameters were not passed to API.

NoneCan't get the notification info from db

Failed to fetch the toast list from the database.

Example

# luna-send -n 1 -f -a com.webos.app.notification luna://com.webos.notification/getToastList '{"displayId": 0}'

Response:

{
    "returnValue": true
    "toastInfo" : [
        {
            "sourceId" : "com.webos.app.notification",
            "toastId" : "com.webos.app.notification-1584349101435",
            "timestamp" : "1584349101435",
            "iconUrl" : "file:///usr/palm/notificationmgr/images/toast-notification-icon.png",
            "iconPath" : "/usr/palm/notificationmgr/images/toast-notification-icon.png",
            "title" : "",
            "message" : "hello world",
            "isSysReq" : false,
            "user" : "guest",
            "schedule" : {
                "expire": 1590207128
            },
            "type" : "standard",
            "action" : {
                "launchParams": {
                    "id": "com.webos.app.notification"
                },
                "serviceMethod": "launch",
                "serviceURI": "luna://com.webos.service.applicationmanager/"
            }
            "readStatus" : false
        },
    ],

    "displayId": 0
}

setToastStatus

Description

Specifies whether the toast is to be marked as read or unread.

Parameters

Name

Required

Type

Description

toastIdRequiredString

Indicates the unique ID of the toast created.

readStatusRequiredBoolean

Indicates the status of a toast to be set by the user.

Possible values are: 

  • true: toast is read.
  • false: toast is unread.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of the operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.
toastIdOptionalString

Contains the unique ID of the toast created.

readStatusOptionalBoolean

Indicates the status of a toast set by the user.

Possible values are:

  • true: toast is read.
  • false: toast is unread.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneFailed to set status

Failed to set the read / unread status of the toast.

Example

# luna-send -i -f -a com.webos.app.notification luna://com.webos.notification/setToastStatus '{
   "toastId" : "com.webos.app.notification-1584349101435",
   "readStatus" : true
}'

Response:

{
    "returnValue" : true,
    "toastId" : "com.webos.app.notification-1584349101435",
    "readStatus" : true
}

getToastCount

Description

Queries the toast notification details of the stored messages and provides the read/unread count of the toast notifications.

Note: Only "com.webos.surfacemanager" and "com.webos.app.notification" have permission to monitor the notification status change.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribe for notifications
  • false: Not subscribed
displayIdOptionalNumber

Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.
subscribedRequiredBoolean

Indicates if subscribed to get notifications.

Possible values are:

  • true: Subscribe for notifications
  • false: Not subscribed

Subscription Returns

Name

Required

Type

Description

readCountRequiredNumber

Indicates the count of toast notifications read by a specific user.

unreadCountRequiredNumber

Indicates the count of toast notifications unread by the user.

totalCountRequiredNumber

Indicates the total count of toast notifications respective to a user.

returnValueRequiredBoolean

Indicates the status of operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed.

Example

# luna-send -i -f -a com.webos.app.notification luna://com.webos.notification/getToastCount '{
   "subscribe":true,

   "displayId": 0
}'

Response:

{
    "returnValue" : true,
    "subscribed" : true
}

Subscription response:

{
    "unreadCount": 2,
    "totalCount": 3,
    "readCount": 1,
    "returnValue": true
}

closeToast

Description

Removes a toast notification from the database.

Parameters

Name

Required

Type

Description

toastIdOptionalString

ID of the toast notification to remove from the database. 

Note: Either toastId or sourceId is required.

sourceIdOptionalString

ID of the app/service to remove from the database.

Note: Either toastId or sourceId is required.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of the operation.

Possible values are:

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed. Check the "errorText" field for details.
errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error Codes Reference

Error Code

Error Text

Error Description

NoneToast ID parse error

Indicates that the toastId is not formatted properly. 

NoneBoth Toast ID and Source ID can't be empty

Indicates that neither toastId or sourceId field in the message is empty or missing.

NoneMessage is not parsed

Indicates that a JSON message parsing error occured.

Possible situations that can cause the parsing error:

  • The Request object was not formatted correctly.
  • One or more of the required fields are missing.
  • One or more of the values provided were not the expected data type, for example a string was expected, however the app passed a number instead.

Example

# luna-send -n 1 -f -a com.webos.app.test luna://com.webos.notification/closeToast '{
   "toastId":"com.webos.app.test-1433221930402"
}'

Response:


  "returnValue":true
}

# luna-send -n 1 -f -a com.webos.app.test luna://com.webos.notification/closeToast '{
   "sourceId":"com.webos.app.test"
}'

Response:


  "returnValue":true
}

Objects

schedule

Creates a toast notification as a persistent message and define its schedule.

Name

Required

Type

Description

expireOptionalNumber (int64_t)

If this field is set, the created persistent message will be automatically removed after the specified amount of time has passed.

The value should be the number of seconds that have elapsed since 00:00:00 UTC, 1 Jan 1970.

onclose

Contains close action when alert is closed with close button or automatically

Name

Required

Type

Description

uriOptionalString

Luna API to be called when an alert window is closed.

paramsOptionalObject

Contains parameters to be passed when uri is called.

onclick

Contains action information when a user clicks the toast

Name

Required

Type

Description

appIdOptionalString

Application Id to be launched

paramsOptionalObject

Contains parameters when appId is launched.

button

Contains alert button information

Name

Required

Type

Description

labelRequiredString

The text on the button.

onclickOptionalString

Luna API to be called when a button is clicked.

onClickOptionalString

Same as onclick

paramsOptionalObject

Parameters for a service call.

buttonTypeOptionalString

The type of the button. It can be either ok or cancel.

focusOptionalBoolean

Set to true if button has default focus.

action

Describes the action parameter for the toast.

Name

Required

Type

Description

launchParamsRequiredObject

launchParams must be passed in the format below where "appid" is a string that contains the id of the app to be launched. 

{

"id": "appid"

}

serviceMethodRequiredString

Contains the LS2 service method name.

serviceURIRequiredString

Contains LS2 Service URI.

onfail

Action to be performed on failure to create alert from view side (LSM).

Name

Required

Type

Description

uriRequiredString

Luna API to be called when an alert window is closed.

paramsRequiredObject

Parameters for the above URI.

onFailAction

Action to be performed on failure to create alert.

Name

Required

Type

Description

serviceURIRequiredString

URI to be called on failure to create alert.

serviceMethodRequiredString

Method to be called on failure to create alert.

launchParamsRequiredObject

Parameters to be passed when URI (specified above) is called.

image

Defines extra toast image.

Name

Required

Type

Description

uriOptionalString

Image resource URI.

toastInfo

Contains information about the stored toasts

Name

Required

Type

Description

displayIdRequiredNumber

Identifier of the display where the notification is displayed. Possible values are 0 and 1

sourceIdRequiredString

Contains the source Id of the requester

toastIdRequiredString

Contains the unique ID of the toast created

timestampRequiredString

Time stamp string. It indicates epoch time as milliseconds

iconUrlRequiredString

Contains the file path to icon to be displayed

iconPathRequiredString

Describe icon path. It should be absoulte local file system path

titleRequiredString

Contains the title information to be displayed for the toast

messageRequiredString

Indicates the toast message.

isSysReqRequiredBoolean

Indicates whether the notification comes from an app or system

  • true: notification from system
  • false: notification from app
userRequiredString

Indicates the user active on the corresponding display session

scheduleRequiredObject: schedule

Describe toast schedule.

typeRequiredString

Indicates the type of the toast message

readStatusRequiredBoolean

Indicates whether the toast is read by the user or still unread

  • true: toast is read
  • false: toast is unread
actionRequiredObject: action

Contains the on-click action parameter.

Contents