Skip to main content

FirebaseMessaging

Struct FirebaseMessaging 

Source
pub struct FirebaseMessaging { /* private fields */ }
Expand description

Client for interacting with Firebase Cloud Messaging.

Implementations§

Source§

impl FirebaseMessaging

Source

pub fn new(middleware: AuthMiddleware) -> Self

Creates a new FirebaseMessaging instance.

This is typically called via FirebaseApp::messaging().

Source

pub async fn send( &self, message: &Message, dry_run: bool, ) -> Result<String, MessagingError>

Sends a message to a specific target (token, topic, or condition).

§Arguments
  • message - The Message struct defining the payload and target.
  • dry_run - If true, the message will be validated but not sent.
Source

pub async fn send_each( &self, messages: &[Message], dry_run: bool, ) -> Result<BatchResponse, MessagingError>

Sends a batch of messages.

This uses the FCM batch endpoint to send up to 500 messages in a single HTTP request.

§Arguments
  • messages - A slice of Message structs.
  • dry_run - If true, the messages will be validated but not sent.
Source

pub async fn send_each_for_multicast( &self, message: &MulticastMessage, dry_run: bool, ) -> Result<BatchResponse, MessagingError>

Sends a multicast message to all specified tokens.

This is a wrapper around send_each that constructs individual messages for each token.

§Arguments
  • message - The MulticastMessage containing tokens and payload.
  • dry_run - If true, the messages will be validated but not sent.
Source

pub async fn subscribe_to_topic( &self, tokens: &[&str], topic: &str, ) -> Result<TopicManagementResponse, MessagingError>

Subscribes a list of tokens to a topic.

§Arguments
  • tokens - A list of device registration tokens.
  • topic - The name of the topic.
Source

pub async fn unsubscribe_from_topic( &self, tokens: &[&str], topic: &str, ) -> Result<TopicManagementResponse, MessagingError>

Unsubscribes a list of tokens from a topic.

§Arguments
  • tokens - A list of device registration tokens.
  • topic - The name of the topic.

Trait Implementations§

Source§

impl Clone for FirebaseMessaging

Source§

fn clone(&self) -> FirebaseMessaging

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more