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

ACG: notification.operation

Description

Creates a system alert notification.

Parameters

Name	Required	Type	Description
iconUrl	Optional	String	The file path of the alert icon. The file path must be local to the device.
title	Optional	String	A brief title for the alert notification.
message	Required	String	A detailed message for the alert notification.
modal	Optional	Boolean	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.
buttons	Required	Object 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"} ]
onclose	Optional	Object: onclose	Defines the close action to be performed when an alert is closed.
type	Optional	String	Defines the button type in the alert. Possible values are: confirm warning
isSysReq	Optional	Boolean	Indicates whether the notification has come from an app or system true : notification comes from system false : notification comes from an app
onfail	Optional	Object: onfail	Action to be performed on failure to create an alert.

Call Returns

Name	Required	Type	Description
alertId	Optional	String	The ID of the created alert notification. This would be sourceId + "-" + Timestamp.
returnValue	Required	Boolean	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.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Name

Required

Type

Description

alertId

Optional

String

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

returnValue

Required

Boolean

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.

errorText

Optional

String

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
None	Unknown Source	This message implies that the system was unable to retrieve the app's sourceId from the system bus message.
None	Permission Denied	This message implies that the app does not have permission to create system alerts.
None	Message 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.
None	Message can't be empty	This message implies that the field message in the request message is empty.
None	Invalid Service Uri in the onclick	This message implies that the service URI given in the onclick object is invalid.

Example

Example scenario

# 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

ACG: notification.management

Description

Subscribe to create alert notifications.

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

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribed for notifications. false: Not subscribed Default: false

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribed for notifications.
false: Not subscribed

Default: false

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	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.
subscribed	Optional	Boolean	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.

Name

Required

Type

Description

returnValue

Required

Boolean

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.

subscribed

Optional

Boolean

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
alertInfo	Required	Object: alertInfo	Contains alert info.
timestamp	Required	String	Indicates the timestamp string. Note: It indicates epoch time as milliseconds.
returnValue	Required	Boolean	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.
alertAction	Required	String	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.
onFailAction	Optional	Object: onFailAction	Indicates the action to be performed on failure to create an alert.

Example

Example code

# 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

ACG: notification.management

Description

Closes the currently displayed alert notification.

Parameters

Name	Required	Type	Description
alertId	Required	String	The ID of the alert notification to close.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	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.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Name

Required

Type

Description

returnValue

Required

Boolean

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.

errorText

Optional

String

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
None	Message 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.
None	Alert ID can't be empty	This message implies that the alertId field in the message is empty or missing.
None	Alert ID parse error	This message implies that the alertId is not formatted properly.

Error Code

Error Text

Error Description

None

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

None

Alert ID can't be empty

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

None

Alert ID parse error

This message implies that the alertId is not formatted properly.

Example

Example code

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

Response:

{
"returnValue": true
}

closeAllAlerts

ACG: notification.management

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
returnValue	Required	Boolean	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.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the Error Codes Reference of this method for more details.

Name

Required

Type

Description

returnValue

Required

Boolean

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.

errorText

Optional

String

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
None	Unknown Source	This message implies that the system was unable to retrieve the app source ID from the system bus message.
None	Message 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.
None	Invalid source ID specified	If call is not from com.webos.service.battest, notification refuses API request with this error.

Error Code

Error Text

Error Description

None

Unknown Source

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

None

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

None

Invalid source ID specified

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

Example

Example code

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

ACG: notification.management

Description

Removes all notifications that are currently being displayed.

Parameters

Name	Required	Type	Description
displayId	Optional	Number	Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	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.
removeAllNotiId	Required	Boolean	Indicates whether all notifications were removed successfully. Possible values are: true: Notifications were removed successfully. false: Notification removal failed.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.
displayId	Required	Number	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
None	Permission 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

Example scenario

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

Response:

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

createToast

ACG: notification.operation

Description

Creates a toast notification.

Parameters

