Struct Message 

#[non_exhaustive]
pub struct Message {
    pub action: Option<Action>,
    pub body: Option<String>,
    pub image_icon_url: Option<String>,
    pub image_small_icon_url: Option<String>,
    pub image_url: Option<String>,
    pub json_body: Option<String>,
    pub media_url: Option<String>,
    pub raw_content: Option<String>,
    pub silent_push: Option<bool>,
    pub time_to_live: Option<i32>,
    pub title: Option<String>,
    pub url: Option<String>,
}

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

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 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 iOS and Android.

• 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. The maximum number of characters is 200.

image_icon_url: Option<String>

The URL of the image to display as the push-notification icon, such as the icon for the app.

image_small_icon_url: Option<String>

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

image_url: Option<String>

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

json_body: Option<String>

The JSON payload to use for a silent push notification.

media_url: Option<String>

The URL of the image or video to display in the push notification.

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: Option<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, displaying messages in an in-app message center, or supporting phone home functionality.

time_to_live: Option<i32>

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

title: Option<String>

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

url: Option<String>

The 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.

Implementations

impl Message

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

The 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 iOS and Android.

• 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. The maximum number of characters is 200.

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

The URL of the image to display as the push-notification icon, such as the icon for the app.

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

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

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

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

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

The JSON payload to use for a silent push notification.

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

The URL of the image or video to display in the push notification.

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) -> Option<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, displaying messages in an in-app message center, or supporting phone home functionality.

pub fn time_to_live(&self) -> Option<i32>

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

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

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

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

The 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.

impl Message

pub fn builder() -> MessageBuilder

Creates a new builder-style object to manufacture Message.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq for Message

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Message