trixnity-client/net.folivo.trixnity.client/MatrixClient

MatrixClient

Types

data class LoginInfo(val userId: UserId, val deviceId: String, val accessToken: String, val displayName: String?, val avatarUrl: String?)

LoginState

enum LoginState : Enum<MatrixClient.LoginState>

SoftLoginInfo

data class SoftLoginInfo(val identifier: IdentifierType, val passwordOrToken: String, val loginType: LoginType = LoginType.Password)

Functions

cancelSync

abstract suspend fun cancelSync(wait: Boolean = false)

clearCache

abstract suspend fun clearCache(): Result<Unit>

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

clearMediaCache

abstract suspend fun clearMediaCache(): Result<Unit>

logout

abstract suspend fun logout(): Result<Unit>

setAvatarUrl

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

setDisplayName

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

startSync

abstract suspend fun startSync()

stopSync

abstract suspend fun stopSync(wait: Boolean = false)

syncOnce

abstract suspend fun syncOnce(timeout: Long = 0): Result<Unit>

abstract suspend fun <T> syncOnce(timeout: Long = 0, runOnce: suspend (Sync.Response) -> T): Result<T>

Properties

api

abstract val api: MatrixClientServerApiClient

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

avatarUrl

abstract val avatarUrl: StateFlow<String?>

deviceId

abstract val deviceId: String

abstract val di: Koin

displayName

abstract val displayName: StateFlow<String?>

identityKey

abstract val identityKey: Key.Curve25519Key

initialSyncDone

abstract val initialSyncDone: StateFlow<Boolean>

loginState

abstract val loginState: StateFlow<MatrixClient.LoginState?>

signingKey

abstract val signingKey: Key.Ed25519Key

syncState

abstract val syncState: StateFlow<SyncState>

userId

abstract val userId: UserId

Inheritors

MatrixClientImpl

Extensions

key

val MatrixClient.key: KeyService

media

val MatrixClient.media: MediaService

push

val MatrixClient.push: NotificationService

room

val MatrixClient.room: RoomService

user

val MatrixClient.user: UserService

verification

val MatrixClient.verification: VerificationService