GCMMessage (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

GCM Message.

See Also:: AWS API Documentation, 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(String key, String value)`
`GCMMessage`	`addSubstitutionsEntry(String key, List<String> value)`
`GCMMessage`	`clearDataEntries()` Removes all the entries added into Data.
`GCMMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`GCMMessage`	`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.
`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.
`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`	`getPriority()` Is this a transaction priority message or lower priority.
`String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`String`	`getRestrictedPackageName()` This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
`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.
`Integer`	`getTimeToLive()` This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
`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(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(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`	`setCollapseKey(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(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`	`setPriority(String priority)` Is this a transaction priority message or lower priority.
`void`	`setRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setRestrictedPackageName(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(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`	`setTimeToLive(Integer timeToLive)` This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
`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.
`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(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(String body)` The message body of the notification, the email body or the text message.
`GCMMessage`	`withCollapseKey(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(Map<String,String> data)` The data payload used for a silent push.
`GCMMessage`	`withIconReference(String iconReference)` The icon image name of the asset saved in your application.
`GCMMessage`	`withImageIconUrl(String imageIconUrl)` The URL that points to an image used as the large icon to the notification content view.
`GCMMessage`	`withImageUrl(String imageUrl)` The URL that points to an image used in the push notification.
`GCMMessage`	`withPriority(String priority)` Is this a transaction priority message or lower priority.
`GCMMessage`	`withRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`GCMMessage`	`withRestrictedPackageName(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(Boolean silentPush)` Indicates if the message should display on the users device.
`GCMMessage`	`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
`GCMMessage`	`withSound(String sound)` Indicates a sound to play when the device receives the notification.
`GCMMessage`	`withSubstitutions(Map<String,List<String>> substitutions)` Default message substitutions.
`GCMMessage`	`withTimeToLive(Integer timeToLive)` This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline.
`GCMMessage`	`withTitle(String title)` The message title that displays above the message on the user's device.
`GCMMessage`	`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
  - GCMMessage
```
public GCMMessage()
```
- 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 GCMMessage 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
  - 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
    
    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
    
    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 GCMMessage 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.
  - setCollapseKey
```
public void setCollapseKey(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.
  - getCollapseKey
```
public 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.
  - withCollapseKey
```
public GCMMessage withCollapseKey(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.
    
    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 GCMMessage 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 GCMMessage addDataEntry(String key,
                               String value)
```
  - clearDataEntries
```
public GCMMessage 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 GCMMessage 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 GCMMessage 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 GCMMessage 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.
  - setPriority
```
public void setPriority(String priority)
```
    Is this a transaction priority message or lower priority.
    
    Parameters:
    
    priority - Is this a transaction priority message or lower priority.
  - getPriority
```
public String getPriority()
```
    Is this a transaction priority message or lower priority.
    
    Returns:
    
    Is this a transaction priority message or lower priority.
  - withPriority
```
public GCMMessage withPriority(String priority)
```
    Is this a transaction priority message or lower priority.
    
    Parameters:
    
    priority - Is this a transaction priority message or lower priority.
    
    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 GCMMessage 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.
  - setRestrictedPackageName
```
public void setRestrictedPackageName(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.
  - getRestrictedPackageName
```
public 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.
  - withRestrictedPackageName
```
public GCMMessage withRestrictedPackageName(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.
    
    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 GCMMessage 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 GCMMessage 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 GCMMessage 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 GCMMessage 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 GCMMessage addSubstitutionsEntry(String key,
                                        List<String> value)
```
  - clearSubstitutionsEntries
```
public GCMMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeToLive
```
public void setTimeToLive(Integer timeToLive)
```
    This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
    
    Parameters:
    
    timeToLive - This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
  - getTimeToLive
```
public Integer getTimeToLive()
```
    This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
    
    Returns:
    
    This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
  - withTimeToLive
```
public GCMMessage withTimeToLive(Integer timeToLive)
```
    This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
    
    Parameters:
    
    timeToLive - This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.
    
    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 GCMMessage 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 GCMMessage 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 GCMMessage 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 GCMMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GCMMessage

Method Detail

setAction

getAction

withAction

setAction

withAction

setBody

getBody

withBody

setCollapseKey

getCollapseKey

withCollapseKey

getData

setData

withData

addDataEntry

clearDataEntries

setIconReference

getIconReference

withIconReference

setImageIconUrl

getImageIconUrl

withImageIconUrl

setImageUrl

getImageUrl

withImageUrl

setPriority

getPriority

withPriority

setRawContent

getRawContent

withRawContent

setRestrictedPackageName

getRestrictedPackageName

withRestrictedPackageName

setSilentPush

getSilentPush

withSilentPush

isSilentPush

setSmallImageIconUrl

getSmallImageIconUrl

withSmallImageIconUrl

setSound

getSound

withSound

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setTimeToLive

getTimeToLive

withTimeToLive

setTitle

getTitle

withTitle

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall