fcm-service 0.2.3

A Rust library for sending Firebase Cloud Messaging (FCM) notifications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use std::{collections::HashMap, hash::RandomState};

use serde::{Deserialize, Serialize};

use super::{AndroidConfig, ApnsConfig, FcmNotification, FcmOptions, Target, WebpushConfig};

/// Represents an FCM message with all supported fields.
#[derive(Clone, Debug, Serialize, Deserialize, Default)]
pub struct FcmMessage {
    name: Option<String>,
    data: Option<HashMap<String, String>>,
    notification: Option<FcmNotification>,
    android: Option<AndroidConfig>,
    webpush: Option<WebpushConfig>,
    apns: Option<ApnsConfig>,
    fcm_options: Option<FcmOptions>,
    #[serde(flatten)]
    target: Target,
}

impl FcmMessage {
    /// Creates a new, empty `FcmMessage`.
    #[must_use]
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Sets the message name.
    pub fn set_name(&mut self, name: Option<String>) {
        self.name = name;
    }

    /// Sets custom data key-value pairs.
    pub fn set_data(&mut self, data: Option<HashMap<String, String>>) {
        self.data = data;
    }

    /// Sets the notification content.
    pub fn set_notification(&mut self, notification: Option<FcmNotification>) {
        self.notification = notification;
    }

    /// Sets Android-specific configuration.
    pub fn set_android(&mut self, android: Option<AndroidConfig>) {
        self.android = android;
    }

    /// Sets Webpush-specific configuration.
    pub fn set_webpush(&mut self, webpush: Option<WebpushConfig>) {
        self.webpush = webpush;
    }

    /// Sets APNs-specific configuration.
    pub fn set_apns(&mut self, apns: Option<ApnsConfig>) {
        self.apns = apns;
    }

    /// Sets FCM options.
    pub fn set_fcm_options(&mut self, fcm_options: Option<FcmOptions>) {
        self.fcm_options = fcm_options;
    }

    /// Sets the message target (token, topic, or condition).
    pub fn set_target(&mut self, target: Target) {
        self.target = target;
    }

    #[must_use]
    pub fn name(&self) -> Option<&String> {
        self.name.as_ref()
    }

    #[must_use]
    pub fn data(&self) -> Option<&HashMap<String, String, RandomState>> {
        self.data.as_ref()
    }

    #[must_use]
    pub fn notification(&self) -> Option<&FcmNotification> {
        self.notification.as_ref()
    }

    #[must_use]
    pub fn android(&self) -> Option<&AndroidConfig> {
        self.android.as_ref()
    }

    #[must_use]
    pub fn webpush(&self) -> Option<&WebpushConfig> {
        self.webpush.as_ref()
    }

    #[must_use]
    pub fn apns(&self) -> Option<&ApnsConfig> {
        self.apns.as_ref()
    }

    #[must_use]
    pub fn fcm_options(&self) -> Option<&FcmOptions> {
        self.fcm_options.as_ref()
    }

    #[must_use]
    pub fn target(&self) -> &Target {
        &self.target
    }
}