Skip to main content
Version: 4.64

registerPush

Registers the app with FCM (Android) or APNS (iOS) for push messages. A system prompt may appear for the user to confirm receiving notifications from this app before the actual registration concludes.

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 1: Register the app for push messages​

Show ExampleHide Example

Ask the user to register for push notifications.

{
"type": "registerPush",
"params": {
"alertTitle": "$lang(registerPush01Title01)$",
"alertMessage": "$lang(registerPush01Message01)$",
"alertOK": "$lang(registerPush01Ok01)$",
"alertCancel": "$lang(registerPush01Cancel01)$"
}
}
The app showing the results of the sample code from Example 1.The app showing the results of the sample code from Example 1.