Struct PushApnsMessageTemplateContent 

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

The content of the push message template that applies to APNS (Apple Push Notification service) notification service.

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.

title: Option<String>

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

body: Option<MessageTemplateBodyContentProvider>

The message body to use in a push notification that is based on the message template.

action: Option<PushMessageAction>

The action to occur if a recipient taps a push notification that is 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 action 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.

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.

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.

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<MessageTemplateBodyContentProvider>

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

Implementations

impl PushApnsMessageTemplateContent

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

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

pub fn body(&self) -> Option<&MessageTemplateBodyContentProvider>

The message body to use in a push notification that is based on the message template.

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

The action to occur if a recipient taps a push notification that is 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 action 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 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 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.

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<&MessageTemplateBodyContentProvider>

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

impl PushApnsMessageTemplateContent

pub fn builder() -> PushApnsMessageTemplateContentBuilder

Creates a new builder-style object to manufacture PushApnsMessageTemplateContent.

Trait Implementations

impl Clone for PushApnsMessageTemplateContent

fn clone(&self) -> PushApnsMessageTemplateContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PushApnsMessageTemplateContent

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

Formats the value using the given formatter.

impl PartialEq for PushApnsMessageTemplateContent

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