NAME
Paws::Pinpoint::ADMMessage
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Pinpoint::ADMMessage object:
$service_obj->Method(Att1 => { Action => $value, ..., Url => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ADMMessage object:
$result = $service_obj->Method(...);
$result->Att1->ActionDESCRIPTION
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
ATTRIBUTES
Action => Str
The action to occur if the 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 action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Body => Str
The body of the notification message.
ConsolidationKey => Str
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
Data => Paws::Pinpoint::MapOf__string
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
ExpiresAfter => Str
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
IconReference => Str
The icon image name of the asset saved in your app.
ImageIconUrl => Str
The URL of the large icon image to display in the content view of the push notification.
ImageUrl => Str
The URL of an image to display in the push notification.
MD5 => Str
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
RawContent => Str
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
SilentPush => Bool
Specifies whether the 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 supporting phone home functionality.
SmallImageIconUrl => Str
The URL of the small icon image to display in the status bar and the content view of the push notification.
Sound => Str
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Substitutions => Paws::Pinpoint::MapOfListOf__string
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Title => Str
The title to display above the notification message on the recipient's device.
Url => Str
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Pinpoint
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues