Struct ApnsPushNotificationTemplate 

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

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) 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 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 message body to use in push notifications that are based on the message template.

media_url: Option<String>

The URL of an image or video to display in push notifications that are based on the message template.

raw_content: Option<String>

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

sound: Option<String>

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is 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 the 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 ApnsPushNotificationTemplate

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

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

The URL of an image or video to display in push notifications that are based on the message template.

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

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

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

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is 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 the 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 ApnsPushNotificationTemplate

pub fn builder() -> ApnsPushNotificationTemplateBuilder

Creates a new builder-style object to manufacture ApnsPushNotificationTemplate.

Trait Implementations

impl Clone for ApnsPushNotificationTemplate

fn clone(&self) -> ApnsPushNotificationTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApnsPushNotificationTemplate

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

Formats the value using the given formatter.

impl PartialEq for ApnsPushNotificationTemplate

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