Class APNSPushNotificationTemplate

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

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 push notifications that are based on the message template.

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

    • mediaUrl

      public final String mediaUrl()

      The URL of an image or video to display in push notifications that are based on the message template.

      Returns:
      The URL of an image or video to display in push notifications that are based on the message template.

    • rawContent

      public final String rawContent()

      The raw, JSON-formatted string to use as the payload for push notifications that are 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 push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

    • sound

      public final String sound()

      The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is 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:
      The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is 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.

    • title

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

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

    • url

      public final String url()

      The URL to open in the 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 the 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 APNSPushNotificationTemplate.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<APNSPushNotificationTemplate.Builder,APNSPushNotificationTemplate>
      Returns:
      a builder for type T

    • builder

      public static APNSPushNotificationTemplate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends APNSPushNotificationTemplate.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.