Struct aws_sdk_pinpoint::model::AdmMessage

#[non_exhaustive]
pub struct AdmMessage {

    pub action: Option<Action>,
    pub body: Option<String>,
    pub consolidation_key: Option<String>,
    pub data: Option<HashMap<String, String>>,
    pub expires_after: Option<String>,
    pub icon_reference: Option<String>,
    pub image_icon_url: Option<String>,
    pub image_url: Option<String>,
    pub md5: Option<String>,
    pub raw_content: Option<String>,
    pub silent_push: bool,
    pub small_image_icon_url: Option<String>,
    pub sound: Option<String>,
    pub substitutions: Option<HashMap<String, Vec<String>>>,
    pub title: Option<String>,
    pub url: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action: Option<Action>

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: Option<String>

The body of the notification message.

consolidation_key: Option<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.

data: Option<HashMap<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.

expires_after: Option<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.

icon_reference: Option<String>

The icon image name of the asset saved in your app.

image_icon_url: Option<String>

The URL of the large icon image to display in the content view of the push notification.

image_url: Option<String>

The URL of an image to display in the push notification.

md5: Option<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.

raw_content: Option<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.

silent_push: 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.

small_image_icon_url: Option<String>

The URL of the small icon image to display in the status bar and the content view of the push notification.

sound: Option<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/.

substitutions: Option<HashMap<String, Vec<String>>>

The default message variables to use in the notification message. You can override the default variables with individual address variables.

title: Option<String>

The title to display above the notification message on the recipient's device.

url: Option<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.

Implementations

impl AdmMessage

pub fn action(&self) -> Option<&Action>

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.

pub fn body(&self) -> Option<&str>

The body of the notification message.

pub fn consolidation_key(&self) -> Option<&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.

pub fn data(&self) -> Option<&HashMap<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.

pub fn expires_after(&self) -> Option<&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.

pub fn icon_reference(&self) -> Option<&str>

The icon image name of the asset saved in your app.

pub fn image_icon_url(&self) -> Option<&str>

The URL of the large icon image to display in the content view of the push notification.

pub fn image_url(&self) -> Option<&str>

The URL of an image to display in the push notification.

pub fn md5(&self) -> Option<&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.

pub fn raw_content(&self) -> Option<&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.

pub fn silent_push(&self) -> 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.

pub fn small_image_icon_url(&self) -> Option<&str>

The URL of the small icon image to display in the status bar and the content view of the push notification.

pub fn sound(&self) -> Option<&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/.

pub fn substitutions(&self) -> Option<&HashMap<String, Vec<String>>>

The default message variables to use in the notification message. You can override the default variables with individual address variables.

pub fn title(&self) -> Option<&str>

The title to display above the notification message on the recipient's device.

pub fn url(&self) -> Option<&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.

impl AdmMessage

pub fn builder() -> Builder

Creates a new builder-style object to manufacture AdmMessage

Trait Implementations

impl Clone for AdmMessage

fn clone(&self) -> AdmMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AdmMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<AdmMessage> for AdmMessage

fn eq(&self, other: &AdmMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AdmMessage) -> bool

This method tests for !=.

impl StructuralPartialEq for AdmMessage