software.amazon.awssdk.services.pinpoint.model

Class AndroidPushNotificationTemplate

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.AndroidPushNotificationTemplate

All Implemented Interfaces:

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

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

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AndroidPushNotificationTemplate.Builder

Method Summary

Modifier and Type	Method and Description
Action	action() The action to occur if a recipient taps a push notification that's based on the message template.
String	actionAsString() The action to occur if a recipient taps a push notification that's based on the message template.
String	body() The message body to use in a push notification that's based on the message template.
static AndroidPushNotificationTemplate.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageIconUrl() The URL of the large icon image to display in the content view of a push notification that's based on the message template.
String	imageUrl() The URL of an image to display in a push notification that's based on the message template.
String	rawContent() The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template.
List<SdkField<?>>	sdkFields()
static Class<? extends AndroidPushNotificationTemplate.Builder>	serializableBuilderClass()
String	smallImageIconUrl() The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
String	sound() The sound to play when a recipient receives a push notification that's based on the message template.
String	title() The title to use in a push notification that's based on the message template.
AndroidPushNotificationTemplate.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL to open in a 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 class java.lang.Object

clone, finalize, 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 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 action uses the deep-linking features of the Android 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 return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

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 action uses the deep-linking features of the Android 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:

Action

actionAsString

public String 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 action uses the deep-linking features of the Android 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 return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

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 action uses the deep-linking features of the Android 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:

Action

body

public String body()

The message body to use in a push notification that's based on the message template.

Returns:

The message body to use in a push notification that's based on the message template.

imageIconUrl

public String imageIconUrl()

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

Returns:

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

imageUrl

public String imageUrl()

The URL of an image to display in a push notification that's based on the message template.

Returns:

The URL of an image to display in a push notification that's based on the message template.

rawContent

public String rawContent()

The raw, JSON-formatted string to use as the payload for a push notification that's 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 a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

smallImageIconUrl

public String smallImageIconUrl()

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

Returns:

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

sound

public String sound()

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

Returns:

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

title

public String title()

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

Returns:

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

url

public String url()

The URL to open in a 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 a 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

public AndroidPushNotificationTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>

builder

public static AndroidPushNotificationTemplate.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

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