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

Interface ADMMessage.Builder

    • Method Detail

      • action

        ADMMessage.Builder action​(String action)

        The action to occur if the 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 action uses the deep-linking features of the Android platform.

        • 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 the 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 action uses the deep-linking features of the Android platform.

        • 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

        ADMMessage.Builder action​(Action action)

        The action to occur if the 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 action uses the deep-linking features of the Android platform.

        • 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 the 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 action uses the deep-linking features of the Android platform.

        • 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

        ADMMessage.Builder body​(String body)

        The body of the notification message.

        Parameters:
        body - The body of the notification message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • consolidationKey

        ADMMessage.Builder consolidationKey​(String consolidationKey)

        An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

        Parameters:
        consolidationKey - An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • data

        ADMMessage.Builder data​(Map<String,​String> data)

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

        Parameters:
        data - The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expiresAfter

        ADMMessage.Builder expiresAfter​(String expiresAfter)

        The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

        Parameters:
        expiresAfter - The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iconReference

        ADMMessage.Builder iconReference​(String iconReference)

        The icon image name of the asset saved in your app.

        Parameters:
        iconReference - The icon image name of the asset saved in your app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imageIconUrl

        ADMMessage.Builder imageIconUrl​(String imageIconUrl)

        The URL of the large icon image to display in the content view of the push notification.

        Parameters:
        imageIconUrl - The URL of the large icon image to display in the content view of the push notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imageUrl

        ADMMessage.Builder imageUrl​(String imageUrl)

        The URL of an image to display in the push notification.

        Parameters:
        imageUrl - The URL of an image to display in the push notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • md5

        ADMMessage.Builder md5​(String md5)

        The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

        Parameters:
        md5 - The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rawContent

        ADMMessage.Builder rawContent​(String rawContent)

        The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

        Parameters:
        rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • silentPush

        ADMMessage.Builder silentPush​(Boolean silentPush)

        Specifies whether the 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 supporting phone home functionality.

        Parameters:
        silentPush - Specifies whether the 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 supporting phone home functionality.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • smallImageIconUrl

        ADMMessage.Builder smallImageIconUrl​(String smallImageIconUrl)

        The URL of the small icon image to display in the status bar and the content view of the push notification.

        Parameters:
        smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of the push notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sound

        ADMMessage.Builder sound​(String sound)

        The sound to play when the recipient receives the push notification. 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/.

        Parameters:
        sound - The sound to play when the recipient receives the push notification. 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/.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • substitutions

        ADMMessage.Builder substitutions​(Map<String,​? extends Collection<String>> substitutions)

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

        Parameters:
        substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • title

        ADMMessage.Builder title​(String title)

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

        Parameters:
        title - The title to display above the notification message on the recipient's device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • url

        ADMMessage.Builder url​(String url)

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

        Parameters:
        url - The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.