pub struct NotificationClient { /* private fields */ }
Expand description

A client specialized for handling push notifications received over the network, for an app.

In particular, it takes care of running a full decryption sync, in case the event in the notification was impossible to decrypt beforehand.

Implementations§

source§

impl NotificationClient

source

pub async fn new( parent_client: Client, process_setup: NotificationProcessSetup, ) -> Result<Self, Error>

Create a new notification client.

source

pub async fn get_notification( &self, room_id: &RoomId, event_id: &EventId, ) -> Result<Option<NotificationItem>, Error>

Fetches the content of a notification.

This will first try to get the notification using a short-lived sliding sync, and if the sliding-sync can’t find the event, then it’ll use a /context query to find the event with associated member information.

An error result means that we couldn’t resolve the notification; in that case, a dummy notification may be displayed instead. A None result means the notification has been filtered out by the user’s push rules.

source

pub async fn get_notification_with_sliding_sync( &self, room_id: &RoomId, event_id: &EventId, ) -> Result<NotificationStatus, Error>

Get a full notification, given a room id and event id.

This will run a small sliding sync to retrieve the content of the event, along with extra data to form a rich notification context.

source

pub async fn get_notification_with_context( &self, room_id: &RoomId, event_id: &EventId, ) -> Result<Option<NotificationItem>, Error>

Retrieve a notification using a /context query.

This is for clients that are already running other sliding syncs in the same process, so that most of the contextual information for the notification should already be there. In particular, the room containing the event MUST be known (via a sliding sync for invites, or another sliding sync).

An error result means that we couldn’t resolve the notification; in that case, a dummy notification may be displayed instead. A None result means the notification has been filtered out by the user’s push rules.

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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
source§

impl<T> Any for T
where T: Any,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,