BaiduMessage (AWS Java SDK :: Services :: Amazon Pinpoint 2.6.2 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BaiduMessage.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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 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 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 String body()
```
    The body of the notification message.
    
    Returns:
    
    The body of the notification message.
  - data
```
public 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.
    
    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 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 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 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 String rawContent()
```
    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
    
    Returns:
    
    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
  - silentPush
```
public 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 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 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/.
  - substitutions
```
public 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.
    
    Returns:
    
    The default message variables to use in the notification message. You can override the default variables with individual address variables.
  - timeToLive
```
public 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 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 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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

Class BaiduMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

action

actionAsString

body

data

iconReference

imageIconUrl

imageUrl

rawContent

silentPush

smallImageIconUrl

sound

substitutions

timeToLive

title

url

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields