BaiduMessage (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.BaiduMessage

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BaiduMessage
extends Object
implements Serializable, Cloneable, StructuredPojo

Baidu Message.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BaiduMessage()

Constructors
Constructor and Description
`BaiduMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaiduMessage`	`addDataEntry(String key, String value)`
`BaiduMessage`	`addSubstitutionsEntry(String key, List<String> value)`
`BaiduMessage`	`clearDataEntries()` Removes all the entries added into Data.
`BaiduMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`BaiduMessage`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` 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`	`getBody()` The message body of the notification, the email body or the text message.
`Map<String,String>`	`getData()` The data payload used for a silent push.
`String`	`getIconReference()` The icon image name of the asset saved in your application.
`String`	`getImageIconUrl()` The URL that points to an image used as the large icon to the notification content view.
`String`	`getImageUrl()` The URL that points to an image used in the push notification.
`String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`Boolean`	`getSilentPush()` Indicates if the message should display on the users device.
`String`	`getSmallImageIconUrl()` The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
`String`	`getSound()` Indicates a sound to play when the device receives the notification.
`Map<String,List<String>>`	`getSubstitutions()` Default message substitutions.
`String`	`getTitle()` The message title that displays above the message on the user's device.
`String`	`getUrl()` The URL to open in the user's mobile browser.
`int`	`hashCode()`
`Boolean`	`isSilentPush()` Indicates if the message should display on the users device.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(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.
`void`	`setBody(String body)` The message body of the notification, the email body or the text message.
`void`	`setData(Map<String,String> data)` The data payload used for a silent push.
`void`	`setIconReference(String iconReference)` The icon image name of the asset saved in your application.
`void`	`setImageIconUrl(String imageIconUrl)` The URL that points to an image used as the large icon to the notification content view.
`void`	`setImageUrl(String imageUrl)` The URL that points to an image used in the push notification.
`void`	`setRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setSilentPush(Boolean silentPush)` Indicates if the message should display on the users device.
`void`	`setSmallImageIconUrl(String smallImageIconUrl)` The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
`void`	`setSound(String sound)` Indicates a sound to play when the device receives the notification.
`void`	`setSubstitutions(Map<String,List<String>> substitutions)` Default message substitutions.
`void`	`setTitle(String title)` The message title that displays above the message on the user's device.
`void`	`setUrl(String url)` The URL to open in the user's mobile browser.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BaiduMessage`	`withAction(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.
`BaiduMessage`	`withAction(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.
`BaiduMessage`	`withBody(String body)` The message body of the notification, the email body or the text message.
`BaiduMessage`	`withData(Map<String,String> data)` The data payload used for a silent push.
`BaiduMessage`	`withIconReference(String iconReference)` The icon image name of the asset saved in your application.
`BaiduMessage`	`withImageIconUrl(String imageIconUrl)` The URL that points to an image used as the large icon to the notification content view.
`BaiduMessage`	`withImageUrl(String imageUrl)` The URL that points to an image used in the push notification.
`BaiduMessage`	`withRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`BaiduMessage`	`withSilentPush(Boolean silentPush)` Indicates if the message should display on the users device.
`BaiduMessage`	`withSmallImageIconUrl(String smallImageIconUrl)` The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
`BaiduMessage`	`withSound(String sound)` Indicates a sound to play when the device receives the notification.
`BaiduMessage`	`withSubstitutions(Map<String,List<String>> substitutions)` Default message substitutions.
`BaiduMessage`	`withTitle(String title)` The message title that displays above the message on the user's device.
`BaiduMessage`	`withUrl(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

- Constructor Detail
  - BaiduMessage
```
public BaiduMessage()
```
- Method Detail
  - setAction
```
public void setAction(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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - getAction
```
public String getAction()
```
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - withAction
```
public BaiduMessage withAction(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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - withAction
```
public BaiduMessage withAction(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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - setBody
```
public void setBody(String body)
```
    The message body of the notification, the email body or the text message.
    
    Parameters:
    
    body - The message body of the notification, the email body or the text message.
  - getBody
```
public String getBody()
```
    The message body of the notification, the email body or the text message.
    
    Returns:
    
    The message body of the notification, the email body or the text message.
  - withBody
```
public BaiduMessage withBody(String body)
```
    The message body of the notification, the email body or the text message.
    
    Parameters:
    
    body - The message body of the notification, the email body or the text message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getData
```
public Map<String,String> getData()
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  - setData
```
public void setData(Map<String,String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  - withData
```
public BaiduMessage withData(Map<String,String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDataEntry
```
public BaiduMessage addDataEntry(String key,
                                 String value)
```
  - clearDataEntries
```
public BaiduMessage clearDataEntries()
```
    Removes all the entries added into Data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIconReference
```
public void setIconReference(String iconReference)
```
    The icon image name of the asset saved in your application.
    
    Parameters:
    
    iconReference - The icon image name of the asset saved in your application.
  - getIconReference
```
public String getIconReference()
```
    The icon image name of the asset saved in your application.
    
    Returns:
    
    The icon image name of the asset saved in your application.
  - withIconReference
```
public BaiduMessage withIconReference(String iconReference)
```
    The icon image name of the asset saved in your application.
    
    Parameters:
    
    iconReference - The icon image name of the asset saved in your application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageIconUrl
```
public void setImageIconUrl(String imageIconUrl)
```
    The URL that points to an image used as the large icon to the notification content view.
    
    Parameters:
    
    imageIconUrl - The URL that points to an image used as the large icon to the notification content view.
  - getImageIconUrl
```
public String getImageIconUrl()
```
    The URL that points to an image used as the large icon to the notification content view.
    
    Returns:
    
    The URL that points to an image used as the large icon to the notification content view.
  - withImageIconUrl
```
public BaiduMessage withImageIconUrl(String imageIconUrl)
```
    The URL that points to an image used as the large icon to the notification content view.
    
    Parameters:
    
    imageIconUrl - The URL that points to an image used as the large icon to the notification content view.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageUrl
```
public void setImageUrl(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.
  - getImageUrl
```
public String getImageUrl()
```
    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.
  - withImageUrl
```
public BaiduMessage withImageUrl(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.
  - setRawContent
```
public void setRawContent(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.
  - getRawContent
```
public String getRawContent()
```
    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.
  - withRawContent
```
public BaiduMessage withRawContent(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.
  - setSilentPush
```
public void setSilentPush(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.
  - getSilentPush
```
public Boolean getSilentPush()
```
    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.
  - withSilentPush
```
public BaiduMessage withSilentPush(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.
  - isSilentPush
```
public Boolean isSilentPush()
```
    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.
  - setSmallImageIconUrl
```
public void setSmallImageIconUrl(String smallImageIconUrl)
```
    The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    
    Parameters:
    
    smallImageIconUrl - The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  - getSmallImageIconUrl
```
public String getSmallImageIconUrl()
```
    The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    
    Returns:
    
    The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  - withSmallImageIconUrl
```
public BaiduMessage withSmallImageIconUrl(String smallImageIconUrl)
```
    The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    
    Parameters:
    
    smallImageIconUrl - The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSound
```
public void setSound(String sound)
```
    Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    
    Parameters:
    
    sound - Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
  - getSound
```
public String getSound()
```
    Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    
    Returns:
    
    Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
  - withSound
```
public BaiduMessage withSound(String sound)
```
    Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    
    Parameters:
    
    sound - Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubstitutions
```
public Map<String,List<String>> getSubstitutions()
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Default message substitutions. Can be overridden by individual address substitutions.
  - setSubstitutions
```
public void setSubstitutions(Map<String,List<String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
  - withSubstitutions
```
public BaiduMessage withSubstitutions(Map<String,List<String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public BaiduMessage addSubstitutionsEntry(String key,
                                          List<String> value)
```
  - clearSubstitutionsEntries
```
public BaiduMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(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.
  - getTitle
```
public String getTitle()
```
    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.
  - withTitle
```
public BaiduMessage withTitle(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.
  - setUrl
```
public void setUrl(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.
  - getUrl
```
public String getUrl()
```
    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.
  - withUrl
```
public BaiduMessage withUrl(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BaiduMessage clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BaiduMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaiduMessage

Method Detail

setAction

getAction

withAction

withAction

setBody

getBody

withBody

getData

setData

withData

addDataEntry

clearDataEntries

setIconReference

getIconReference

withIconReference

setImageIconUrl

getImageIconUrl

withImageIconUrl

setImageUrl

getImageUrl

withImageUrl

setRawContent

getRawContent

withRawContent

setSilentPush

getSilentPush

withSilentPush

isSilentPush

setSmallImageIconUrl

getSmallImageIconUrl

withSmallImageIconUrl

setSound

getSound

withSound

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setTitle

getTitle

withTitle

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall