Struct SyncService

pub struct SyncService { /* private fields */ }

Implementations

impl SyncService

pub fn builder(client: Client) -> SyncServiceBuilder

Create a new builder for configuring an SyncService.

pub fn room_list_service(&self) -> Arc<RoomListService>

Get the underlying RoomListService instance for easier access to its methods.

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

Returns the state of the sync service.

pub async fn start(&self)

Start (or restart) the underlying sliding syncs.

This can be called multiple times safely:

• if the stream is still properly running, it won’t be restarted.
• if the stream has been aborted before, it will be properly cleaned up and restarted.

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

Stop the underlying sliding syncs.

This must be called when the app goes into the background. It’s better to call this API when the application exits, although not strictly necessary.

pub fn try_get_encryption_sync_permit( &self, ) -> Option<OwnedMutexGuard<EncryptionSyncPermit>>

Attempt to get a permit to use an EncryptionSyncService at a given time.

This ensures there is at most one EncryptionSyncService active at any time, per application.