trixnity-client/net.folivo.trixnity.client/MatrixClientImpl

MatrixClientImpl

class MatrixClientImpl : MatrixClient

Properties

api

open override val api: MatrixClientServerApiClient

Use this for further access to matrix client-server-API.

avatarUrl

open override val avatarUrl: StateFlow<String?>

baseUrl

open override val baseUrl: Url

deviceId

open override val deviceId: String

open override val di: Koin

displayName

open override val displayName: StateFlow<String?>

identityKey

open override val identityKey: Key.Curve25519Key

initialSyncDone

open override val initialSyncDone: StateFlow<Boolean>

key

val MatrixClient.key: KeyService

loginState

open override val loginState: StateFlow<MatrixClient.LoginState?>

media

val MatrixClient.media: MediaService

notification

val MatrixClient.notification: NotificationService

room

val MatrixClient.room: RoomService

roomEventEncryptionServices

val MatrixClient.roomEventEncryptionServices: List<RoomEventEncryptionService>

signingKey

open override val signingKey: Key.Ed25519Key

syncState

open override val syncState: StateFlow<SyncState>

user

val MatrixClient.user: UserService

userId

open override val userId: UserId

verification

val MatrixClient.verification: VerificationService

Functions

cancelSync

open suspend override fun cancelSync(wait: Boolean)

clearCache

open suspend override fun clearCache(): Result<Unit>

Be aware, that most StateFlows you got before will not be updated after calling this method.

clearMediaCache

open suspend override fun clearMediaCache(): Result<Unit>

logout

open suspend override fun logout(): Result<Unit>

setAvatarUrl

open suspend override fun setAvatarUrl(avatarUrl: String?): Result<Unit>

setDisplayName

open suspend override fun setDisplayName(displayName: String?): Result<Unit>

startSync

open suspend override fun startSync(presence: Presence?)

stop

open suspend override fun stop(wait: Boolean)

Stop the MatrixClient and its CoroutineScope. It should be called to clean up all resources used by MatrixClient (including databases).

stopSync

open suspend override fun stopSync(wait: Boolean)

syncOnce

open suspend override fun syncOnce(presence: Presence?, timeout: Duration): Result<Unit>

open suspend override fun <T> syncOnce(presence: Presence?, timeout: Duration, runOnce: suspend (Sync.Response) -> T): Result<T>

Usually used for background sync.