Class APNSPushNotificationTemplate
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Action
action()
The action to occur if a recipient taps a push notification that's based on the message template.final String
The action to occur if a recipient taps a push notification that's based on the message template.final String
body()
The message body to use in push notifications that are based on the message template.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
mediaUrl()
The URL of an image or video to display in push notifications that are based on the message template.final String
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template.static Class
<? extends APNSPushNotificationTemplate.Builder> final String
sound()
The key for the sound to play when the recipient receives a push notification that's based on the message template.final String
title()
The title to use in push notifications that are based on the message template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- 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
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 returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- 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
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
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
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
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
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
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
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 interfaceToCopyableBuilder<APNSPushNotificationTemplate.Builder,
APNSPushNotificationTemplate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-