Package software.amazon.awssdk.services.pinpoint.model

Interface DefaultPushNotificationTemplate.Builder

    • Method Detail

      • action

        DefaultPushNotificationTemplate.Builder action​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Action, Action

      • action

        DefaultPushNotificationTemplate.Builder action​(Action 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Action, Action

      • body

        DefaultPushNotificationTemplate.Builder body​(String body)

        The message body to use in push notifications that are based on the message template.

        Parameters:
        body - The message body to use in push notifications that are based on the message template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sound

        DefaultPushNotificationTemplate.Builder sound​(String sound)

        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.

        Parameters:
        sound - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • title

        DefaultPushNotificationTemplate.Builder title​(String title)

        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.

        Parameters:
        title - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • url

        DefaultPushNotificationTemplate.Builder url​(String url)

        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.

        Parameters:
        url - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.