trixnity-clientserverapi-client/de.connect2x.trixnity.clientserverapi.client/RoomApiClient

RoomApiClient

interface RoomApiClient

Inheritors

RoomApiClientImpl

Properties

contentMappings

abstract val contentMappings: EventContentSerializerMappings

Functions

abstract suspend fun banUser(roomId: RoomId, userId: UserId, reason: String? = null): Result<Unit>

abstract suspend fun createRoom(visibility: DirectoryVisibility = DirectoryVisibility.PRIVATE, roomAliasId: RoomAliasId? = null, name: String? = null, topic: String? = null, invite: Set<UserId>? = null, inviteThirdPid: Set<CreateRoom.Request.InviteThirdPid>? = null, roomVersion: String? = null, creationContent: CreateEventContent? = null, initialState: List<InitialStateEvent<*>>? = null, preset: CreateRoom.Request.Preset? = null, isDirect: Boolean? = null, powerLevelContentOverride: PowerLevelsEventContent? = null): Result<RoomId>

deleteRoomAlias

abstract suspend fun deleteRoomAlias(roomAliasId: RoomAliasId): Result<Unit>

abstract suspend fun deleteTag(userId: UserId, roomId: RoomId, tag: String): Result<Unit>

abstract suspend fun forgetRoom(roomId: RoomId): Result<Unit>

abstract suspend fun getAccountData(type: String, roomId: RoomId, userId: UserId, key: String = ""): Result<RoomAccountDataEventContent>

inline suspend fun <C : RoomAccountDataEventContent> RoomApiClient.getAccountData(roomId: RoomId, userId: UserId, key: String = ""): Result<C>

getDirectoryVisibility

abstract suspend fun getDirectoryVisibility(roomId: RoomId): Result<DirectoryVisibility>

abstract suspend fun getEvent(roomId: RoomId, eventId: EventId): Result<ClientEvent.RoomEvent<*>>

getEventContext

abstract suspend fun getEventContext(roomId: RoomId, eventId: EventId, filter: String? = null, limit: Long? = null): Result<GetEventContext.Response>

abstract suspend fun getEvents(roomId: RoomId, from: String, dir: GetEvents.Direction = GetEvents.Direction.FORWARDS, to: String? = null, limit: Long? = null, filter: String? = null): Result<GetEvents.Response>

abstract suspend fun getHierarchy(roomId: RoomId, from: String? = null, limit: Long? = null, maxDepth: Long? = null, suggestedOnly: Boolean = false): Result<GetHierarchy.Response>

getJoinedMembers

abstract suspend fun getJoinedMembers(roomId: RoomId): Result<GetJoinedMembers.Response>

abstract suspend fun getJoinedRooms(): Result<Set<RoomId>>

abstract suspend fun getMembers(roomId: RoomId, at: String? = null, membership: Membership? = null, notMembership: Membership? = null): Result<Set<ClientEvent.RoomEvent.StateEvent<MemberEventContent>>>

abstract suspend fun getPublicRooms(limit: Long? = null, server: String? = null, since: String? = null): Result<GetPublicRoomsResponse>

abstract suspend fun getPublicRooms(limit: Long? = null, server: String? = null, since: String? = null, filter: GetPublicRoomsWithFilter.Request.Filter? = null, includeAllNetworks: Boolean? = null, thirdPartyInstanceId: String? = null): Result<GetPublicRoomsResponse>

abstract suspend fun getRelations(roomId: RoomId, eventId: EventId, from: String? = null, to: String? = null, limit: Long? = null, recurse: Boolean? = null): Result<GetRelationsResponse>

abstract suspend fun getRelations(roomId: RoomId, eventId: EventId, relationType: RelationType, eventType: String, from: String? = null, to: String? = null, limit: Long? = null): Result<GetRelationsResponse>

abstract suspend fun getRelations(roomId: RoomId, eventId: EventId, relationType: RelationType, from: String? = null, to: String? = null, limit: Long? = null, recurse: Boolean? = null): Result<GetRelationsResponse>

getRelationsByType

inline suspend fun <C : MessageEventContent> RoomApiClient.getRelationsByType(roomId: RoomId, eventId: EventId, relationType: RelationType, from: String? = null, to: String? = null, limit: Long? = null): Result<GetRelationsResponse>

abstract suspend fun getRoomAlias(roomAliasId: RoomAliasId): Result<GetRoomAlias.Response>

abstract suspend fun getRoomAliases(roomId: RoomId): Result<Set<RoomAliasId>>

