trixnity-client/de.connect2x.trixnity.client/MatrixClientConfiguration

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())

Constructors

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

Types

CacheExpireDurations

data class CacheExpireDurations(val globalAccountDate: Duration, val deviceKeys: Duration, val crossSigningKeys: Duration, val keyVerificationState: Duration, val mediaCacheMapping: Duration, val olmSession: Duration, val inboundMegolmSession: Duration, val inboundMegolmMessageIndex: Duration, val outboundMegolmSession: Duration, val roomAccountData: Duration, val roomState: Duration, val timelineEvent: Duration, val timelineEventRelation: Duration, val roomUser: Duration, val roomUserReceipts: Duration, val secretKeyRequest: Duration, val roomKeyRequest: Duration, val roomOutboxMessage: Duration, val room: Duration, val presence: Duration, val media: Duration, val notification: Duration)

DeleteRooms

sealed interface DeleteRooms

Trixnity will delete rooms based on different conditions:

ExperimentalFeatures

data class ExperimentalFeatures(var enableMSC3814: Boolean = false)

Properties

autoJoinUpgradedRooms

var autoJoinUpgradedRooms: Boolean

Automatically join upgraded rooms.

cacheExpireDurations

var cacheExpireDurations: MatrixClientConfiguration.CacheExpireDurations

Specifies how long values are kept in the cache when not used by anyone.

deleteRooms

var deleteRooms: MatrixClientConfiguration.DeleteRooms

How to handle left rooms. See DeleteRooms. Convention is DeleteRooms.WhenNotJoined.

deleteSentOutboxMessageDelay

var deleteSentOutboxMessageDelay: Duration

Set the delay, after which a sent outbox message is deleted. The delay is checked each time a sync is received.

enableExternalNotifications

var enableExternalNotifications: Boolean

Enables storing a queue of notification updates locally to allow using them to update external notifications. To prevent unnecessary stored data, it should not be enabled when not needed and is disabled by default.

experimentalFeatures

val experimentalFeatures: MatrixClientConfiguration.ExperimentalFeatures

httpClientConfig