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

Interface DefaultPushNotificationMessage.Builder

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

  • Method Details

    • action

      DefaultPushNotificationMessage.Builder action(String action)

      The default action to occur if a 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 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 default action to occur if a 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 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

      DefaultPushNotificationMessage.Builder action(Action action)

      The default action to occur if a 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 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 default action to occur if a 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 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:

    • body

      DefaultPushNotificationMessage.Builder body(String body)

      The default body of the notification message.

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

    • data

      DefaultPushNotificationMessage.Builder data(Map<String,String> data)

      The JSON data payload to use for the default 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 default 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.

    • silentPush

      DefaultPushNotificationMessage.Builder silentPush(Boolean silentPush)

      Specifies whether the default 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 delivering messages to an in-app notification center.

      Parameters:
      silentPush - Specifies whether the default 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 delivering messages to an in-app notification center.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • substitutions

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

      DefaultPushNotificationMessage.Builder title(String title)

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

      Parameters:
      title - The default title to display 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

      DefaultPushNotificationMessage.Builder url(String url)

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

      Parameters:
      url - The default URL to open in a 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.