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

Interface GCMMessage.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GCMMessage.Builder,GCMMessage>, SdkBuilder<GCMMessage.Builder,GCMMessage>, SdkPojo
Enclosing class:
GCMMessage
public static interface GCMMessage.Builder extends SdkPojo, CopyableBuilder<GCMMessage.Builder,GCMMessage>

  • Method Details

    • action

      GCMMessage.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

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

    • body

      GCMMessage.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.

    • collapseKey

      GCMMessage.Builder collapseKey(String collapseKey)

      An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

      Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

      Parameters:
      collapseKey - An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

      Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

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

    • data

      GCMMessage.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.

    • iconReference

      GCMMessage.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

      GCMMessage.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

      GCMMessage.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.

    • preferredAuthenticationMethod

      GCMMessage.Builder preferredAuthenticationMethod(String preferredAuthenticationMethod)

      The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.

      Parameters:
      preferredAuthenticationMethod - The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      GCMMessage.Builder priority(String priority)

      para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

      /listitem>

    • high – The notification is sent immediately and might wake a sleeping device.

      • /para>

      Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

      The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

      Parameters:
      priority - para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

      /listitem>

    • high – The notification is sent immediately and might wake a sleeping device.

      • /para>

      Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

      The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

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

    • rawContent

      GCMMessage.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.

    • restrictedPackageName

      GCMMessage.Builder restrictedPackageName(String restrictedPackageName)

      The package name of the application where registration tokens must match in order for the recipient to receive the message.

      Parameters:
      restrictedPackageName - The package name of the application where registration tokens must match in order for the recipient to receive the message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • silentPush

      GCMMessage.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

      GCMMessage.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

      GCMMessage.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

      GCMMessage.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.

    • timeToLive

      GCMMessage.Builder timeToLive(Integer timeToLive)

      The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

      Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

      Parameters:
      timeToLive - The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

      Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

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

    • title

      GCMMessage.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

      GCMMessage.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.