abstract suspend fun getState(roomId: RoomId): Result<List<ClientEvent.RoomEvent.StateEvent<*>>>

abstract suspend fun getStateEvent(type: String, roomId: RoomId, stateKey: String = ""): Result<ClientEvent.StateBaseEvent<*>>

inline suspend fun <C : StateEventContent> RoomApiClient.getStateEvent(roomId: RoomId, stateKey: String = ""): Result<ClientEvent.StateBaseEvent<C>>

getStateEventContent

abstract suspend fun getStateEventContent(type: String, roomId: RoomId, stateKey: String = ""): Result<StateEventContent>

getStateEventContent

inline suspend fun <C : StateEventContent> RoomApiClient.getStateEventContent(roomId: RoomId, stateKey: String = ""): Result<C>

abstract suspend fun getSummary(roomAliasId: RoomAliasId, via: Set<String>? = null): Result<GetSummary.Response>

abstract suspend fun getSummary(roomId: RoomId, via: Set<String>? = null): Result<GetSummary.Response>

abstract suspend fun getTags(userId: UserId, roomId: RoomId): Result<TagEventContent>

abstract suspend fun getThreads(roomId: RoomId, from: String? = null, include: GetThreads.Include? = null, limit: Long? = null): Result<GetThreads.Response>

abstract suspend fun inviteUser(roomId: RoomId, userId: UserId, reason: String? = null): Result<Unit>

abstract suspend fun joinRoom(roomAliasId: RoomAliasId, via: Set<String>? = null, reason: String? = null, thirdPartySigned: Signed<JoinRoom.Request.ThirdParty, String>? = null): Result<RoomId>

abstract suspend fun joinRoom(roomId: RoomId, via: Set<String>? = null, reason: String? = null, thirdPartySigned: Signed<JoinRoom.Request.ThirdParty, String>? = null): Result<RoomId>

abstract suspend fun kickUser(roomId: RoomId, userId: UserId, reason: String? = null): Result<Unit>

abstract suspend fun knockRoom(roomAliasId: RoomAliasId, via: Set<String>? = null, reason: String? = null): Result<RoomId>

abstract suspend fun knockRoom(roomId: RoomId, via: Set<String>? = null, reason: String? = null): Result<RoomId>

abstract suspend fun leaveRoom(roomId: RoomId, reason: String? = null): Result<Unit>

abstract suspend fun redactEvent(roomId: RoomId, eventId: EventId, reason: String? = null, txnId: String = Random.nextString(22)): Result<EventId>

abstract suspend fun reportEvent(roomId: RoomId, eventId: EventId, reason: String? = null, score: Long? = null): Result<Unit>

abstract suspend fun reportRoom(roomId: RoomId, reason: String): Result<Unit>

sendMessageEvent

abstract suspend fun sendMessageEvent(roomId: RoomId, eventContent: MessageEventContent, txnId: String = Random.nextString(22)): Result<EventId>

abstract suspend fun sendStateEvent(roomId: RoomId, eventContent: StateEventContent, stateKey: String = ""): Result<EventId>

abstract suspend fun setAccountData(content: RoomAccountDataEventContent, roomId: RoomId, userId: UserId, key: String = ""): Result<Unit>

setDirectoryVisibility

abstract suspend fun setDirectoryVisibility(roomId: RoomId, visibility: DirectoryVisibility): Result<Unit>

abstract suspend fun setReadMarkers(roomId: RoomId, fullyRead: EventId? = null, read: EventId? = null, privateRead: EventId? = null): Result<Unit>

abstract suspend fun setReceipt(roomId: RoomId, eventId: EventId, receiptType: ReceiptType = ReceiptType.Read, threadId: EventId? = null): Result<Unit>

abstract suspend fun setRoomAlias(roomId: RoomId, roomAliasId: RoomAliasId): Result<Unit>

abstract suspend fun setTag(userId: UserId, roomId: RoomId, tag: String, tagValue: TagEventContent.Tag): Result<Unit>

abstract suspend fun setTyping(roomId: RoomId, userId: UserId, typing: Boolean, timeout: Long? = null): Result<Unit>

timestampToEvent

abstract suspend fun timestampToEvent(roomId: RoomId, timestamp: Long, dir: TimestampToEvent.Direction = TimestampToEvent.Direction.FORWARDS): Result<TimestampToEvent.Response>

abstract suspend fun unbanUser(roomId: RoomId, userId: UserId, reason: String? = null): Result<Unit>

abstract suspend fun upgradeRoom(roomId: RoomId, version: String, additionalCreators: Set<UserId>? = null): Result<RoomId>