Skip to content

DefaultPushNotificationTemplate

Source code in docs_src/capo_pinpoint/types/default_push_notification_template.py 
12
13
14
15
16
17
18
19
20
21
22
class DefaultPushNotificationTemplate(TypedDict, closed=True):
    action: NotRequired["capo_pinpoint.types.action.Action"]
    """<p>The action to occur if a recipient taps a push notification that's based on the message template. 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 message body to use in push notifications that are based on the message template.</p>"""
    sound: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.</p> <p>For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.</p>"""
    title: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.</p>"""
    url: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.</p>"""

action instance-attribute 

action: NotRequired[Action]

The action to occur if a recipient taps a push notification that's based on the message template. 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 message body to use in push notifications that are based on the message template.

sound instance-attribute 

sound: NotRequired[__string]

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

title instance-attribute 

title: NotRequired[__string]

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

url instance-attribute 

url: NotRequired[__string]

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