com.amazonaws.services.pinpoint.model

Class DefaultPushNotificationMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.DefaultPushNotificationMessage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Default Push Notification Message.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultPushNotificationMessage()

Method Summary

Modifier and Type	Method and Description
DefaultPushNotificationMessage	addDataEntry(String key, String value)
DefaultPushNotificationMessage	addSubstitutionsEntry(String key, List<String> value)
DefaultPushNotificationMessage	clearDataEntries() Removes all the entries added into Data.
DefaultPushNotificationMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
DefaultPushNotificationMessage	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.
Map<String,String>	getData() The data payload used for a silent push.
Boolean	getSilentPush() Indicates if the message should display on the users 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 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	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 users 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, the email body or the text message.
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 users 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPushNotificationMessage

public DefaultPushNotificationMessage()

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

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

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

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

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 DefaultPushNotificationMessage addDataEntry(String key,
                                                   String value)

clearDataEntries

public DefaultPushNotificationMessage clearDataEntries()

Removes all the entries added into Data.

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

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.

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 DefaultPushNotificationMessage addSubstitutionsEntry(String key,
                                                            List<String> value)

clearSubstitutionsEntries

public DefaultPushNotificationMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

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