Name	Required	Type	Description
sourceId	Optional	String	The ID of the application or service that creates the toast notification.
iconUrl	Optional	String	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 PNG format.
message	Required	String	The detailed message to be displayed as part of the toast notification. The message can be up to 60 characters long.
onclick	Optional	Object: onclick	Defines the toast action. An example is: {"appId":"com.webos.app.test"}
noaction	Optional	Boolean	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.
stale	Optional	Boolean	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.
persistent	Optional	Boolean	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.
isSysReq	Optional	Boolean	Defines notification comes from app or system true : notification comes from system false : notification comes from app
schedule	Optional	Object: schedule	Creates a toast notification as a persistent message and defines its schedule.
type	Optional	String	Defines the toast type.
extra	Optional	Object array: image	Defines extra toast resource.
onlyToast	Optional	Boolean	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
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.
toastId	Optional	String	The id of the created toast notification. This would be sourceId + "-" + Timestamp.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of operation.

Possible values are:

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

toastId

Optional

String

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

errorText

Optional

String

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
None	Unknown Source	Indicates that the system was unable to retrieve the app source id from the System Bus message.
None	Message 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.
None	Invalid id specified	Indicates that the app is missing from the requested message.
None	Invalid source id specified	Indicates that the app Id given in the requested message does not match with the system bus caller Id.
None	Message can't be empty	Indicates that the message field in the requested message is empty.

Example

Example code

# 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

ACG: notification.management

Description

Subscribe to created toast notification.

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

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed Default: false

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe for notifications
false: Not subscribed

Default: false

Call Returns

Name	Required	Type	Description
subscribed	Optional	Boolean	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.
returnValue	Required	Boolean	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.

Name

Required

Type

Description

subscribed

Optional

Boolean

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.

returnValue

Required

Boolean

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
returnValue	Required	Boolean	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.
message	Required	String	Contains the message to be displayed.
type	Optional	String	Indicates the type of the toast message. Note: This is optional parameter and currently not used. This is reserved for future purpose.
title	Optional	String	Contains the title information to be displayed for the toast.
isCradleReq	Optional	Boolean	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.
sourceId	Required	String	Contains the source Id of the requester.
timestamp	Required	String	Indicates the time stamp string. It indicates epoch time as milliseconds.
isSysReq	Required	Boolean	Indicates if the notification comes from an app or system. Possible values are: true: Notification comes from system. false: Notification comes from app.
iconUrl	Required	String	Contains the file path to icon to be displayed.
action	Optional	Object: action	Contains the action parameter.
schedule	Optional	Object: schedule	Describes the toast schedule.
iconPath	Required	String	Specifies the path of the icon. It should be absolute local file system path.
user	Optional	String	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".
_kind	Optional	String	Displays the db kind in which the toast is stored. Note: It is an internal parameter.
onlyToast	Required	Boolean	Indicates if notification is created as a simple toast. Note: It is set when creating the toast.

Example

Example code

# 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

ACG: notification.management

Description

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

Parameters

Name	Required	Type	Description
displayId	Optional	Number	Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

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

toastInfo

Required

Object array: toastInfo

Contains information of the stored toasts.

errorText

Optional

String

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
None	Unknown Source	Indicates that the system was unable to retrieve the app/service's source id from the system bus message.
None	Permission Denied	Indicates that the app/service does not have permission to query toast list.
None	Message is not parsed	Indicates that the required parameters were not passed to API.
None	Can't get the notification info from db	Failed to fetch the toast list from the database.

Example

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

ACG: notification.management

Description

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

Parameters

Name	Required	Type	Description
toastId	Required	String	Indicates the unique ID of the toast created.
readStatus	Required	Boolean	Indicates the status of a toast to be set by the user. Possible values are: true: toast is read. false: toast is unread.

Name

Required

Type

Description

toastId

Required

String

Indicates the unique ID of the toast created.

readStatus

Required

Boolean

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
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.
toastId	Optional	String	Contains the unique ID of the toast created.
readStatus	Optional	Boolean	Indicates the status of a toast set by the user. Possible values are: true: toast is read. false: toast is unread.
errorText	Optional	String	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
None	Failed to set status	Failed to set the read / unread status of the toast.

Example

Example code

# 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

ACG: notification.management

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
subscribe	Optional	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed
displayId	Optional	Number	Identifier of the display where the notification is to be displayed. Possible values are 0 and 1.

Name

Required

Type

Description

Optional

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe for notifications
false: Not subscribed

displayId

Optional

Number

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

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.
subscribed	Required	Boolean	Indicates if subscribed to get notifications. Possible values are: true: Subscribe for notifications false: Not subscribed

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of operation.

Possible values are:

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

subscribed

Required

Boolean

Indicates if subscribed to get notifications.

