Message (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class Message
extends java.lang.Object
implements java.io.Serializable
```
Message to send

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Message()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.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.
`java.lang.String`	`getBody()` The message body.
`java.lang.String`	`getImageIconUrl()` The URL that points to the icon image for the push notification icon, for example, the app icon.
`java.lang.String`	`getImageSmallIconUrl()` The URL that points to the small icon image for the push notification icon, for example, the app icon.
`java.lang.String`	`getImageUrl()` The URL that points to an image used in the push notification.
`java.lang.String`	`getJsonBody()` The JSON payload used for a silent push.
`java.lang.String`	`getMediaUrl()` A URL that refers to the location of an image or video that you want to display in the push notification.
`java.lang.String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`java.lang.Boolean`	`getSilentPush()` Indicates if the message should display on the users device.
`java.lang.Integer`	`getTimeToLive()` This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time.
`java.lang.String`	`getTitle()` The message title that displays above the message on the user's device.
`java.lang.String`	`getUrl()` The URL to open in the user's mobile browser.
`int`	`hashCode()`
`java.lang.Boolean`	`isSilentPush()` Indicates if the message should display on the users device.
`void`	`setAction(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.
`void`	`setAction(java.lang.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(java.lang.String body)` The message body.
`void`	`setImageIconUrl(java.lang.String imageIconUrl)` The URL that points to the icon image for the push notification icon, for example, the app icon.
`void`	`setImageSmallIconUrl(java.lang.String imageSmallIconUrl)` The URL that points to the small icon image for the push notification icon, for example, the app icon.
`void`	`setImageUrl(java.lang.String imageUrl)` The URL that points to an image used in the push notification.
`void`	`setJsonBody(java.lang.String jsonBody)` The JSON payload used for a silent push.
`void`	`setMediaUrl(java.lang.String mediaUrl)` A URL that refers to the location of an image or video that you want to display in the push notification.
`void`	`setRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`void`	`setTimeToLive(java.lang.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.
`void`	`setTitle(java.lang.String title)` The message title that displays above the message on the user's device.
`void`	`setUrl(java.lang.String url)` The URL to open in the user's mobile browser.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Message`	`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.
`Message`	`withAction(java.lang.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.
`Message`	`withBody(java.lang.String body)` The message body.
`Message`	`withImageIconUrl(java.lang.String imageIconUrl)` The URL that points to the icon image for the push notification icon, for example, the app icon.
`Message`	`withImageSmallIconUrl(java.lang.String imageSmallIconUrl)` The URL that points to the small icon image for the push notification icon, for example, the app icon.
`Message`	`withImageUrl(java.lang.String imageUrl)` The URL that points to an image used in the push notification.
`Message`	`withJsonBody(java.lang.String jsonBody)` The JSON payload used for a silent push.
`Message`	`withMediaUrl(java.lang.String mediaUrl)` A URL that refers to the location of an image or video that you want to display in the push notification.
`Message`	`withRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`Message`	`withSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`Message`	`withTimeToLive(java.lang.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.
`Message`	`withTitle(java.lang.String title)` The message title that displays above the message on the user's device.
`Message`	`withUrl(java.lang.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
  - Message
```
public Message()
```
- Method Detail
  - getAction
```
public java.lang.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.
    Constraints:
    Allowed Values: 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.
    
    See Also:
    
    Action
  - setAction
```
public void setAction(java.lang.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.
    Constraints:
    Allowed Values: 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.
    
    See Also:
    
    Action
  - withAction
```
public Message withAction(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Action
  - setAction
```
public void setAction(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.
    Constraints:
    Allowed Values: 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.
    
    See Also:
    
    Action
  - withAction
```
public Message 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Action
  - getBody
```
public java.lang.String getBody()
```
    The message body. Can include up to 140 characters.
    
    Returns:
    
    The message body. Can include up to 140 characters.
  - setBody
```
public void setBody(java.lang.String body)
```
    The message body. Can include up to 140 characters.
    
    Parameters:
    
    body - The message body. Can include up to 140 characters.
  - withBody
```
public Message withBody(java.lang.String body)
```
    The message body. Can include up to 140 characters.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    body - The message body. Can include up to 140 characters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getImageIconUrl
```
public java.lang.String getImageIconUrl()
```
    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.
  - setImageIconUrl
```
public void setImageIconUrl(java.lang.String imageIconUrl)
```
    The URL that points to the icon image for the push notification icon, for example, the app icon.
    
    Parameters:
    
    imageIconUrl - The URL that points to the icon image for the push notification icon, for example, the app icon.
  - withImageIconUrl
```
public Message withImageIconUrl(java.lang.String imageIconUrl)
```
    The URL that points to the icon image for the push notification icon, for example, the app icon.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    imageIconUrl - The URL that points to the icon image for the push notification icon, for example, the app icon.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getImageSmallIconUrl
```
public java.lang.String getImageSmallIconUrl()
```
    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.
  - setImageSmallIconUrl
```
public void setImageSmallIconUrl(java.lang.String imageSmallIconUrl)
```
    The URL that points to the small icon image for the push notification icon, for example, the app icon.
    
    Parameters:
    
    imageSmallIconUrl - The URL that points to the small icon image for the push notification icon, for example, the app icon.
  - withImageSmallIconUrl
```
public Message withImageSmallIconUrl(java.lang.String imageSmallIconUrl)
```
    The URL that points to the small icon image for the push notification icon, for example, the app icon.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    imageSmallIconUrl - The URL that points to the small icon image for the push notification icon, for example, the app icon.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getImageUrl
```
public java.lang.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.
  - setImageUrl
```
public void setImageUrl(java.lang.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.
  - withImageUrl
```
public Message withImageUrl(java.lang.String imageUrl)
```
    The URL that points to an image used in the push notification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    imageUrl - The URL that points to an image used in the push notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJsonBody
```
public java.lang.String getJsonBody()
```
    The JSON payload used for a silent push.
    
    Returns:
    
    The JSON payload used for a silent push.
  - setJsonBody
```
public void setJsonBody(java.lang.String jsonBody)
```
    The JSON payload used for a silent push.
    
    Parameters:
    
    jsonBody - The JSON payload used for a silent push.
  - withJsonBody
```
public Message withJsonBody(java.lang.String jsonBody)
```
    The JSON payload used for a silent push.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    jsonBody - The JSON payload used for a silent push.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMediaUrl
```
public java.lang.String getMediaUrl()
```
    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.
  - setMediaUrl
```
public void setMediaUrl(java.lang.String mediaUrl)
```
    A URL that refers to the location of an image or video that you want to display in the push notification.
    
    Parameters:
    
    mediaUrl - A URL that refers to the location of an image or video that you want to display in the push notification.
  - withMediaUrl
```
public Message withMediaUrl(java.lang.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 reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mediaUrl - A URL that refers to the location of an image or video that you want to display in the push notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRawContent
```
public java.lang.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.
  - setRawContent
```
public void setRawContent(java.lang.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.
  - withRawContent
```
public Message withRawContent(java.lang.String rawContent)
```
    The Raw JSON formatted string to be used as the payload. This value overrides the message.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isSilentPush
```
public java.lang.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.
  - getSilentPush
```
public java.lang.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.
  - setSilentPush
```
public void setSilentPush(java.lang.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.
  - withSilentPush
```
public Message withSilentPush(java.lang.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 a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimeToLive
```
public java.lang.Integer getTimeToLive()
```
    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
  - setTimeToLive
```
public void setTimeToLive(java.lang.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
    
    Parameters:
    
    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
  - withTimeToLive
```
public Message withTimeToLive(java.lang.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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTitle
```
public java.lang.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.
  - setTitle
```
public void setTitle(java.lang.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.
  - withTitle
```
public Message withTitle(java.lang.String title)
```
    The message title that displays above the message on the user's device.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    title - The message title that displays above the message on the user's device.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUrl
```
public java.lang.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.
  - setUrl
```
public void setUrl(java.lang.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.
  - withUrl
```
public Message withUrl(java.lang.String url)
```
    The URL to open in the user's mobile browser. Used if the value for Action is URL.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    url - The URL to open in the user's mobile browser. Used if the value for Action is URL.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

getAction

setAction

withAction

setAction

withAction

getBody

setBody

withBody

getImageIconUrl

setImageIconUrl

withImageIconUrl

getImageSmallIconUrl

setImageSmallIconUrl

withImageSmallIconUrl

getImageUrl

setImageUrl

withImageUrl

getJsonBody

setJsonBody

withJsonBody

getMediaUrl

setMediaUrl

withMediaUrl

getRawContent

setRawContent

withRawContent

isSilentPush

getSilentPush

setSilentPush

withSilentPush

getTimeToLive

setTimeToLive

withTimeToLive

getTitle

setTitle

withTitle

getUrl

setUrl

withUrl

toString

hashCode

equals