software.amazon.awssdk.services.pinpoint.model

Interface APNSMessage.Builder

All Superinterfaces:

Buildable, CopyableBuilder<APNSMessage.Builder,APNSMessage>, SdkBuilder<APNSMessage.Builder,APNSMessage>, SdkPojo

Enclosing class:

APNSMessage

public static interface APNSMessage.Builder
extends SdkPojo, CopyableBuilder<APNSMessage.Builder,APNSMessage>

Method Summary

Modifier and Type	Method and Description
APNSMessage.Builder	action(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.
APNSMessage.Builder	action(String 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.
APNSMessage.Builder	badge(Integer badge) Include this key when you want the system to modify the badge of your app icon.
APNSMessage.Builder	body(String body) The message body of the notification.
APNSMessage.Builder	category(String category) Provide this key with a string value that represents the notification's type.
APNSMessage.Builder	collapseId(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.
APNSMessage.Builder	data(Map<String,String> data) The data payload used for a silent push.
APNSMessage.Builder	mediaUrl(String mediaUrl) A URL that refers to the location of an image or video that you want to display in the push notification.
APNSMessage.Builder	preferredAuthenticationMethod(String preferredAuthenticationMethod) The preferred authentication method, either "CERTIFICATE" or "TOKEN"
APNSMessage.Builder	priority(String priority) The message priority.
APNSMessage.Builder	rawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
APNSMessage.Builder	silentPush(Boolean silentPush) Indicates if the message should display on the users device.
APNSMessage.Builder	sound(String sound) Include this key when you want the system to play a sound.
APNSMessage.Builder	substitutions(Map<String,? extends Collection<String>> substitutions) Default message substitutions.
APNSMessage.Builder	threadId(String threadId) Provide this key with a string value that represents the app-specific identifier for grouping notifications.
APNSMessage.Builder	timeToLive(Integer timeToLive) The length of time (in seconds) that APNs stores and attempts to deliver the message.
APNSMessage.Builder	title(String title) The message title that displays above the message on the user's device.
APNSMessage.Builder	url(String url) The URL to open in the user's mobile browser.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

action

APNSMessage.Builder action(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Action, Action

action

APNSMessage.Builder action(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Action, Action

badge

APNSMessage.Builder badge(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

body

APNSMessage.Builder body(String body)

The message body of the notification.

Parameters:

body - The message body of the notification.

Returns:

Returns a reference to this object so that method calls can be chained together.

category

APNSMessage.Builder category(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

collapseId

APNSMessage.Builder collapseId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

data

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

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

mediaUrl

APNSMessage.Builder mediaUrl(String mediaUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredAuthenticationMethod

APNSMessage.Builder preferredAuthenticationMethod(String preferredAuthenticationMethod)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

priority

APNSMessage.Builder priority(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rawContent

APNSMessage.Builder rawContent(String rawContent)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

silentPush

APNSMessage.Builder silentPush(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sound

APNSMessage.Builder sound(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

substitutions

APNSMessage.Builder substitutions(Map<String,? extends Collection<String>> substitutions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

threadId

APNSMessage.Builder threadId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

timeToLive

APNSMessage.Builder timeToLive(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

title

APNSMessage.Builder title(String title)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

url

APNSMessage.Builder url(String url)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.