com.webos.notification

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

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

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

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 the field message in the request message is empty.

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

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.

The type of prompt to create. Possible values are:

• parental

The ID of the application that wants to create the pincode notification.

The message to be displayed by the prompt notification.

Indicates the status of operation. Possible values are:

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

Indicates if the given pincode is correct. Possible values are:

• true: Correct
• false: Incorrect

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

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

This message implies that the pincode prompt is active and being displayed.

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 the promptType field in the request message is empty or missing. 

This message implies that the provided promptType value is something other than parental​.

Indicates close type. Possible values are:

• close
• relay

Pincode value.

Indicates pincode mode. Possible values are:

• set_match
• set_newpin
• set_verify
• null

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 error message implies that closePincodePrompt is called by some unknown app or service. 

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 error message implies that closePincodePrompt is called when there is no pincode prompt currently being displayed. 

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

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.

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.

This message implies that the app is is missing from the requested message.

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

This message implies that the message​ field in the requested message is empty.

The ID of the toast notification to remove from the database. 

Note: Either toastId or sourceId is required.

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

Note: Either toastId or sourceId is required.

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 the toastId is not formatted properly. 

This messages implies that neither toastId or sourceId field in the message is empty or missing.

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.