com.amazonaws.services.pinpoint.model

Class Message

java.lang.Object

com.amazonaws.services.pinpoint.model.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
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.
String	getImageIconUrl() The URL that points to the icon image for the push notification icon, for example, the app icon.
String	getImageUrl() The URL that points to an image used in the push notification.
String	getJsonBody() The JSON payload used for a silent push.
String	getMediaUrl() The URL that points to the media resource, for example a .mp4 or .gif file.
Boolean	getSilentPush() Indicates if the message should display on the users device.
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	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.
void	setImageIconUrl(String imageIconUrl) The URL that points to the icon image for the push notification icon, for example, the app icon.
void	setImageUrl(String imageUrl) The URL that points to an image used in the push notification.
void	setJsonBody(String jsonBody) The JSON payload used for a silent push.
void	setMediaUrl(String mediaUrl) The URL that points to the media resource, for example a .mp4 or .gif file.
void	setSilentPush(Boolean silentPush) Indicates if the message should display on the users device.
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.
Message	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.
Message	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.
Message	withBody(String body) The message body.
Message	withImageIconUrl(String imageIconUrl) The URL that points to the icon image for the push notification icon, for example, the app icon.
Message	withImageUrl(String imageUrl) The URL that points to an image used in the push notification.
Message	withJsonBody(String jsonBody) The JSON payload used for a silent push.
Message	withMediaUrl(String mediaUrl) The URL that points to the media resource, for example a .mp4 or .gif file.
Message	withSilentPush(Boolean silentPush) Indicates if the message should display on the users device.
Message	withTitle(String title) The message title that displays above the message on the user's device.
Message	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

Message

public Message()

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.

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.

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.

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.

See Also:

Action

withAction

public Message 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.

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.

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.

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.

See Also:

Action

withAction

public Message 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.

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.

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. Can include up to 140 characters.

Returns:

The message body. Can include up to 140 characters.

setBody

public void setBody(String body)

The message body. Can include up to 140 characters.

Parameters:

body - The message body. Can include up to 140 characters.

withBody

public Message withBody(String body)

The message body. Can include up to 140 characters.

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

Parameters:

body - The message body. Can include up to 140 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getImageIconUrl

public String getImageIconUrl()

The URL that points to the icon image for the push notification icon, for example, the app icon.

Returns:

The URL that points to the icon image for the push notification icon, for example, the app icon.

setImageIconUrl

public void setImageIconUrl(String imageIconUrl)

The URL that points to the icon image for the push notification icon, for example, the app icon.

Parameters:

imageIconUrl - The URL that points to the icon image for the push notification icon, for example, the app icon.

withImageIconUrl

public Message withImageIconUrl(String imageIconUrl)

The URL that points to the icon image for the push notification icon, for example, the app icon.

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

Parameters:

imageIconUrl - The URL that points to the icon image for the push notification icon, for example, the app icon.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withImageUrl

public Message withImageUrl(String imageUrl)

The URL that points to an image used in the push notification.

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.

getJsonBody

public String getJsonBody()

The JSON payload used for a silent push.

Returns:

The JSON payload used for a silent push.

setJsonBody

public void setJsonBody(String jsonBody)

The JSON payload used for a silent push.

Parameters:

jsonBody - The JSON payload used for a silent push.

withJsonBody

public Message withJsonBody(String jsonBody)

The JSON payload used for a silent push.

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

Parameters:

jsonBody - The JSON payload used for a silent push.

Returns:

A reference to this updated object so that method calls can be chained together.

getMediaUrl

public String getMediaUrl()

The URL that points to the media resource, for example a .mp4 or .gif file.

Returns:

The URL that points to the media resource, for example a .mp4 or .gif file.

setMediaUrl

public void setMediaUrl(String mediaUrl)

The URL that points to the media resource, for example a .mp4 or .gif file.

Parameters:

mediaUrl - The URL that points to the media resource, for example a .mp4 or .gif file.

withMediaUrl

public Message withMediaUrl(String mediaUrl)

The URL that points to the media resource, for example a .mp4 or .gif file.

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

Parameters:

mediaUrl - The URL that points to the media resource, for example a .mp4 or .gif file.

Returns:

A reference to this updated 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.

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.

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.

withSilentPush

public Message 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.

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

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:

A reference to this updated 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 Message 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 Message 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