Struct aws_sdk_pinpoint::model::gcm_message::Builder

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

A builder for GcmMessage

Implementations

impl Builder

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

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

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

The body of the notification message.

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

The body of the notification message.

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

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

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

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

pub fn data(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to data.

To override the contents of this collection use set_data.

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

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

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

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

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

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

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

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

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

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

para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

high - The notification is sent immediately and might wake a sleeping device.

/para>

Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

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

para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

high - The notification is sent immediately and might wake a sleeping device.

/para>

Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

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

The package name of the application where registration tokens must match in order for the recipient to receive the message.

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

The package name of the application where registration tokens must match in order for the recipient to receive 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 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 or supporting phone home functionality.

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

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

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

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

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

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, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to substitutions.

To override the contents of this collection use set_substitutions.

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

pub fn set_substitutions(
    self,
    input: Option<HashMap<String, Vec<String>>>
) -> Self

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

pub fn time_to_live(self, input: i32) -> Self

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

pub fn set_time_to_live(self, input: Option<i32>) -> Self

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

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

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

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

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

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

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.

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

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.

pub fn build(self) -> GcmMessage

Consumes the builder and constructs a GcmMessage

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder