software.amazon.awssdk.services.pinpoint.model

Interface Message.Builder

All Superinterfaces:

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

Enclosing class:

Message

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

Method Summary

Modifier and Type	Method and Description
Message.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.
Message.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.
Message.Builder	body(String body) The message body.
Message.Builder	imageIconUrl(String imageIconUrl) The URL that points to the icon image for the push notification icon, for example, the app icon.
Message.Builder	imageSmallIconUrl(String imageSmallIconUrl) The URL that points to the small icon image for the push notification icon, for example, the app icon.
Message.Builder	imageUrl(String imageUrl) The URL that points to an image used in the push notification.
Message.Builder	jsonBody(String jsonBody) The JSON payload used for a silent push.
Message.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.
Message.Builder	rawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
Message.Builder	silentPush(Boolean silentPush) Indicates if the message should display on the users device.
Message.Builder	timeToLive(Integer timeToLive) This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time.
Message.Builder	title(String title) The message title that displays above the message on the user's device.
Message.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

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

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.

Returns:

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

See Also:

Action, Action

action

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

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.

Returns:

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

See Also:

Action, Action

body

Message.Builder body(String body)

The message body. Can include up to 140 characters.

Parameters:

body - The message body. Can include up to 140 characters.

Returns:

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

imageIconUrl

Message.Builder imageIconUrl(String imageIconUrl)

The URL that points to the icon image for the push notification icon, for example, the app icon.

Parameters:

imageIconUrl - The URL that points to the icon image for the push notification icon, for example, the app icon.

Returns:

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

imageSmallIconUrl

Message.Builder imageSmallIconUrl(String imageSmallIconUrl)

The URL that points to the small icon image for the push notification icon, for example, the app icon.

Parameters:

imageSmallIconUrl - The URL that points to the small icon image for the push notification icon, for example, the app icon.

Returns:

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

imageUrl

Message.Builder imageUrl(String imageUrl)

The URL that points to an image used in the push notification.

Parameters:

imageUrl - The URL that points to an image used in the push notification.

Returns:

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

jsonBody

Message.Builder jsonBody(String jsonBody)

The JSON payload used for a silent push.

Parameters:

jsonBody - The JSON payload used for a silent push.

Returns:

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

mediaUrl

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

rawContent

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

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

timeToLive

Message.Builder timeToLive(Integer timeToLive)

This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM

Parameters:

timeToLive - This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM

Returns:

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

title

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

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