Skip to main content

MessagingClient

Struct MessagingClient 

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

Firebase Cloud Messaging client.

Unlike crate::auth::AuthClient, there is no unauthenticated emulator mode: every FCM v1 and Instance ID call requires a live OAuth2 bearer token. Build one with MessagingClientBuilder.

Implementations§

Source§

impl MessagingClient

Source

pub fn builder(project_id: impl Into<String>) -> MessagingClientBuilder

Starts building a new client for the given Firebase project.

Source

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

Sends a single message, returning FCM’s assigned message id.

When dry_run is true, the message is validated but not actually delivered (FCM v1’s validate_only).

Source

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

Sends up to MAX_BATCH_SIZE messages, returning a per-message success/failure result. Each message is sent as its own HTTP request, concurrently — mirroring the official Admin SDKs’ sendEach/sendEachForMulticast, which dispatch every request before awaiting any of them (Promise.allSettled) rather than serializing round-trips. A failure sending one message does not prevent the others from being sent.

Source

pub async fn send_each_for_multicast( &self, message_template: &Message, tokens: &[String], dry_run: bool, ) -> Result<BatchResponse, MessagingError>

Sends one message to up to MAX_BATCH_SIZE device registration tokens, individually. Equivalent to building one Message per token from a shared template and calling Self::send_each.

Source

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

Subscribes device registration tokens to a topic.

A single call can partially fail: see TopicManagementResponse.

Source

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

Unsubscribes device registration tokens from a topic.

A single call can partially fail: see TopicManagementResponse.

Source

pub fn legacy_http_transport_enabled(&self) -> bool

Whether Self::send_each/Self::send_each_for_multicast were configured (via MessagingClientBuilder::enable_legacy_http_transport) to send each message over its own HTTP/1.1 request instead of multiplexing over HTTP/2.

This crate’s HTTP client (reqwest over hyper) negotiates HTTP/2 automatically when the server supports it and otherwise falls back to HTTP/1.1, so this flag is a no-op today; it exists so callers migrating from the official Admin SDKs (where this setting works around a legacy Node.js HTTP/2 bug) have an equivalent method to call without their code failing to compile.

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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