GCMMessage (AWS SDK for Java - 2.0.0-preview-1)

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.GCMMessage

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<GCMMessage.Builder,GCMMessage>

@Generated("software.amazon.awssdk:codegen")
public class GCMMessage
extends Object
implements StructuredPojo, ToCopyableBuilder<GCMMessage.Builder,GCMMessage>

GCM Message.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GCMMessage.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`String`	`body()`	The message body of the notification, the email body or the text message.
`static GCMMessage.Builder`	`builder()`
`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.
`Map<String,String>`	`data()`	The data payload used for a silent push.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`iconReference()`	The icon image name of the asset saved in your application.
`String`	`imageIconUrl()`	The URL that points to an image used as the large icon to the notification content view.
`String`	`imageUrl()`	The URL that points to an image used in the push notification.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`rawContent()`	The Raw JSON formatted string to be used as the payload.
`String`	`restrictedPackageName()`	This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
`static Class<? extends GCMMessage.Builder>`	`serializableBuilderClass()`
`Boolean`	`silentPush()`	Indicates if the message should display on the users device.
`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
`String`	`sound()`	Indicates a sound to play when the device receives the notification.
`Map<String,List<String>>`	`substitutions()`	Default message substitutions.
`String`	`title()`	The message title that displays above the message on the user's device.
`GCMMessage.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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

- Method Detail
  - action
```
public 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:
    
    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
  - body
```
public String body()
```
    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.
  - collapseKey
```
public 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:
    
    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.
  - data
```
public Map<String,String> data()
```
    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
  - iconReference
```
public String iconReference()
```
    The icon image name of the asset saved in your application.
    
    Returns:
    
    The icon image name of the asset saved in your application.
  - imageIconUrl
```
public String imageIconUrl()
```
    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.
  - imageUrl
```
public String imageUrl()
```
    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.
  - rawContent
```
public String rawContent()
```
    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.
  - restrictedPackageName
```
public String restrictedPackageName()
```
    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.
  - silentPush
```
public 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:
    
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - smallImageIconUrl
```
public 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:
    
    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
  - sound
```
public 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:
    
    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/
  - substitutions
```
public Map<String,List<String>> substitutions()
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Default message substitutions. Can be overridden by individual address substitutions.
  - title
```
public String title()
```
    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.
  - url
```
public String url()
```
    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.
  - toBuilder
```
public GCMMessage.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GCMMessage.Builder,GCMMessage>
    
    Returns:
    
    a builder for type T
  - builder
```
public static GCMMessage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GCMMessage.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class GCMMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

action

body

collapseKey

data

iconReference

imageIconUrl

imageUrl

rawContent

restrictedPackageName

silentPush

smallImageIconUrl

sound

substitutions

title

url

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall