Struct NotificationClient

pub struct NotificationClient { /* private fields */ }

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

impl NotificationClient

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

Create a new notification client.

pub fn get_room(&self, room_id: &RoomId) -> Option<Room>

Fetches a room by its ID using the in-memory state store backed client. Useful to retrieve room information after running the limited notification client sliding sync loop.

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.

pub async fn get_notifications( &self, requests: &[NotificationItemsRequest], ) -> Result<BatchNotificationFetchingResult<NotificationItem>, Error>

Fetches the content of several notifications.

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

An error result at the top level means that something failed when trying to set up the notification fetching. For each notification item you can also receive an error, which means something failed when trying to fetch that particular notification (decryption, fetching push actions, etc.); 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.

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

pub async fn get_notifications_with_sliding_sync( &self, requests: &[NotificationItemsRequest], ) -> Result<BatchNotificationFetchingResult<NotificationStatus>, Error>

Get a list of full notifications, given a room id and event ids.

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

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.