trixnity-client/de.connect2x.trixnity.client/MatrixClient

MatrixClient

interface MatrixClient : AutoCloseable

Inheritors

MatrixClientImpl

Types

object Companion

enum LoginState : Enum<MatrixClient.LoginState>

Properties

abstract val api: MatrixClientServerApiClient

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

abstract val baseUrl: Url

abstract val deviceId: String

abstract val di: Koin

abstract val identityKey: Key.Curve25519Key

initialSyncDone

abstract val initialSyncDone: StateFlow<Boolean>

val MatrixClient.key: KeyService

abstract val loginState: StateFlow<MatrixClient.LoginState?>

val MatrixClient.media: MediaService

val MatrixClient.notification: NotificationService

abstract val profile: StateFlow<Profile?>

val MatrixClient.room: RoomService

roomEventEncryptionServices

val MatrixClient.roomEventEncryptionServices: List<RoomEventEncryptionService>

abstract val serverData: StateFlow<ServerData?>

abstract val signingKey: Key.Ed25519Key

abstract val started: StateFlow<Boolean>

abstract val syncState: StateFlow<SyncState>

val MatrixClient.user: UserService

abstract val userId: UserId

val MatrixClient.verification: VerificationService

Functions

abstract suspend fun cancelSync()

abstract suspend fun clearCache(): Result<Unit>

clearMediaCache

abstract suspend fun clearMediaCache(): Result<Unit>

expect abstract fun close()

closeSuspending

abstract suspend fun closeSuspending()

abstract suspend fun logout(): Result<Unit>

setProfileField

abstract suspend fun setProfileField(profileField: ProfileField): Result<Unit>

abstract suspend fun startSync(presence: Presence? = Presence.ONLINE)

abstract suspend fun stopSync()

abstract suspend fun syncOnce(presence: Presence? = Presence.OFFLINE, timeout: Duration = Duration.ZERO): Result<Unit>

abstract suspend fun <T> syncOnce(presence: Presence? = Presence.OFFLINE, timeout: Duration = Duration.ZERO, runOnce: suspend (SyncEvents) -> T): Result<T>

Usually used for background sync.