ADMMessage class

Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

Constructors

ADMMessage({Action? action, String? body, String? consolidationKey, Map<String, String>? data, String? expiresAfter, String? iconReference, String? imageIconUrl, String? imageUrl, String? md5, String? rawContent, bool? silentPush, String? smallImageIconUrl, String? sound, Map<String, List<String>>? substitutions, String? title, String? url})

Properties

action Action?
The action to occur if the recipient taps the push notification. Valid values are:
final
body String?
The body of the notification message.
final
consolidationKey String?
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.
final
data Map<String, 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.
final
expiresAfter String?
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.
final
hashCode int
The hash code for this object.
no setterinherited
iconReference String?
The icon image name of the asset saved in your app.
final
imageIconUrl String?
The URL of the large icon image to display in the content view of the push notification.
final
imageUrl String?
The URL of an image to display in the push notification.
final
md5 String?
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.
final
rawContent String?
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.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
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.
final
smallImageIconUrl String?
The URL of the small icon image to display in the status bar and the content view of the push notification.
final
sound String?
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/.
final
substitutions Map<String, List<String>>?
The default message variables to use in the notification message. You can override the default variables with individual address variables.
final
title String?
The title to display above the notification message on the recipient's device.
final
url String?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited