trixnity-client/de.connect2x.trixnity.client

Package-level declarations

Types

CryptoDriverModule

fun interface CryptoDriverModule

CurrentSyncState

class CurrentSyncState(currentSyncState: StateFlow<SyncState>) : StateFlow<SyncState>

MatrixClient

interface MatrixClient : AutoCloseable

MatrixClientAuthProviderDataSerializerMapping

data class MatrixClientAuthProviderDataSerializerMapping<T : MatrixClientAuthProviderData>(val id: String, val kClass: KClass<out T>, val serializer: KSerializer<T>)

MatrixClientAuthProviderDataSerializerMappings

interface MatrixClientAuthProviderDataSerializerMappings : Set<MatrixClientAuthProviderDataSerializerMapping<*>>

MatrixClientAuthProviderDataSerializerMappingsBuilder

class MatrixClientAuthProviderDataSerializerMappingsBuilder

MatrixClientConfiguration

data class MatrixClientConfiguration(var name: String? = null, var storeTimelineEventContentUnencrypted: Boolean = true, var markOwnMessageAsRead: Boolean = false, var autoJoinUpgradedRooms: Boolean = true, var deleteRooms: MatrixClientConfiguration.DeleteRooms = DeleteRooms.WhenNotJoined, var deleteSentOutboxMessageDelay: Duration = 10.seconds, var userPresenceActivityThreshold: Duration = 5.minutes, var enableExternalNotifications: Boolean = false, var cacheExpireDurations: MatrixClientConfiguration.CacheExpireDurations = CacheExpireDurations.default(1.minutes), var syncLoopTimeout: Duration = 30.seconds, var syncErrorDelayConfig: RetryFlowDelayConfig = RetryFlowDelayConfig.sync, var lastRelevantEventFilter: (ClientEvent.RoomEvent<*>) -> Boolean = { it is RoomEvent.MessageEvent<*> }, var syncFilter: Filters = Filters(), var syncOnceFilter: Filters = Filters(presence = Filters.EventFilter(limit = 0)), var httpClientEngine: HttpClientEngine? = null, var httpClientConfig: HttpClientConfig<*>.() -> Unit? = null, var modulesFactories: List<ModuleFactory> = createTrixnityDefaultModuleFactories(), var matrixClientServerApiClientFactory: MatrixClientServerApiClientFactory = object : MatrixClientServerApiClientFactory {}, val experimentalFeatures: MatrixClientConfiguration.ExperimentalFeatures = ExperimentalFeatures())

MatrixClientImpl

class MatrixClientImpl : MatrixClient

MatrixClientStarted

class MatrixClientStarted(delegate: MutableStateFlow<Boolean> = MutableStateFlow(false)) : StateFlow<Boolean>

MediaStoreModule

fun interface MediaStoreModule

ModuleFactory

typealias ModuleFactory = () -> Module

RepositoriesModule

fun interface RepositoriesModule

Properties

default

val MatrixClientAuthProviderDataSerializerMappings.Companion.default: MatrixClientAuthProviderDataSerializerMappings

key

val MatrixClient.key: KeyService

media

val MatrixClient.media: MediaService

notification

val MatrixClient.notification: NotificationService

room

val MatrixClient.room: RoomService

roomEventEncryptionServices

val MatrixClient.roomEventEncryptionServices: List<RoomEventEncryptionService>

user

val MatrixClient.user: UserService

verification

val MatrixClient.verification: VerificationService

Functions

create

suspend fun MatrixClient.Companion.create(repositoriesModule: RepositoriesModule, mediaStoreModule: MediaStoreModule, cryptoDriverModule: CryptoDriverModule, authProviderData: MatrixClientAuthProviderData? = null, coroutineContext: CoroutineContext = Dispatchers.Default, configuration: MatrixClientConfiguration.() -> Unit = {}): Result<MatrixClient>

createClockModule

fun createClockModule(): Module

createCurrentSyncStateModule

fun createCurrentSyncStateModule(): Module

createDefaultEventContentSerializerMappingsModule

fun createDefaultEventContentSerializerMappingsModule(): Module

createDefaultMatrixClientAuthProviderSerializerMappings

fun createDefaultMatrixClientAuthProviderSerializerMappings(): Module

createDefaultMatrixJsonModule

fun createDefaultMatrixJsonModule(): Module

createDefaultOutboxMessageMediaUploaderMappingsModule

fun createDefaultOutboxMessageMediaUploaderMappingsModule(): Module

createMatrixClientAuthProviderSerializerMappings

fun createMatrixClientAuthProviderSerializerMappings(builder: MatrixClientAuthProviderDataSerializerMappingsBuilder.() -> Unit): MatrixClientAuthProviderDataSerializerMappings

createMatrixClientStartedModule

fun createMatrixClientStartedModule(): Module

createTrixnityBotModuleFactories

fun createTrixnityBotModuleFactories(): List<ModuleFactory>

Use this, if you want to create a bot with basic functionality. You don't have access to some data usually provided by Trixnity (for example RoomUser or TimelineEvent).

createTrixnityDefaultModuleFactories

fun createTrixnityDefaultModuleFactories(): List<ModuleFactory>

flatten

@JvmName(name = "flattenList")

inline fun <V> Flow<List<Flow<V?>>>.flatten(throttle: Duration = 200.milliseconds): Flow<List<V>>

fun <K, V> Flow<Map<K, Flow<V?>>>.flatten(throttle: Duration = 200.milliseconds): Flow<Map<K, V?>>

A change of the outer flow results in new collect of the inner flows. Because this is an expensive operation, the outer flow is throttled by default.

flattenNotNull

fun <K, V> Flow<Map<K, Flow<V?>>>.flattenNotNull(throttle: Duration = 200.milliseconds): Flow<Map<K, V>>

A change of the outer flow results in new collect of the inner flows. Because this is an expensive operation, the outer flow is throttled by default.

flattenValues

inline fun <K, V> Flow<Map<K, Flow<V?>>>.flattenValues(throttle: Duration = 200.milliseconds): Flow<List<V>>

A change of the outer flow results in new collect of the inner flows. Because this is an expensive operation, the outer flow is throttled by default.

fun Flow<Map<RoomId, Flow<Room?>>>.flattenValues(throttle: Duration = 200.milliseconds, filterUpgradedRooms: Boolean = true): Flow<Set<Room>>

This collects all rooms, so when one changes, a new set gets emitted. A change of the outer flow results in new collect of the inner flows. Because this is an expensive operation, the outer flow is throttled by default.

inline fun <C : MatrixClientAuthProviderData> MatrixClientAuthProviderDataSerializerMappingsBuilder.of(id: String)

serverDiscovery

suspend fun UserId.serverDiscovery(httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<Url>

suspend fun Url.serverDiscovery(httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<Url>

suspend fun String.serverDiscovery(httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): Result<Url>

toMxcUri

fun String.toMxcUri(): Url