com.webos.notification

The ID of the alert notification to close.

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.

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

 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.

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

       This message implies that the alertId is not formatted properly.

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.

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

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

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.

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

ID of the toast notification to remove from the database. 

Note: Either toastId or sourceId is required.

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

Note: Either toastId or sourceId is required.

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.

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

Indicates that the toastId is not formatted properly. 

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

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.

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

A brief title for the alert notification. 

A detailed message for the alert notification.

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.

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"}
]

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

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

• confirm (default)
• warning

Indicates whether the notification has come from an app or system

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

Action to be performed on failure to create an alert.

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

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.

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

The error code for the failed operation.

See the 'API Error Codes Reference' table for detailed information on relevant error code.

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

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.

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

Defines the toast action. An example is: 

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

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.

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.

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.

Defines notification comes from app or system

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

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

Defines the toast type.

Possible values are:

• "standard", "light"  (Default): standard

Defines extra toast resource.

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

Indicates the status of operation.

Possible values are:

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

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

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

The error code for the failed operation.

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.

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

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

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

Indicates the status of the operation.

Possible values are:

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

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

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

Indicates that the app/service does not have permission to enable notifications.

Indicates the status of the operation.

Possible values are:

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

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

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

Indicates that the app/service does not have permission to enable notifications.

Indicates if subscribed to get notifications.

Possible values are:

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

Default: false

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.

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.

Contains alert info.

Indicates the timestamp string.

Note: It indicates epoch time as milliseconds.

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.

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. 

This parameter is retired.

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

Indicates if subscribed to get notifications.

Possible values are:

• true: Subscribe for notifications
• false: Not subscribed

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

Indicates the status of operation.

Possible values are:

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

Indicates if subscribed to get notifications.

Possible values are:

• true: Subscribe for notifications
• false: Not subscribed

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

Indicates the count of toast notifications unread by the user.

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

Indicates the status of operation.

Possible values are:

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

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

Indicates the status of the operation.

Possible values are:

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

Contains information of the stored toasts.

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

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

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

Indicates that the required parameters were not passed to API.

Failed to fetch the toast list from the database.

Indicates if subscribed to get notifications.

Possible values are:

• true: Subscribe for notifications
• false: Not subscribed

Default: false

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.

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.

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.

Contains the message to be displayed.

Indicates the type of the toast message.

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

Contains the title information to be displayed for the toast.

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.

Contains the source Id of the requester. 

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

Indicates if the notification comes from an app or system.

Possible values are:

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

Contains the file path to icon to be displayed.

Contains the action parameter.

Describes the toast schedule.

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

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

Displays the db kind in which the toast is stored.

Note: It is an internal parameter.

Indicates if notification is created as a simple toast.

Note: It is set when creating the toast.

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

Possible values are: 

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

Denotes the time source.

Example: system, manual, ntp, sdp.

ID of the display where the notification is displayed.

Possible values are 0 and 1.

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

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.

Indicates whether all notifications were removed successfully.

Possible values are: 

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

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

Identifier of the display where the notification is to be displayed.

Possible values are 0 and 1.

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.

A list of IDs of the notifications to be deleted. Notification ID is composed of the URI of the notification source, a dash, and the timestamp of the time when the notification was issued.

Format: "Source URI-Timestamp"

Example "com.webos.surfacemanager-1393548223764"

Note: Either one of "removeNotiId" or "sourceId" is mandatory to be provided.

Identifies the app or service that created the notification to be deleted.

Format: URI

Note: Either one of "removeNotiId" or "sourceId" is mandatory to be provided.

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.

A list of IDs of the notification that has been deleted.

Format: "Source URI-Timestamp"

Example: "com.webos.surfacemanager-1393548223764"

Note: Returned when "removeNotiId" is passed as input parameter

The app or service that created the notification that are deleted.

Format: URI

Example: "com.webos.surfacemanager"

Note: Returned when "sourceId" is passed as input parameter

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

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.

This message implies that both sourceId and removeNotiId parameters are missing. At least one should be present.

This message implies that given sourceId parameter does not have any value. It cannot be empty. 

This message implies that given NotiId is empty.

Indicates the unique ID of the toast created.

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

Possible values are: 

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

Indicates the status of the operation.

Possible values are:

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

Contains the unique ID of the toast created.

Indicates the status of a toast set by the user.

Possible values are:

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

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

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

Activity Id that is fired.

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"

}

Contains the LS2 service method name.

Contains LS2 Service URI.

App ID related to this alert.

Indicates milliseconds in time that the caller waits to dismiss an alert when the user does nothing.

Indicates port type.

Indicates port name.

Indicates port icon path.

Indicates device name.

Contains parameters when appId is launched.

Contains information about an input alert.

"onFailAction": { "launchParams": { "id": "com.webos.app.browser" }, "serviceMethod": "launch", "serviceURI": "com.webos.service.applicationmanager/" }

ID the application or service that created the alert notification.

Format: URI

Example: "com.webos.surfacemanager"

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

Title information to be displayed for the alert.

Message to be displayed.

File path to icon to be displayed.

Indicates whether the alert is a modal or non-modal notification.

Possible values are: 

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

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

• confirm
• warning
• progress

Indicates whether the notification comes from an app or a system.

• true: Notification comes from a system
• false: Notification comes from an app

Indicate whether the notification saved or not.

Possible values are: 

• true: Notification saved
• false: Notification not saved

Indicates the action to be performed when close an alert. 

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"}
]

The ID of the created alert notification. The ID is composed of the URI of the notification source, a dash, and the timestamp of the time when the notification was issued.

Format: "Source URI-Timestamp"

Example: "com.webos.surfacemanager-1393548223764"

Timestamp of the time when the notification was issued.

It indicates epoch time as milliseconds. 

Connected device icon file name.

The text on the button.

Luna API to be called when a button is clicked.

Same as onclick. 

Parameters for a service call.

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

Set to true if button has default focus.

Image resource URI.

URI to be called on failure to create alert.

Method to be called on failure to create alert.

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

Application Id to be launched

Contains parameters when appId is launched.

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

Contains parameters to be passed when uri is called.

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

Parameters for the above URI.

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.

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

Contains the source Id of the requester

Contains the unique ID of the toast created

Time stamp string. It indicates epoch time as milliseconds

Contains the file path to icon to be displayed

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

Contains the title information to be displayed for the toast

Indicates the toast message.

Indicates whether the notification comes from an app or system

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

Describe toast schedule.

Indicates the type of the toast message

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

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

Contains the on-click action parameter.