software.amazon.awssdk.services.pinpoint.model

Class Message

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.Message

All Implemented Interfaces:

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

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

Message to send

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Message.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.
String	body() The message body.
static Message.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageIconUrl() The URL that points to the icon image for the push notification icon, for example, the app icon.
String	imageSmallIconUrl() The URL that points to the small icon image for the push notification icon, for example, the app icon.
String	imageUrl() The URL that points to an image used in the push notification.
String	jsonBody() The JSON payload used for a silent push.
String	mediaUrl() A URL that refers to the location of an image or video that you want to display in the push notification.
String	rawContent() The Raw JSON formatted string to be used as the payload.
List<SdkField<?>>	sdkFields()
static Class<? extends Message.Builder>	serializableBuilderClass()
Boolean	silentPush() Indicates if the message should display on the users device.
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.
String	title() The message title that displays above the message on the user's device.
Message.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.

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.

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.

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.

See Also:

Action

body

public String body()

The message body. Can include up to 140 characters.

Returns:

The message body. Can include up to 140 characters.

imageIconUrl

public String imageIconUrl()

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

Returns:

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

imageSmallIconUrl

public String imageSmallIconUrl()

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

Returns:

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

imageUrl

public String imageUrl()

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

Returns:

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

jsonBody

public String jsonBody()

The JSON payload used for a silent push.

Returns:

The JSON payload used for a silent push.

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.

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.

timeToLive

public 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

Returns:

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

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

Returns:

a builder for type T

builder

public static Message.Builder builder()

serializableBuilderClass

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