Possible values are:

true: Subscribe for notifications
false: Not subscribed

Subscription Returns

Name	Required	Type	Description
readCount	Required	Number	Indicates the count of toast notifications read by a specific user.
unreadCount	Required	Number	Indicates the count of toast notifications unread by the user.
totalCount	Required	Number	Indicates the total count of toast notifications respective to a user.
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed.

Example

Example: Get toast count form a specific displayId

# 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

ACG: notification.management

Description

Removes a toast notification from the database.

Parameters

Name	Required	Type	Description
toastId	Optional	String	ID of the toast notification to remove from the database. Note: Either toastId or sourceId is required.
sourceId	Optional	String	ID of the app/service to remove from the database. Note: Either toastId or sourceId is required.

Name

Required

Type

Description

toastId

Optional

String

ID of the toast notification to remove from the database.

Note: Either toastId or sourceId is required.

sourceId

Optional

String

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

Note: Either toastId or sourceId is required.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	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.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Name

Required

Type

Description

returnValue

Required

Boolean

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.

errorText

Optional

String

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
None	Toast ID parse error	Indicates that the toastId is not formatted properly.
None	Both Toast ID and Source ID can't be empty	Indicates that neither toastId or sourceId field in the message is empty or missing.
None	Message 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.

Error Code

Error Text

Error Description

None

Toast ID parse error

Indicates that the toastId is not formatted properly.

None

Both Toast ID and Source ID can't be empty

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

None

Message 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

Example : With toast ID

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

Response:

{
"returnValue":true
}

Example : With source ID

# 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
expire	Optional	Number (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.

Name

Required

Type

Description

expire

Optional

Number (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
uri	Optional	String	Luna API to be called when an alert window is closed.
params	Optional	Object	Contains parameters to be passed when uri is called.

onclick

Contains action information when a user clicks the toast

Name	Required	Type	Description
appId	Optional	String	Application Id to be launched
params	Optional	Object	Contains parameters when appId is launched.

button

Contains alert button information

Name	Required	Type	Description
label	Required	String	The text on the button.
onclick	Optional	String	Luna API to be called when a button is clicked.
onClick	Optional	String	Same as onclick.
params	Optional	Object	Parameters for a service call.
buttonType	Optional	String	The type of the button. It can be either ok or cancel.
focus	Optional	Boolean	Set to true if button has default focus.

action

Describes the action parameter for the toast.

Name	Required	Type	Description
launchParams	Required	Object	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" }
serviceMethod	Required	String	Contains the LS2 service method name.
serviceURI	Required	String	Contains LS2 Service URI.

Name

Required

Type

Description

launchParams

Required

Object

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"

}

serviceMethod

Required

String

Contains the LS2 service method name.

serviceURI

Required

String

Contains LS2 Service URI.

onfail

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

Name	Required	Type	Description
uri	Required	String	Luna API to be called when an alert window is closed.
params	Required	Object	Parameters for the above URI.

onFailAction

Action to be performed on failure to create alert.

Name	Required	Type	Description
serviceURI	Required	String	URI to be called on failure to create alert.
serviceMethod	Required	String	Method to be called on failure to create alert.
launchParams	Required	Object	Parameters to be passed when URI (specified above) is called.

image

Defines extra toast image.

Name	Required	Type	Description
uri	Optional	String	Image resource URI.

toastInfo

Contains information about the stored toasts

Name	Required	Type	Description
displayId	Required	Number	Identifier of the display where the notification is displayed. Possible values are 0 and 1
sourceId	Required	String	Contains the source Id of the requester
toastId	Required	String	Contains the unique ID of the toast created
timestamp	Required	String	Time stamp string. It indicates epoch time as milliseconds
iconUrl	Required	String	Contains the file path to icon to be displayed
iconPath	Required	String	Describe icon path. It should be absoulte local file system path
title	Required	String	Contains the title information to be displayed for the toast
message	Required	String	Indicates the toast message.
isSysReq	Required	Boolean	Indicates whether the notification comes from an app or system true: notification from system false: notification from app
schedule	Required	Object: schedule	Describe toast schedule.
type	Required	String	Indicates the type of the toast message
readStatus	Required	Boolean	Indicates whether the toast is read by the user or still unread true: toast is read false: toast is unread
action	Required	Object: action	Contains the on-click action parameter.