Package-level declarations
Types
Link copied to clipboard
interface AppserviceApiClient
Link copied to clipboard
Link copied to clipboard
interface AuthenticationApiClient
Link copied to clipboard
class AuthenticationApiClientImpl(baseClient: MatrixClientServerApiBaseClient, authProvider: MatrixClientAuthProvider) : AuthenticationApiClient
Link copied to clipboard
abstract class BearerClientAuthProvider<T : BearerTokens>(store: MatrixClientAuthProviderDataStore, onLogout: suspend (LogoutInfo) -> Unit) : MatrixClientAuthProvider
Link copied to clipboard
Link copied to clipboard
class ClassicMatrixClientAuthProvider(val baseUrl: Url, store: MatrixClientAuthProviderDataStore, onLogout: suspend (LogoutInfo) -> Unit) : BearerClientAuthProvider<ClassicMatrixClientAuthProviderData>
Link copied to clipboard
@Serializable
Link copied to clipboard
interface DeviceApiClient
Link copied to clipboard
Link copied to clipboard
interface DiscoveryApiClient
Link copied to clipboard
Link copied to clipboard
interface KeyApiClient
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface MatrixClientAuthProviderData
Link copied to clipboard
interface MatrixClientAuthProviderDataStore
Provides methods to retrieve and store arbitrary authentication data.
Link copied to clipboard
class MatrixClientServerApiBaseClient(authProvider: MatrixClientAuthProvider, eventContentSerializerMappings: EventContentSerializerMappings = EventContentSerializerMappings.default, json: Json = createMatrixEventJson(eventContentSerializerMappings), asUserId: UserId? = null, asDeviceId: String? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null) : MatrixApiClient
Link copied to clipboard
Link copied to clipboard
interface MatrixClientServerApiClientFactory
Link copied to clipboard
class MatrixClientServerApiClientImpl(authProvider: MatrixClientAuthProvider, val eventContentSerializerMappings: EventContentSerializerMappings = EventContentSerializerMappings.default, val json: Json = createMatrixEventJson(eventContentSerializerMappings), syncBatchTokenStore: SyncBatchTokenStore = SyncBatchTokenStore.inMemory(), syncErrorDelayConfig: RetryFlowDelayConfig = RetryFlowDelayConfig.sync, coroutineContext: CoroutineContext = Dispatchers.Default, asUserId: UserId? = null, asDeviceId: String? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null) : MatrixClientServerApiClient
Link copied to clipboard
interface MediaApiClient
Link copied to clipboard
Link copied to clipboard
interface PushApiClient
Link copied to clipboard
Link copied to clipboard
interface RoomApiClient
Link copied to clipboard
class RoomApiClientImpl(baseClient: MatrixClientServerApiBaseClient, val contentMappings: EventContentSerializerMappings) : RoomApiClient
Link copied to clipboard
interface ServerApiClient
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class SyncApiClientImpl(baseClient: MatrixClientServerApiBaseClient, coroutineScope: CoroutineScope, syncBatchTokenStore: SyncBatchTokenStore, syncErrorDelayConfig: RetryFlowDelayConfig) : ClientEventEmitterImpl<SyncEvents> , SyncApiClient
Link copied to clipboard
interface SyncBatchTokenStore
Link copied to clipboard
class SyncEvents(val syncResponse: Sync.Response, allEvents: List<ClientEvent<*>> = syncResponse.allEvents(), epoch: Long? = null) : List<ClientEvent<*>>
Link copied to clipboard
Link copied to clipboard
@Serializable
Link copied to clipboard
interface UserApiClient
Link copied to clipboard
class UserApiClientImpl(baseClient: MatrixClientServerApiBaseClient, val contentMappings: EventContentSerializerMappings) : UserApiClient
Functions
Link copied to clipboard
fun MatrixClientAuthProviderData.Companion.classic(baseUrl: Url, accessToken: String, accessTokenExpiresInMs: Long? = null, refreshToken: String? = null): ClassicMatrixClientAuthProviderData
Link copied to clipboard
suspend fun MatrixClientAuthProviderData.Companion.classicLogin(baseUrl: Url, identifier: IdentifierType? = null, password: String? = null, token: String? = null, loginType: LoginType = LoginType.Password, deviceId: String? = null, initialDeviceDisplayName: String? = null, refreshToken: Boolean? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<ClassicMatrixClientAuthProviderData>
Link copied to clipboard
suspend fun MatrixClientAuthProviderData.Companion.classicLoginWith(baseUrl: Url, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null, with: suspend (MatrixClientServerApiClient) -> ClassicMatrixClientAuthProviderData): Result<ClassicMatrixClientAuthProviderData>
Link copied to clipboard
suspend fun MatrixClientAuthProviderData.Companion.classicLoginWithPassword(baseUrl: Url, identifier: IdentifierType? = null, password: String, deviceId: String? = null, initialDeviceDisplayName: String? = null, refreshToken: Boolean? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<ClassicMatrixClientAuthProviderData>
Link copied to clipboard
suspend fun MatrixClientAuthProviderData.Companion.classicLoginWithToken(baseUrl: Url, identifier: IdentifierType? = null, token: String, deviceId: String? = null, initialDeviceDisplayName: String? = null, refreshToken: Boolean? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<ClassicMatrixClientAuthProviderData>
Link copied to clipboard
inline suspend fun <C : GlobalAccountDataEventContent> UserApiClient.getAccountData(userId: UserId, key: String = ""): Result<C>
inline suspend fun <C : RoomAccountDataEventContent> RoomApiClient.getAccountData(roomId: RoomId, userId: UserId, key: String = ""): Result<C>
Link copied to clipboard
inline suspend fun <T : MatrixClientAuthProviderData> MatrixClientAuthProviderDataStore.getAuthData(): T?
Link copied to clipboard
inline suspend fun <C : MessageEventContent> RoomApiClient.getRelationsByType(roomId: RoomId, eventId: EventId, relationType: RelationType, from: String? = null, to: String? = null, limit: Long? = null): Result<GetRelationsResponse>
Link copied to clipboard
inline suspend fun <C : StateEventContent> RoomApiClient.getStateEvent(roomId: RoomId, stateKey: String = ""): Result<ClientEvent.StateBaseEvent<C>>
Link copied to clipboard
inline suspend fun <C : StateEventContent> RoomApiClient.getStateEventContent(roomId: RoomId, stateKey: String = ""): Result<C>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun <T> MatrixClientAuthProviderData.useApi(eventContentSerializerMappings: EventContentSerializerMappings = EventContentSerializerMappings.default, json: Json = createMatrixEventJson(eventContentSerializerMappings), syncBatchTokenStore: SyncBatchTokenStore = SyncBatchTokenStore.inMemory(), syncErrorDelayConfig: RetryFlowDelayConfig = RetryFlowDelayConfig.sync, coroutineContext: CoroutineContext = Dispatchers.Default, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null, block: suspend (MatrixClientServerApiClient) -> T): T