software.amazon.awssdk.services.pinpoint.model

Class BaiduMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.BaiduMessage

All Implemented Interfaces:

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

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaiduMessage.Builder

Method Summary

Modifier and Type	Method and Description
Action	action() The action to occur if the recipient taps the push notification.
String	actionAsString() The action to occur if the recipient taps the push notification.
String	body() The body of the notification message.
static BaiduMessage.Builder	builder()
Map<String,String>	data() The JSON data payload to use for the push notification, if the notification is a silent push notification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasData() Returns true if the Data property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSubstitutions() Returns true if the Substitutions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iconReference() The icon image name of the asset saved in your app.
String	imageIconUrl() The URL of the large icon image to display in the content view of the push notification.
String	imageUrl() The URL of an image to display in the push notification.
String	rawContent() The raw, JSON-formatted string to use as the payload for the notification message.
List<SdkField<?>>	sdkFields()
static Class<? extends BaiduMessage.Builder>	serializableBuilderClass()
Boolean	silentPush() Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
String	smallImageIconUrl() The URL of the small icon image to display in the status bar and the content view of the push notification.
String	sound() The sound to play when the recipient receives the push notification.
Map<String,List<String>>	substitutions() The default message variables to use in the notification message.
Integer	timeToLive() The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline.
String	title() The title to display above the notification message on the recipient's device.
BaiduMessage.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL to open in the recipient's default mobile browser, if a recipient taps the push notification 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 final Action action()

The action to occur if the recipient taps the push notification. 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 the recipient taps the push notification. 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 final String actionAsString()

The action to occur if the recipient taps the push notification. 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 the recipient taps the push notification. 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 final String body()

The body of the notification message.

Returns:

The body of the notification message.

hasData

public final boolean hasData()

Returns true if the Data property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

data

public final Map<String,String> data()

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

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

You can use hasData() to see if a value was sent in this field.

Returns:

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

iconReference

public final String iconReference()

The icon image name of the asset saved in your app.

Returns:

The icon image name of the asset saved in your app.

imageIconUrl

public final String imageIconUrl()

The URL of the large icon image to display in the content view of the push notification.

Returns:

The URL of the large icon image to display in the content view of the push notification.

imageUrl

public final String imageUrl()

The URL of an image to display in the push notification.

Returns:

The URL of an image to display in the push notification.

rawContent

public final String rawContent()

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

Returns:

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

silentPush

public final Boolean silentPush()

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

Returns:

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

smallImageIconUrl

public final String smallImageIconUrl()

The URL of the small icon image to display in the status bar and the content view of the push notification.

Returns:

The URL of the small icon image to display in the status bar and the content view of the push notification.

sound

public final String sound()

The sound to play when the recipient receives the push notification. 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 the recipient receives the push notification. 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/.

hasSubstitutions

public final boolean hasSubstitutions()

Returns true if the Substitutions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

substitutions

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

The default message variables to use in the notification message. You can override the default variables with individual address variables.

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

You can use hasSubstitutions() to see if a value was sent in this field.

Returns:

The default message variables to use in the notification message. You can override the default variables with individual address variables.

timeToLive

public final Integer timeToLive()

The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

Returns:

The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

title

public final String title()

The title to display above the notification message on the recipient's device.

Returns:

The title to display above the notification message on the recipient's device.

url

public final String url()

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Returns:

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

toBuilder

public BaiduMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BaiduMessage.Builder,BaiduMessage>

builder

public static BaiduMessage.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo