software.amazon.awssdk.services.pinpoint.model

Class APNSMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.APNSMessage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<APNSMessage.Builder,APNSMessage>

@Generated(value="software.amazon.awssdk:codegen")
public final class APNSMessage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<APNSMessage.Builder,APNSMessage>

APNS Message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	APNSMessage.Builder

Method Summary

Modifier and Type	Method and Description
Action	action() The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
String	actionAsString() The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
Integer	badge() Include this key when you want the system to modify the badge of your app icon.
String	body() The message body of the notification.
static APNSMessage.Builder	builder()
String	category() Provide this key with a string value that represents the notification's type.
String	collapseId() An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually.
Map<String,String>	data() The data payload used for a silent push.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mediaUrl() A URL that refers to the location of an image or video that you want to display in the push notification.
String	preferredAuthenticationMethod() The preferred authentication method, either "CERTIFICATE" or "TOKEN"
String	priority() The message priority.
String	rawContent() The Raw JSON formatted string to be used as the payload.
List<SdkField<?>>	sdkFields()
static Class<? extends APNSMessage.Builder>	serializableBuilderClass()
Boolean	silentPush() Indicates if the message should display on the users device.
String	sound() Include this key when you want the system to play a sound.
Map<String,List<String>>	substitutions() Default message substitutions.
String	threadId() Provide this key with a string value that represents the app-specific identifier for grouping notifications.
Integer	timeToLive() The length of time (in seconds) that APNs stores and attempts to deliver the message.
String	title() The message title that displays above the message on the user's device.
APNSMessage.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	url() The URL to open in the user's mobile browser.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

action

public Action action()

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

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 that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

See Also:

Action

actionAsString

public String actionAsString()

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

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 that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

See Also:

Action

badge

public Integer badge()

Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

Returns:

Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

body

public String body()

The message body of the notification.

Returns:

The message body of the notification.

category

public String category()

Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.

Returns:

Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.

collapseId

public String collapseId()

An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.

Returns:

An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.

data

public Map<String,String> data()

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

mediaUrl

public String mediaUrl()

A URL that refers to the location of an image or video that you want to display in the push notification.

Returns:

A URL that refers to the location of an image or video that you want to display in the push notification.

preferredAuthenticationMethod

public String preferredAuthenticationMethod()

The preferred authentication method, either "CERTIFICATE" or "TOKEN"

Returns:

The preferred authentication method, either "CERTIFICATE" or "TOKEN"

priority

public String priority()

The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.

Returns:

The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.

rawContent

public String rawContent()

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

The Raw JSON formatted string to be used as the payload. This value overrides the message.

silentPush

public Boolean silentPush()

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

Returns:

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

sound

public String sound()

Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

Returns:

Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

substitutions

public Map<String,List<String>> substitutions()

Default message substitutions. Can be overridden by individual address substitutions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Default message substitutions. Can be overridden by individual address substitutions.

threadId

public String threadId()

Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

Returns:

Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

timeToLive

public Integer timeToLive()

The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.

Returns:

The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.

title

public String title()

The message title that displays above the message on the user's device.

Returns:

The message title that displays above the message on the user's device.

url

public String url()

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Returns:

The URL to open in the user's mobile browser. Used if the value for Action is URL.

toBuilder

public APNSMessage.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<APNSMessage.Builder,APNSMessage>

Returns:

a builder for type T

builder

public static APNSMessage.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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