matrix-sdk-android/org.matrix.android.sdk.api.auth

Package org.matrix.android.sdk.api.auth

Types

AuthenticationService

interface AuthenticationService

This interface defines methods to authenticate or to create an account to a matrix server.

HomeServerHistoryService

interface HomeServerHistoryService

A simple service to remember homeservers you already connected to.

LoginType

enum LoginType : Enum<LoginType>

SSOAction

enum SSOAction : Enum<SSOAction>

See https://github.com/matrix-org/matrix-spec-proposals/pull/3824

TokenBasedAuth

@JsonClass(generateAdapter = true)

data class TokenBasedAuth( @Json(name = "session") val session: String? = null, @Json(name = "token") val token: String? = null, @Json(name = "txn_id") val transactionId: String? = null, @Json(name = "type") val type: String? = LoginFlowTypes.TOKEN) : UIABaseAuth

This class provides the authentication data by using user and password.

UIABaseAuth

interface UIABaseAuth

UrlAndName

data class UrlAndName(val url: String, val name: String)

UserInteractiveAuthInterceptor

interface UserInteractiveAuthInterceptor

Some API endpoints require authentication that interacts with the user. The homeserver may provide many different ways of authenticating, such as user/password auth, login via a social network (OAuth2), login by confirming a token sent to their email address, etc.

UserPasswordAuth

@JsonClass(generateAdapter = true)

data class UserPasswordAuth( @Json(name = "session") val session: String? = null, @Json(name = "type") val type: String? = LoginFlowTypes.PASSWORD, @Json(name = "user") val user: String? = null, @Json(name = "password") val password: String? = null) : UIABaseAuth

This class provides the authentication data by using user and password.

Functions

toLocalizedLoginTerms

fun TermPolicies.toLocalizedLoginTerms(userLanguage: String, defaultLanguage: String = "en"): List<LocalizedFlowDataLoginTerms>

This method extract the policies from the login terms parameter, regarding the user language. For each policy, if user language is not found, the default language is used and if not found, the first url and name are used (not predictable)