PushADMMessageTemplateContent ¶

class PushADMMessageTemplateContent(TypedDict, closed=True):
    title: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<p>The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.</p>"""
    body: NotRequired[
        "capo_qconnect.types.message_template_body_content_provider.MessageTemplateBodyContentProvider"
    ]
    """<p>The message body to use in a push notification that is based on the message template.</p>"""
    action: NotRequired["capo_qconnect.types.push_message_action.PushMessageAction"]
    """<p>The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:</p> <ul> <li> <p> <code>OPEN_APP</code> - 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> <code>DEEP_LINK</code> - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.</p> </li> <li> <p> <code>URL</code> - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p> </li> </ul>"""
    sound: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<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 <code>/res/raw/</code>.</p>"""
    url: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<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 <code>action</code> property is <code>URL</code>.</p>"""
    image_url: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<p>The URL of an image to display in a push notification that's based on the message template.</p>"""
    image_icon_url: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<p>The URL of the large icon image to display in the content view of a push notification that's based on the message template.</p>"""
    small_image_icon_url: NotRequired[
        "capo_qconnect.types.non_empty_unlimited_string.NonEmptyUnlimitedString"
    ]
    """<p>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.</p>"""
    raw_content: NotRequired[
        "capo_qconnect.types.message_template_body_content_provider.MessageTemplateBodyContentProvider"
    ]
    """<p>The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.</p>"""