@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DefaultPushNotificationMessage extends Object implements Serializable, Cloneable, StructuredPojo
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
Constructor and Description |
---|
DefaultPushNotificationMessage() |
Modifier and Type | Method and Description |
---|---|
DefaultPushNotificationMessage |
addDataEntry(String key,
String value)
Add a single Data entry
|
DefaultPushNotificationMessage |
addSubstitutionsEntry(String key,
List<String> value)
Add a single Substitutions entry
|
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 default action to occur if a recipient taps the push notification.
|
String |
getBody()
The default body of the notification message.
|
Map<String,String> |
getData()
The JSON data payload to use for the default push notification, if the notification is a silent push
notification.
|
Boolean |
getSilentPush()
Specifies whether the default notification is a silent push notification, which is a push notification that
doesn't display on a recipient's device.
|
Map<String,List<String>> |
getSubstitutions()
The default message variables to use in the notification message.
|
String |
getTitle()
The default title to display above the notification message on a recipient's device.
|
String |
getUrl()
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and
the value of the Action property is URL.
|
int |
hashCode() |
Boolean |
isSilentPush()
Specifies whether the default notification is a silent push notification, which is a push notification that
doesn't display on a recipient's device.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAction(Action action)
The default action to occur if a recipient taps the push notification.
|
void |
setAction(String action)
The default action to occur if a recipient taps the push notification.
|
void |
setBody(String body)
The default body of the notification message.
|
void |
setData(Map<String,String> data)
The JSON data payload to use for the default push notification, if the notification is a silent push
notification.
|
void |
setSilentPush(Boolean silentPush)
Specifies whether the default notification is a silent push notification, which is a push notification that
doesn't display on a recipient's device.
|
void |
setSubstitutions(Map<String,List<String>> substitutions)
The default message variables to use in the notification message.
|
void |
setTitle(String title)
The default title to display above the notification message on a recipient's device.
|
void |
setUrl(String url)
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and
the value of the Action property is URL.
|
String |
toString()
Returns a string representation of this object.
|
DefaultPushNotificationMessage |
withAction(Action action)
The default action to occur if a recipient taps the push notification.
|
DefaultPushNotificationMessage |
withAction(String action)
The default action to occur if a recipient taps the push notification.
|
DefaultPushNotificationMessage |
withBody(String body)
The default body of the notification message.
|
DefaultPushNotificationMessage |
withData(Map<String,String> data)
The JSON data payload to use for the default push notification, if the notification is a silent push
notification.
|
DefaultPushNotificationMessage |
withSilentPush(Boolean silentPush)
Specifies whether the default notification is a silent push notification, which is a push notification that
doesn't display on a recipient's device.
|
DefaultPushNotificationMessage |
withSubstitutions(Map<String,List<String>> substitutions)
The default message variables to use in the notification message.
|
DefaultPushNotificationMessage |
withTitle(String title)
The default title to display above the notification message on a recipient's device.
|
DefaultPushNotificationMessage |
withUrl(String url)
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and
the value of the Action property is URL.
|
public void setAction(String action)
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
action
- The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Action
public String getAction()
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Action
public DefaultPushNotificationMessage withAction(String action)
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
action
- The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Action
public void setAction(Action action)
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
action
- The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Action
public DefaultPushNotificationMessage withAction(Action action)
The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
action
- The default action to occur if a recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Action
public void setBody(String body)
The default body of the notification message.
body
- The default body of the notification message.public String getBody()
The default body of the notification message.
public DefaultPushNotificationMessage withBody(String body)
The default body of the notification message.
body
- The default body of the notification message.public Map<String,String> getData()
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
public void setData(Map<String,String> data)
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
data
- The JSON data payload to use for the default push notification, if the notification is a silent push
notification. This payload is added to the data.pinpoint.jsonBody object of the notification.public DefaultPushNotificationMessage withData(Map<String,String> data)
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
data
- The JSON data payload to use for the default push notification, if the notification is a silent push
notification. This payload is added to the data.pinpoint.jsonBody object of the notification.public DefaultPushNotificationMessage addDataEntry(String key, String value)
public DefaultPushNotificationMessage clearDataEntries()
public void setSilentPush(Boolean silentPush)
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
silentPush
- Specifies whether the default notification is a silent push notification, which is a push notification
that doesn't display on a recipient's device. Silent push notifications can be used for cases such as
updating an app's configuration or delivering messages to an in-app notification center.public Boolean getSilentPush()
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
public DefaultPushNotificationMessage withSilentPush(Boolean silentPush)
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
silentPush
- Specifies whether the default notification is a silent push notification, which is a push notification
that doesn't display on a recipient's device. Silent push notifications can be used for cases such as
updating an app's configuration or delivering messages to an in-app notification center.public Boolean isSilentPush()
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
public Map<String,List<String>> getSubstitutions()
The default message variables to use in the notification message. You can override the default variables with individual address variables.
public void setSubstitutions(Map<String,List<String>> substitutions)
The default message variables to use in the notification message. You can override the default variables with individual address variables.
substitutions
- The default message variables to use in the notification message. You can override the default variables
with individual address variables.public DefaultPushNotificationMessage withSubstitutions(Map<String,List<String>> substitutions)
The default message variables to use in the notification message. You can override the default variables with individual address variables.
substitutions
- The default message variables to use in the notification message. You can override the default variables
with individual address variables.public DefaultPushNotificationMessage addSubstitutionsEntry(String key, List<String> value)
public DefaultPushNotificationMessage clearSubstitutionsEntries()
public void setTitle(String title)
The default title to display above the notification message on a recipient's device.
title
- The default title to display above the notification message on a recipient's device.public String getTitle()
The default title to display above the notification message on a recipient's device.
public DefaultPushNotificationMessage withTitle(String title)
The default title to display above the notification message on a recipient's device.
title
- The default title to display above the notification message on a recipient's device.public void setUrl(String url)
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
url
- The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification
and the value of the Action property is URL.public String getUrl()
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
public DefaultPushNotificationMessage withUrl(String url)
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
url
- The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification
and the value of the Action property is URL.public String toString()
toString
in class Object
Object.toString()
public DefaultPushNotificationMessage clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.