Class DefaultPushNotificationMessage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DefaultPushNotificationMessage.Builder,
DefaultPushNotificationMessage>
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Action
action()
The default action to occur if a recipient taps the push notification.final String
The default action to occur if a recipient taps the push notification.final String
body()
The default body of the notification message.builder()
data()
The JSON data payload to use for the default push notification, if the notification is a silent push notification.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasData()
For responses, this returns true if the service returned a value for the Data property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Substitutions property.static Class
<? extends DefaultPushNotificationMessage.Builder> final Boolean
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.The default message variables to use in the notification message.final String
title()
The default title to display above the notification message on a recipient's device.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
If the service returns an enum value that is not available in the current SDK version,
action
will returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- 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.
-
- See Also:
-
-
actionAsString
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.
If the service returns an enum value that is not available in the current SDK version,
action
will returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- 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.
-
- See Also:
-
-
body
The default body of the notification message.
- Returns:
- The default body of the notification message.
-
hasData
public final boolean hasData()For responses, this returns true if the service returned a value for the Data property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasData()
method.- Returns:
- 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.
-
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.
- Returns:
- 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.
-
hasSubstitutions
public final boolean hasSubstitutions()For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
substitutions
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubstitutions()
method.- Returns:
- The default message variables to use in the notification message. You can override the default variables with individual address variables.
-
title
The default title to display above the notification message on a recipient's device.
- Returns:
- The default title to display above the notification message on a recipient's device.
-
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.
- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DefaultPushNotificationMessage.Builder,
DefaultPushNotificationMessage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-