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

Package-level declarations

Types

ApplicationType

@Serializable(with = ApplicationType.Serializer::class)

sealed interface ApplicationType

LocalizedField

@Serializable

data class LocalizedField<T>(val default: T? = null, val translations: Map<String, T>? = null)

LocalizedObjectSerializer

abstract class LocalizedObjectSerializer<T>(delegate: KSerializer<T>) : JsonTransformingSerializer<T>

OAuth2LoginFlow

interface OAuth2LoginFlow

Represents the flow for handling OAuth 2.0 login operations. This interface provides methods to facilitate the redirection and callback required during the OAuth 2.0 authorization process.

OAuth2LoginFlowImpl

class OAuth2LoginFlowImpl(baseUrl: Url, applicationType: ApplicationType, clientUri: String, redirectUri: String, responseMode: ResponseMode = ResponseMode.Fragment, clientName: LocalizedField<String>? = null, logoUri: LocalizedField<String>? = null, policyUri: LocalizedField<String>? = null, tosUri: LocalizedField<String>? = null, promptValue: PromptValue? = null, initialState: OAuth2LoginFlow.AuthRequestData.State? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null) : OAuth2LoginFlow

OAuth2MatrixClientAuthProvider

class OAuth2MatrixClientAuthProvider(val baseUrl: Url, store: MatrixClientAuthProviderDataStore, onLogout: suspend (LogoutInfo) -> Unit, httpClientEngine: HttpClientEngine?, httpClientConfig: HttpClientConfig<*>.() -> Unit?) : BearerClientAuthProvider<OAuth2MatrixClientAuthProviderData>

OAuth2MatrixClientAuthProviderData

@Serializable

data class OAuth2MatrixClientAuthProviderData(val baseUrl: Url, val accessToken: String, val accessTokenExpiresInS: Long?, val refreshToken: String?, val clientId: String, val scope: Set<Scope>?) : MatrixClientAuthProviderData, BearerTokens

Scope

@Serializable(with = Scope.Serializer::class)

sealed interface Scope

TokenResponse

@Serializable(with = TokenResponse.Serializer::class)

data class TokenResponse(val accessToken: String, val refreshToken: String? = null, val tokenType: String, val expiresIn: Long? = null, val scope: Set<Scope>? = null)

Functions

oAuth2

fun MatrixClientAuthProviderData.Companion.oAuth2(baseUrl: Url, clientId: String, accessToken: String, accessTokenExpiresInS: Long? = null, refreshToken: String? = null, scope: Set<Scope>? = null): OAuth2MatrixClientAuthProviderData

oAuth2Login

fun MatrixClientAuthProviderData.Companion.oAuth2Login(baseUrl: Url, applicationType: ApplicationType, clientUri: String, redirectUri: String, responseMode: ResponseMode = ResponseMode.Fragment, clientName: LocalizedField<String>? = null, logoUri: LocalizedField<String>? = null, policyUri: LocalizedField<String>? = null, tosUri: LocalizedField<String>? = null, promptValue: PromptValue? = null, initialState: OAuth2LoginFlow.AuthRequestData.State? = null, httpClientEngine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit? = null): OAuth2LoginFlow