trixnity-core/net.folivo.trixnity.core

Package-level declarations

Types

Auth

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS])

annotation class Auth(val required: AuthRequired)

AuthRequired

enum AuthRequired : Enum<AuthRequired>

ClientEventEmitter

interface ClientEventEmitter<T : List<ClientEvent<*>>>

ClientEventEmitterImpl

abstract class ClientEventEmitterImpl<T : List<ClientEvent<*>>> : ClientEventEmitter<T>

ErrorResponse

@Serializable

sealed interface ErrorResponse

ErrorResponseSerializer

object ErrorResponseSerializer : KSerializer<ErrorResponse>

EventHandler

interface EventHandler

ForceJson

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS])

annotation class ForceJson

HttpMethod

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS])

annotation class HttpMethod(val type: HttpMethodType)

HttpMethodType

enum HttpMethodType : Enum<HttpMethodType>

MatrixEndpoint

interface MatrixEndpoint<REQUEST, RESPONSE>

MatrixRegex

object MatrixRegex

MatrixServerException

open class MatrixServerException(val statusCode: HttpStatusCode, val errorResponse: ErrorResponse, val retryAfter: Long? = null) : Exception

Subscriber

typealias Subscriber<T> = suspend (T) -> Unit

Unsubscriber

typealias Unsubscriber = () -> Unit

UserInfo

data class UserInfo(val userId: UserId, val deviceId: String, val signingPublicKey: Key.Ed25519Key, val identityPublicKey: Key.Curve25519Key)

Functions

filterContent

fun <C : EventContent, E : ClientEvent<out C>> Flow<E>.filterContent(contentClass: KClass<out C>, eventClass: KClass<out E>? = null): Flow<E>

fun ClientEventEmitter<*>.subscribe(priority: Int = Priority.DEFAULT, subscriber: suspend () -> Unit): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeAsFlow

fun <T : List<ClientEvent<*>>> ClientEventEmitter<T>.subscribeAsFlow(priority: Int = Priority.DEFAULT): Flow<T>

Subscribe with a flow.

subscribeChangeAsFlow

fun ClientEventEmitter<*>.subscribeChangeAsFlow(priority: Int = Priority.DEFAULT): Flow<Unit>

Subscribe with a flow.

subscribeContent

inline fun <C : EventContent> ClientEventEmitter<*>.subscribeContent(priority: Int = Priority.DEFAULT, noinline subscriber: Subscriber<ClientEvent<C>>): () -> Unit

fun <C : EventContent> ClientEventEmitter<*>.subscribeContent(contentClass: KClass<C>, priority: Int, subscriber: Subscriber<ClientEvent<C>>): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeContentAsFlow

inline fun <C : EventContent> ClientEventEmitter<*>.subscribeContentAsFlow(priority: Int = Priority.DEFAULT): Flow<ClientEvent<C>>

Subscribe events with a flow.

subscribeContentList

inline fun <C : EventContent> ClientEventEmitter<*>.subscribeContentList(priority: Int = Priority.DEFAULT, noinline subscriber: Subscriber<List<ClientEvent<C>>>): () -> Unit

fun <C : EventContent> ClientEventEmitter<*>.subscribeContentList(contentClass: KClass<C>, priority: Int, subscriber: Subscriber<List<ClientEvent<C>>>): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeContentListAsFlow

inline fun <C : EventContent> ClientEventEmitter<*>.subscribeContentListAsFlow(priority: Int = Priority.DEFAULT): Flow<List<ClientEvent<C>>>

Subscribe events with a flow.

subscribeEachEvent

fun ClientEventEmitter<*>.subscribeEachEvent(priority: Int = Priority.DEFAULT, subscriber: Subscriber<ClientEvent<*>>): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeEachEventAsFlow

fun ClientEventEmitter<*>.subscribeEachEventAsFlow(priority: Int = Priority.DEFAULT): Flow<ClientEvent<*>>

Subscribe events with a flow.

subscribeEvent

inline fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEvent(priority: Int = Priority.DEFAULT, noinline subscriber: Subscriber<E>): () -> Unit

fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEvent(contentClass: KClass<C>, eventClass: KClass<E>, priority: Int, subscriber: Subscriber<E>): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeEventAsFlow

inline fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEventAsFlow(priority: Int = Priority.DEFAULT): Flow<E>

Subscribe events with a flow.

subscribeEventList

inline fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEventList(priority: Int = Priority.DEFAULT, noinline subscriber: Subscriber<List<E>>): () -> Unit

fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEventList(contentClass: KClass<C>, eventClass: KClass<E>, priority: Int, subscriber: Subscriber<List<E>>): () -> Unit

Subscribers have to be aware to unsubscribe when the scope of the subscriber is destroyed.

subscribeEventListAsFlow

inline fun <C : EventContent, E : ClientEvent<C>> ClientEventEmitter<*>.subscribeEventListAsFlow(priority: Int = Priority.DEFAULT): Flow<List<E>>

Subscribe events with a flow.

unsubscribeOnCompletion

fun Unsubscriber.unsubscribeOnCompletion(coroutineScope: CoroutineScope): DisposableHandle