trixnity-client/net.folivo.trixnity.client.room

Package-level declarations

Types

class DirectRoomEventHandler(userInfo: UserInfo, api: MatrixClientServerApiClient, roomStore: RoomStore, roomStateStore: RoomStateStore, globalAccountDataStore: GlobalAccountDataStore) : EventHandler

GetTimelineEventConfig

data class GetTimelineEventConfig(var decryptionTimeout: Duration = INFINITE, var fetchTimeout: Duration = INFINITE, var fetchSize: Long = 20, var allowReplaceContent: Boolean = true)

GetTimelineEventsConfig

data class GetTimelineEventsConfig(var decryptionTimeout: Duration = INFINITE, var fetchTimeout: Duration = INFINITE, var fetchSize: Long = 20, var allowReplaceContent: Boolean = true, var minSize: Long? = null, var maxSize: Long? = null)

MegolmRoomEventDecryptionService

class MegolmRoomEventDecryptionService(olmCryptoStore: OlmCryptoStore, keyBackupService: KeyBackupService, outgoingRoomKeyRequestEventHandler: OutgoingRoomKeyRequestEventHandler, olmEncryptionService: OlmEncryptionService) : RoomEventDecryptionService

MembershipEventHandler

class MembershipEventHandler(userInfo: UserInfo, api: MatrixClientServerApiClient, roomStore: RoomStore) : EventHandler

OutboxMessageEventHandler

class OutboxMessageEventHandler(config: MatrixClientConfiguration, api: MatrixClientServerApiClient, possiblyEncryptEvent: PossiblyEncryptEvent, mediaService: MediaService, roomOutboxMessageStore: RoomOutboxMessageStore, outboxMessageMediaUploaderMappings: OutboxMessageMediaUploaderMappings, currentSyncState: CurrentSyncState) : EventHandler

RoomAccountDataEventHandler

class RoomAccountDataEventHandler(api: MatrixClientServerApiClient, roomAccountDataStore: RoomAccountDataStore) : EventHandler

RoomAvatarUrlEventHandler

class RoomAvatarUrlEventHandler(userInfo: UserInfo, api: MatrixClientServerApiClient, roomStore: RoomStore, roomStateStore: RoomStateStore, globalAccountDataStore: GlobalAccountDataStore) : EventHandler

RoomDisplayNameEventHandler

class RoomDisplayNameEventHandler(api: MatrixClientServerApiClient, roomStore: RoomStore, roomStateStore: RoomStateStore, userInfo: UserInfo) : EventHandler

RoomEncryptionEventHandler

class RoomEncryptionEventHandler(api: MatrixClientServerApiClient, roomStore: RoomStore) : EventHandler

RoomEventDecryptionService

interface RoomEventDecryptionService

RoomListHandler

class RoomListHandler(api: MatrixClientServerApiClient, roomStore: RoomStore, roomService: RoomService, config: MatrixClientConfiguration) : EventHandler

RoomService

interface RoomService

RoomServiceImpl

class RoomServiceImpl(api: MatrixClientServerApiClient, roomStore: RoomStore, roomUserStore: RoomUserStore, roomStateStore: RoomStateStore, roomAccountDataStore: RoomAccountDataStore, roomTimelineStore: RoomTimelineStore, roomOutboxMessageStore: RoomOutboxMessageStore, roomEventDecryptionServices: List<RoomEventDecryptionService>, mediaService: MediaService, userInfo: UserInfo, timelineEventHandler: TimelineEventHandler, typingEventHandler: TypingEventHandler, currentSyncState: CurrentSyncState, scope: CoroutineScope) : RoomService

RoomStateEventHandler

class RoomStateEventHandler(api: MatrixClientServerApiClient, roomStateStore: RoomStateStore) : EventHandler

RoomUpgradeHandler

class RoomUpgradeHandler(api: MatrixClientServerApiClient, roomStore: RoomStore, configuration: MatrixClientConfiguration) : EventHandler

SimpleTimeline

typealias SimpleTimeline = Timeline<Flow<TimelineEvent>>

Timeline

interface Timeline<T>

This is an abstraction for a timeline. Call init first!

TimelineBase

abstract class TimelineBase<T>(val transformer: suspend (Flow<TimelineEvent>) -> T) : Timeline<T>

An implementation for some restrictions required by Timeline.

TimelineEventAggregation

interface TimelineEventAggregation

TimelineEventDecryptionFailed

