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

Class AndroidPushNotificationTemplate

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.AndroidPushNotificationTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>
@Generated("software.amazon.awssdk:codegen") public final class AndroidPushNotificationTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

See Also:

  • Method Details

    • action

      public final 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 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.

      If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

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

      See Also:

    • actionAsString

      public final String actionAsString()

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

      If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

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

      See Also:

    • body

      public final String body()

      The message body to use in a push notification that's based on the message template.

      Returns:
      The message body to use in a push notification that's based on the message template.

    • imageIconUrl

      public final String imageIconUrl()

      The URL of the large icon image to display in the content view of a push notification that's based on the message template.

      Returns:
      The URL of the large icon image to display in the content view of a push notification that's based on the message template.

    • imageUrl

      public final String imageUrl()

      The URL of an image to display in a push notification that's based on the message template.

      Returns:
      The URL of an image to display in a push notification that's based on the message template.

    • rawContent

      public final String rawContent()

      The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      Returns:
      The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

    • smallImageIconUrl

      public final String smallImageIconUrl()

      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.

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

    • sound

      public final 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/.

      Returns:
      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/.

    • title

      public final String title()

      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.

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

    • url

      public final 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.

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

    • toBuilder

      public AndroidPushNotificationTemplate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>
      Returns:
      a builder for type T

    • builder

      public static AndroidPushNotificationTemplate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AndroidPushNotificationTemplate.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.