fcm-rs 0.2.0

A Rust crate for easy interaction with Firebase Cloud Messaging API (V1).
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

//! Data models for FCM messages, requests, and responses.
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Represents an FCM message to be sent.
#[derive(Serialize, Deserialize, Debug)]
pub struct Message {
    /// Registration token of the target device or the topic name for subscription.
    pub token: Option<String>,
    /// Notification payload.
    pub notification: Option<Notification>,
    /// Custom data payload.
    pub data: Option<serde_json::Value>,
    // Add other FCM message fields as needed (e.g., condition, priority)
}

/// Represents a notification payload within an FCM message.
#[derive(Serialize, Deserialize, Debug)]
pub struct Notification {
    /// Title of the notification.
    pub title: Option<String>,
    /// Body text of the notification.
    pub body: Option<String>,
    // Add other notification fields (e.g., icon, click_action)
}

/// Represents a request to send an FCM message.
#[derive(Serialize, Debug)]
pub struct FcmSendRequest {
    /// The FCM message to send.
    pub message: Message,
    // Add other request parameters (e.g., validate_only: bool) if needed
}

/// Represents the result of a sent FCM message.
#[derive(Deserialize)]
#[serde(untagged)]
pub enum FcmSendResult {
    /// A successful response from FCM.
    Success(FcmSuccessResponse),
    /// An error response from FCM.
    Error(FcmErrorResponse),
}

/// Represents a successful response from the FCM API after sending a message.
#[derive(Deserialize, Debug)]
pub struct FcmSuccessResponse {
    /// Message ID if the message was successfully processed
    pub name: String,
}

/// Represents an error response from the FCM API after sending a message.
#[derive(Serialize, Deserialize, Debug)]
pub struct FcmErrorResponse {
    /// Error if the message was unsuccessfully processed.
    pub error: ErrorResponse,
}

/// Contains the details of an error response from FCM.
/// Visit the [FCM Documentation](https://firebase.google.com/docs/cloud-messaging/send-message#rest) for details on the possible errors the API can respond with.
#[derive(Serialize, Deserialize, Debug)]
pub struct ErrorResponse {
    /// The error code.
    pub code: usize,
    /// The error message.
    pub message: String,
    /// The error status
    pub status: String,
    /// Additional details about the error.
    pub details: Vec<Value>,
}