Struct MessageBuilder 

#[non_exhaustive]
pub struct MessageBuilder { /* private fields */ }

A builder for Message.

Implementations

impl MessageBuilder

pub fn action(self, input: Action) -> Self

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 set_action(self, input: Option<Action>) -> Self

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 get_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, input: impl Into<String>) -> Self

The body of the notification message. The maximum number of characters is 200.

pub fn set_body(self, input: Option<String>) -> Self

The body of the notification message. The maximum number of characters is 200.

pub fn get_body(&self) -> &Option<String>

The body of the notification message. The maximum number of characters is 200.

pub fn image_icon_url(self, input: impl Into<String>) -> Self

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

pub fn set_image_icon_url(self, input: Option<String>) -> Self

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

pub fn get_image_icon_url(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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 set_image_small_icon_url(self, input: Option<String>) -> Self

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 get_image_small_icon_url(&self) -> &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.

pub fn image_url(self, input: impl Into<String>) -> Self

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

pub fn set_image_url(self, input: Option<String>) -> Self

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

pub fn get_image_url(&self) -> &Option<String>

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

pub fn json_body(self, input: impl Into<String>) -> Self

The JSON payload to use for a silent push notification.

pub fn set_json_body(self, input: Option<String>) -> Self

The JSON payload to use for a silent push notification.

pub fn get_json_body(&self) -> &Option<String>

The JSON payload to use for a silent push notification.

pub fn media_url(self, input: impl Into<String>) -> Self

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

pub fn set_media_url(self, input: Option<String>) -> Self

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

pub fn get_media_url(&self) -> &Option<String>

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

pub fn raw_content(self, input: impl Into<String>) -> Self

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 set_raw_content(self, input: Option<String>) -> Self

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 get_raw_content(&self) -> &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.

pub fn silent_push(self, input: bool) -> Self

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 set_silent_push(self, input: Option<bool>) -> Self

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 get_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, input: i32) -> Self

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 set_time_to_live(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_title(self, input: Option<String>) -> Self

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

pub fn get_title(&self) -> &Option<String>

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

pub fn url(self, input: impl Into<String>) -> Self

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.

pub fn set_url(self, input: Option<String>) -> Self

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.

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

pub fn build(self) -> Message

Consumes the builder and constructs a Message.

Trait Implementations

impl Clone for MessageBuilder

fn clone(&self) -> MessageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBuilder

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

Formats the value using the given formatter.

impl Default for MessageBuilder

fn default() -> MessageBuilder

Returns the “default value” for a type.

impl PartialEq for MessageBuilder

fn eq(&self, other: &MessageBuilder) -> 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 MessageBuilder