Struct DefaultPushNotificationTemplate 

#[non_exhaustive]
pub struct DefaultPushNotificationTemplate {
    pub action: Option<Action>,
    pub body: Option<String>,
    pub sound: Option<String>,
    pub title: Option<String>,
    pub url: Option<String>,
}

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification 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 a recipient taps a push notification that's based on the message template. 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 the iOS and Android platforms.

• 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 message body to use in push notifications that are based on the message template.

sound: Option<String>

The sound to play when a recipient receives a push notification that's based on the message template. 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/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

title: Option<String>

The title to use in push notifications that are based on the message template. This title appears 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 a push notification that's based on the message template and the value of the Action property is URL.

Implementations

impl DefaultPushNotificationTemplate

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

The action to occur if a recipient taps a push notification that's based on the message template. 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 the iOS and Android platforms.

• 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 message body to use in push notifications that are based on the message template.

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

The sound to play when a recipient receives a push notification that's based on the message template. 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/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

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

The title to use in push notifications that are based on the message template. This title appears 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 a push notification that's based on the message template and the value of the Action property is URL.

impl DefaultPushNotificationTemplate

pub fn builder() -> DefaultPushNotificationTemplateBuilder

Creates a new builder-style object to manufacture DefaultPushNotificationTemplate.

Trait Implementations

impl Clone for DefaultPushNotificationTemplate

fn clone(&self) -> DefaultPushNotificationTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultPushNotificationTemplate

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

Formats the value using the given formatter.

impl PartialEq for DefaultPushNotificationTemplate

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