Skip to content

DefaultPushNotificationMessage

Source code in docs_src/capo_pinpoint/types/default_push_notification_message.py
class DefaultPushNotificationMessage(TypedDict, closed=True):
    action: NotRequired["capo_pinpoint.types.action.Action"]
    """<p>The default action to occur if a recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>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.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>"""
    body: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The default body of the notification message.</p>"""
    data: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>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.</p>"""
    silent_push: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>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.</p>"""
    substitutions: NotRequired[
        "capo_pinpoint.types.map_of_list_of__string.MapOfListOf__string"
    ]
    """<p>The default message variables to use in the notification message. You can override the default variables with individual address variables.</p>"""
    title: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The default title to display above the notification message on a recipient's device.</p>"""
    url: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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.</p>"""

action instance-attribute

action: NotRequired[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.

body instance-attribute

body: NotRequired[__string]

The default body of the notification message.

data instance-attribute

data: NotRequired[MapOf__string]

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.

silent_push instance-attribute

silent_push: NotRequired[__boolean]

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.

substitutions instance-attribute

substitutions: NotRequired[MapOfListOf__string]

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

title instance-attribute

title: NotRequired[__string]

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

url instance-attribute

url: NotRequired[__string]

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.