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

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

withAction

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.

setAction

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

withAction

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.

withBody

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

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

withImageUrl

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

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.

clearSubstitutionsEntries

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

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.