Struct RoomListService 

pub struct RoomListService { /* private fields */ }

The RoomListService type. See the module’s documentation to learn more.

Implementations

impl RoomListService

pub async fn new(client: Client) -> Result<Self, Error>

Create a new RoomList.

A matrix_sdk::SlidingSync client will be created, with a cached list already pre-configured.

This won’t start an encryption sync, and it’s the user’s responsibility to create one in this case using EncryptionSyncService.

pub async fn new_with_share_pos( client: Client, share_pos: bool, ) -> Result<Self, Error>

Like RoomListService::new but with a flag to turn the SlidingSyncBuilder::share_pos on and off.

pub fn sync_indicator( &self, delay_before_showing: Duration, delay_before_hiding: Duration, ) -> impl Stream<Item = SyncIndicator> + use<>

Get a Stream of SyncIndicator.

Read the documentation of SyncIndicator to learn more about it.

pub fn client(&self) -> &Client

Get the Client that has been used to create Self.

pub fn state(&self) -> Subscriber<State>

Get a subscriber to the state.

pub async fn all_rooms(&self) -> Result<RoomList, Error>

Get a RoomList for all rooms.

pub fn room(&self, room_id: &RoomId) -> Result<Room, Error>

Get a Room if it exists.

pub async fn subscribe_to_rooms(&self, room_ids: &[&RoomId])

Subscribe to rooms.

It means that all events from these rooms will be received every time, no matter how the RoomList is configured.

LatestEvents::listen_to_room will be called for each room in room_ids, so that the LatestEventValue will automatically be calculated and updated for these rooms, for free.

All previous room subscriptions will be forgotten.

Trait Implementations

impl Debug for RoomListService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.