interface TimelineEventDecryptionFailed

TimelineEventHandler

interface TimelineEventHandler

TimelineEventHandlerImpl

class TimelineEventHandlerImpl(api: MatrixClientServerApiClient, roomStore: RoomStore, roomTimelineStore: RoomTimelineStore, roomOutboxMessageStore: RoomOutboxMessageStore, timelineMutex: TimelineMutex, tm: TransactionManager) : EventHandler, TimelineEventHandler

TimelineImpl

class TimelineImpl<T>(roomId: RoomId, roomService: RoomService, transformer: suspend (Flow<TimelineEvent>) -> T) : TimelineBase<T>

TimelineMutex

class TimelineMutex

TimelineState

data class TimelineState<T>(val elements: List<T> = listOf(), val lastLoadedEventIdBefore: EventId? = null, val lastLoadedEventIdAfter: EventId? = null, val isInitialized: Boolean = false, val isLoadingBefore: Boolean = false, val isLoadingAfter: Boolean = false, val canLoadBefore: Boolean = false, val canLoadAfter: Boolean = false)

TimelineStateChange

data class TimelineStateChange<T>(val elementsBeforeChange: List<T> = listOf(), val elementsAfterChange: List<T> = listOf(), val newElements: List<T> = listOf())

TypingEventHandler

class TypingEventHandler(api: MatrixClientServerApiClient) : EventHandler

Functions

apply

fun GetTimelineEventConfig.apply(config: GetTimelineEventsConfig): GetTimelineEventConfig

fun GetTimelineEventsConfig.apply(config: GetTimelineEventConfig): GetTimelineEventsConfig

createRoomModule

fun createRoomModule(): Module

firstWithContent

suspend fun Flow<TimelineEvent?>.firstWithContent(): TimelineEvent

flatten

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

This collects all rooms, so when one room changes, a new room 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.

getAccountData

inline fun <C : RoomAccountDataEventContent> RoomService.getAccountData(roomId: RoomId, key: String = ""): Flow<C?>

getAllState

inline fun <C : StateEventContent> RoomService.getAllState(roomId: RoomId): Flow<Map<String, Flow<Event<C>?>>?>

getState

inline fun <C : StateEventContent> RoomService.getState(roomId: RoomId, stateKey: String = ""): Flow<Event<C>?>

getTimeline

fun RoomService.getTimeline(roomId: RoomId): SimpleTimeline

getTimelineEventReactionAggregation

fun RoomService.getTimelineEventReactionAggregation(roomId: RoomId, eventId: EventId): Flow<TimelineEventAggregation.Reaction>

getTimelineEventReplaceAggregation

fun RoomService.getTimelineEventReplaceAggregation(roomId: RoomId, eventId: EventId): Flow<TimelineEventAggregation.Replace>

getTimelineEventsAround

suspend fun RoomService.getTimelineEventsAround(roomId: RoomId, startFrom: EventId, configStart: GetTimelineEventConfig.() -> Unit = {}, configBefore: GetTimelineEventsConfig.() -> Unit = {}, configAfter: GetTimelineEventsConfig.() -> Unit = {}): List<Flow<TimelineEvent>>

Returns all timeline events around a starting event.

fun RoomService.getTimelineEventsAround(roomId: RoomId, startFrom: EventId, maxSizeBefore: StateFlow<Int>, maxSizeAfter: StateFlow<Int>, configStart: GetTimelineEventConfig.() -> Unit = {}, configBefore: GetTimelineEventsConfig.() -> Unit = {}, configAfter: GetTimelineEventsConfig.() -> Unit = {}): Flow<List<Flow<TimelineEvent>>>

Returns all timeline events around a starting event sorted with higher indexes being more recent.

toFlowList

@JvmName(name = "toListFromLatest")

fun Flow<Flow<Flow<TimelineEvent>>?>.toFlowList(maxSize: StateFlow<Int>, minSize: MutableStateFlow<Int> = MutableStateFlow(0)): Flow<List<Flow<TimelineEvent>>>

Converts a flow of flow of timeline events into a flow of list of timeline events limited by maxSize.

@JvmName(name = "toList")

fun Flow<Flow<TimelineEvent>>.toFlowList(maxSize: StateFlow<Int>, minSize: MutableStateFlow<Int> = MutableStateFlow(0)): Flow<List<Flow<TimelineEvent>>>

Converts a flow of timeline events into a flow of list of timeline events limited by maxSize.