com.amazonaws.services.pinpoint.model

Class DefaultPushNotificationMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.DefaultPushNotificationMessage

All Implemented Interfaces:

Serializable

public class DefaultPushNotificationMessage
extends Object
implements Serializable

Default Push Notification Message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultPushNotificationMessage()

Method Summary

Modifier and Type	Method and Description
DefaultPushNotificationMessage	addDataEntry(String key, String value) The data payload used for a silent push.
DefaultPushNotificationMessage	addSubstitutionsEntry(String key, List<String> value) Default message substitutions.
DefaultPushNotificationMessage	clearDataEntries() Removes all the entries added into Data.
DefaultPushNotificationMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
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.
Map<String,String>	getData() The data payload used for a silent push.
Boolean	getSilentPush() Indicates if the message should display on the recipient's device.
Map<String,List<String>>	getSubstitutions() Default message substitutions.
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 recipient's 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(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.
void	setData(Map<String,String> data) The data payload used for a silent push.
void	setSilentPush(Boolean silentPush) Indicates if the message should display on the recipient's device.
void	setSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.
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.
DefaultPushNotificationMessage	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.
DefaultPushNotificationMessage	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.
DefaultPushNotificationMessage	withBody(String body) The message body of the notification.
DefaultPushNotificationMessage	withData(Map<String,String> data) The data payload used for a silent push.
DefaultPushNotificationMessage	withSilentPush(Boolean silentPush) Indicates if the message should display on the recipient's device.
DefaultPushNotificationMessage	withSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.
DefaultPushNotificationMessage	withTitle(String title) The message title that displays above the message on the user's device.
DefaultPushNotificationMessage	withUrl(String url) The URL to open in the user's mobile browser.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPushNotificationMessage

public DefaultPushNotificationMessage()

Method Detail

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

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(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 DefaultPushNotificationMessage 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

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 DefaultPushNotificationMessage 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 String getBody()

The message body of the notification.

Returns:

The message body of the notification.

setBody

public void setBody(String body)

The message body of the notification.

Parameters:

body - The message body of the notification.

withBody

public DefaultPushNotificationMessage withBody(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.

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 DefaultPushNotificationMessage withData(Map<String,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 DefaultPushNotificationMessage addDataEntry(String key,
                                                   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 DefaultPushNotificationMessage clearDataEntries()

Removes all the entries added into Data.

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 recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

Returns:

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

getSilentPush

public Boolean getSilentPush()

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

Returns:

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

setSilentPush

public void setSilentPush(Boolean silentPush)

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

Parameters:

silentPush - Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

withSilentPush

public DefaultPushNotificationMessage withSilentPush(Boolean silentPush)

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

Returns a reference to this object so that method calls can be chained together.

Parameters:

silentPush - Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

Returns:

A reference to this updated 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 DefaultPushNotificationMessage withSubstitutions(Map<String,List<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 DefaultPushNotificationMessage addSubstitutionsEntry(String key,
                                                            List<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 DefaultPushNotificationMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns a reference to this object so that method calls can be chained together.

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.

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.

withTitle

public DefaultPushNotificationMessage withTitle(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 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(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 DefaultPushNotificationMessage withUrl(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 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object