Struct PushFcmMessageTemplateContent 

#[non_exhaustive]
pub struct PushFcmMessageTemplateContent {
    pub title: Option<String>,
    pub body: Option<MessageTemplateBodyContentProvider>,
    pub action: Option<PushMessageAction>,
    pub sound: Option<String>,
    pub url: Option<String>,
    pub image_url: Option<String>,
    pub image_icon_url: Option<String>,
    pub small_image_icon_url: Option<String>,
    pub raw_content: Option<MessageTemplateBodyContentProvider>,
}

The content of the push message template that applies to FCM (Firebase Cloud Messaging) 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 Android 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 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/.

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.

image_url: Option<String>

The URL of an image to display in a push notification that's based on the message template.

image_icon_url: Option<String>

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

small_image_icon_url: Option<String>

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

raw_content: Option<MessageTemplateBodyContentProvider>

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

Implementations

impl PushFcmMessageTemplateContent

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 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 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/.

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 image_url(&self) -> Option<&str>

The URL of an image to display in a push notification that's based on the message template.

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

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

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

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

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

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

impl PushFcmMessageTemplateContent

pub fn builder() -> PushFcmMessageTemplateContentBuilder

Creates a new builder-style object to manufacture PushFcmMessageTemplateContent.

Trait Implementations

impl Clone for PushFcmMessageTemplateContent

fn clone(&self) -> PushFcmMessageTemplateContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PushFcmMessageTemplateContent

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

Formats the value using the given formatter.

impl PartialEq for PushFcmMessageTemplateContent

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