GCMMessage (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class GCMMessage
extends java.lang.Object
implements java.io.Serializable
```
GCM Message.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GCMMessage()

Constructors
Constructor and Description
`GCMMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GCMMessage`	`addDataEntry(java.lang.String key, java.lang.String value)` The data payload used for a silent push.
`GCMMessage`	`addSubstitutionsEntry(java.lang.String key, java.util.List<java.lang.String> value)` Default message substitutions.
`GCMMessage`	`clearDataEntries()` Removes all the entries added into Data.
`GCMMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`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 of the notification.
`java.lang.String`	`getCollapseKey()` This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed.
`java.util.Map<java.lang.String,java.lang.String>`	`getData()` The data payload used for a silent push.
`java.lang.String`	`getIconReference()` The icon image name of the asset saved in your application.
`java.lang.String`	`getImageIconUrl()` The URL that points to an image used as the large icon to the notification content view.
`java.lang.String`	`getImageUrl()` The URL that points to an image used in the push notification.
`java.lang.String`	`getPriority()` The message priority.
`java.lang.String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`java.lang.String`	`getRestrictedPackageName()` This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
`java.lang.Boolean`	`getSilentPush()` Indicates if the message should display on the users device.
`java.lang.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
`java.lang.String`	`getSound()` Indicates a sound to play when the device receives the notification.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSubstitutions()` Default message substitutions.
`java.lang.Integer`	`getTimeToLive()` The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message.
`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 of the notification.
`void`	`setCollapseKey(java.lang.String collapseKey)` This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed.
`void`	`setData(java.util.Map<java.lang.String,java.lang.String> data)` The data payload used for a silent push.
`void`	`setIconReference(java.lang.String iconReference)` The icon image name of the asset saved in your application.
`void`	`setImageIconUrl(java.lang.String imageIconUrl)` The URL that points to an image used as the large icon to the notification content view.
`void`	`setImageUrl(java.lang.String imageUrl)` The URL that points to an image used in the push notification.
`void`	`setPriority(java.lang.String priority)` The message priority.
`void`	`setRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setRestrictedPackageName(java.lang.String restrictedPackageName)` This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
`void`	`setSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`void`	`setSmallImageIconUrl(java.lang.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(java.lang.String sound)` Indicates a sound to play when the device receives the notification.
`void`	`setSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)` Default message substitutions.
`void`	`setTimeToLive(java.lang.Integer timeToLive)` The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message.
`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.
`GCMMessage`	`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.
`GCMMessage`	`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.
`GCMMessage`	`withBody(java.lang.String body)` The message body of the notification.
`GCMMessage`	`withCollapseKey(java.lang.String collapseKey)` This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed.
`GCMMessage`	`withData(java.util.Map<java.lang.String,java.lang.String> data)` The data payload used for a silent push.
`GCMMessage`	`withIconReference(java.lang.String iconReference)` The icon image name of the asset saved in your application.
`GCMMessage`	`withImageIconUrl(java.lang.String imageIconUrl)` The URL that points to an image used as the large icon to the notification content view.
`GCMMessage`	`withImageUrl(java.lang.String imageUrl)` The URL that points to an image used in the push notification.
`GCMMessage`	`withPriority(java.lang.String priority)` The message priority.
`GCMMessage`	`withRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`GCMMessage`	`withRestrictedPackageName(java.lang.String restrictedPackageName)` This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
`GCMMessage`	`withSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`GCMMessage`	`withSmallImageIconUrl(java.lang.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
`GCMMessage`	`withSound(java.lang.String sound)` Indicates a sound to play when the device receives the notification.
`GCMMessage`	`withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)` Default message substitutions.
`GCMMessage`	`withTimeToLive(java.lang.Integer timeToLive)` The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message.
`GCMMessage`	`withTitle(java.lang.String title)` The message title that displays above the message on the user's device.
`GCMMessage`	`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
  - GCMMessage
```
public GCMMessage()
```
- 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. Possible values include: OPEN_APP | DEEP_LINK | URL
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - withAction
```
public GCMMessage 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. Possible values include: OPEN_APP | DEEP_LINK | URL
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - withAction
```
public GCMMessage 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
    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. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    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 of the notification.
    
    Returns:
    
    The message body of the notification.
  - setBody
```
public void setBody(java.lang.String body)
```
    The message body of the notification.
    
    Parameters:
    
    body - The message body of the notification.
  - withBody
```
public GCMMessage withBody(java.lang.String body)
```
    The message body of the notification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    body - The message body of the notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCollapseKey
```
public java.lang.String getCollapseKey()
```
    This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
    
    Returns:
    
    This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
  - setCollapseKey
```
public void setCollapseKey(java.lang.String collapseKey)
```
    This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
    
    Parameters:
    
    collapseKey - This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
  - withCollapseKey
```
public GCMMessage withCollapseKey(java.lang.String collapseKey)
```
    This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    collapseKey - This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getData
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 GCMMessage withData(java.util.Map<java.lang.String,java.lang.String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addDataEntry
```
public GCMMessage addDataEntry(java.lang.String key,
                               java.lang.String value)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    The method adds a new key-value pair into Data parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Data.
    
    value - The corresponding value of the entry to be added into Data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearDataEntries
```
public GCMMessage clearDataEntries()
```
    Removes all the entries added into Data.
    Returns a reference to this object so that method calls can be chained together.
  - getIconReference
```
public java.lang.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.
  - setIconReference
```
public void setIconReference(java.lang.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.
  - withIconReference
```
public GCMMessage withIconReference(java.lang.String iconReference)
```
    The icon image name of the asset saved in your application.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    iconReference - The icon image name of the asset saved in your application.
    
    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 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.
  - setImageIconUrl
```
public void setImageIconUrl(java.lang.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.
  - withImageIconUrl
```
public GCMMessage withImageIconUrl(java.lang.String imageIconUrl)
```
    The URL that points to an image used as the large icon to the notification content view.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    imageIconUrl - The URL that points to an image used as the large icon to the notification content view.
    
    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 GCMMessage 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.
  - getPriority
```
public java.lang.String getPriority()
```
    The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
    
    Returns:
    
    The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
  - setPriority
```
public void setPriority(java.lang.String priority)
```
    The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
    
    Parameters:
    
    priority - The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
  - withPriority
```
public GCMMessage withPriority(java.lang.String priority)
```
    The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    priority - The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
    
    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 GCMMessage 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.
  - getRestrictedPackageName
```
public java.lang.String getRestrictedPackageName()
```
    This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
    
    Returns:
    
    This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
  - setRestrictedPackageName
```
public void setRestrictedPackageName(java.lang.String restrictedPackageName)
```
    This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
    
    Parameters:
    
    restrictedPackageName - This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
  - withRestrictedPackageName
```
public GCMMessage withRestrictedPackageName(java.lang.String restrictedPackageName)
```
    This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    restrictedPackageName - This parameter specifies the package name of the application where the registration tokens must match in order to receive 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 GCMMessage 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.
  - getSmallImageIconUrl
```
public java.lang.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
  - setSmallImageIconUrl
```
public void setSmallImageIconUrl(java.lang.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
  - withSmallImageIconUrl
```
public GCMMessage withSmallImageIconUrl(java.lang.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
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSound
```
public java.lang.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/
  - setSound
```
public void setSound(java.lang.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/
  - withSound
```
public GCMMessage withSound(java.lang.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/
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubstitutions
```
public java.util.Map<java.lang.String,java.util.List<java.lang.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(java.util.Map<java.lang.String,java.util.List<java.lang.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 GCMMessage withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public GCMMessage addSubstitutionsEntry(java.lang.String key,
                                        java.util.List<java.lang.String> value)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    The method adds a new key-value pair into Substitutions parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Substitutions.
    
    value - The corresponding value of the entry to be added into Substitutions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearSubstitutionsEntries
```
public GCMMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    Returns a reference to this object so that method calls can be chained together.
  - getTimeToLive
```
public java.lang.Integer getTimeToLive()
```
    The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
    
    Returns:
    
    The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
  - setTimeToLive
```
public void setTimeToLive(java.lang.Integer timeToLive)
```
    The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
    
    Parameters:
    
    timeToLive - The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
  - withTimeToLive
```
public GCMMessage withTimeToLive(java.lang.Integer timeToLive)
```
    The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    timeToLive - The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
    
    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 GCMMessage 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 GCMMessage 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 GCMMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GCMMessage

Method Detail

getAction

setAction

withAction

setAction

withAction

getBody

setBody

withBody

getCollapseKey

setCollapseKey

withCollapseKey

getData

setData

withData

addDataEntry

clearDataEntries

getIconReference

setIconReference

withIconReference

getImageIconUrl

setImageIconUrl

withImageIconUrl

getImageUrl

setImageUrl

withImageUrl

getPriority

setPriority

withPriority

getRawContent

setRawContent

withRawContent

getRestrictedPackageName

setRestrictedPackageName

withRestrictedPackageName

isSilentPush

getSilentPush

setSilentPush

withSilentPush

getSmallImageIconUrl

setSmallImageIconUrl

withSmallImageIconUrl

getSound

setSound

withSound

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

getTimeToLive

setTimeToLive

withTimeToLive

getTitle

setTitle

withTitle

getUrl

setUrl

withUrl

toString

hashCode

equals