playNotificationSound

Plays the default notification sound set by the user within the operating system.

note

The sound only plays if the device is set to loud. On iOS, if the device is set to silent the sound is replaced by vibration.

Field Configurations

Key	Type	Description	Default Value
"params"	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Play the notification sound

Show ExampleHide Example

The playNotificationSound action does not require any params.

{
  "type": "playNotificationSound"
}