Documentation

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

See: newDefaultPushNotificationMessage smart constructor.

Create a value of DefaultPushNotificationMessage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:substitutions:DefaultPushNotificationMessage', defaultPushNotificationMessage_substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.

$sel:silentPush:DefaultPushNotificationMessage', defaultPushNotificationMessage_silentPush - Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

$sel:data':DefaultPushNotificationMessage', defaultPushNotificationMessage_data - The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:body:DefaultPushNotificationMessage', defaultPushNotificationMessage_body - The default body of the notification message.

$sel:url:DefaultPushNotificationMessage', defaultPushNotificationMessage_url - The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:action:DefaultPushNotificationMessage', defaultPushNotificationMessage_action - The default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:title:DefaultPushNotificationMessage', defaultPushNotificationMessage_title - The default title to display above the notification message on a recipient's device.

The default message variables to use in the notification message. You can override the default variables with individual address variables.

Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

The default body of the notification message.

The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

The default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

The default title to display above the notification message on a recipient's device.