Struct MessageBody

pub struct MessageBody { /* private fields */ }

A message body as described in https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#resource:-message.

For initialization, it requires a Receiver, which is either a token, a topic or a condition.

After initialization, fields can be set using the setter functions.

Example

use firebae_cm::{MessageBody, Notification, Receiver};

// Setup of message fields.
let receiver = Receiver::topic("subscribers");
let notification = Notification::new().with_title("Hello, ").with_body("world!");

// Create MessageBody and set the message name and notification.
let mut body = MesageBody::new(receiver);
body.name("Celebration")
    .notification(notification);

Implementations

impl MessageBody

pub fn new(receiver: Receiver) -> Self

Creates a new MessageBody using the supplied Receiver. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#resource:-message.

pub fn name(&mut self, name: impl Into<String>) -> &mut Self

Sets the name of the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#resource:-message.

pub fn data(&mut self, data: impl IntoFirebaseMap) -> Result<&mut Self, Error>

Sets the data of the message. Accepts any type that implements IntoFirebaseMap, which will construct the required Map<String, String>. For ease, you can use the crate::AsFirebaseMap derive macro on your structs:

use firebae_cm::{AsFirebaseMap, MessageBody, Receiver};
 
#[derive(AsFirebaseMap)]
struct MessageData {
    field1: String,
    field2: i32, // Note that this will become a String in Firebase
}
 
fn main() {
    let data = MessageData {
        field1: "Hello, world!".to_string(),
        field2: 5481,
    };
 
    let receiver = Receiver::topic("subscribers");
    let mut config = MessageBody::new(receiver);
    config.data(data).expect("Data not parsable");    
}

See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#resource:-message.

pub fn notification(&mut self, notification: Notification) -> &mut Self

Sets the notification of the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification.

pub fn android(&mut self, android: AndroidConfig) -> &mut Self

Sets the Android configuration for the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidconfig.

pub fn apns(&mut self, apns: ApnsConfig) -> &mut Self

Sets the Apple configuration for the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#apnsconfig.

pub fn webpush(&mut self, webpush: WebpushConfig) -> &mut Self

Sets the web configuration for the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushconfig.

pub fn fcm_options(&mut self, fcm_options: FcmOptions) -> &mut Self

Sets additional Firebase options for the message. See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#fcmoptions.

Trait Implementations

impl Debug for MessageBody

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

Formats the value using the given formatter.

impl Serialize for MessageBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.