Skip to main content

registerPush

Registers the app for push messages. A pop-up may appear before the registration (and thus the system message is displayed on iOS) takes place.

Field Configurations

KeyTypeDescriptionDefault Value
"params"Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"alertCancel"StringThe text of the "No" button.null
"alertMessage" (required)StringThe message of the Pop-up.null
"alertOK"StringThe text of the "Yes" button.null
"alertTitle" (required)StringThe title of the Pop-up.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples

Example: register for push

Register the app for push messages.

{
"type": "registerPush",
"params": {
"alertTitle": "Enable pushs",
"alertMessage": "Do you want to receive push notifications?",
"alertOK": "Hell yeah!",
"alertCancel": "Hell no!"
}
}

The actions to be executed are specified in the actions parameter, in this case a registerPush action.

Result:

A registerPush action has been created.