AuthenticationService

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

Functions

Cancel pending login or pending registration.

abstract suspend fun createSessionFromSso(homeServerConnectionConfig: HomeServerConnectionConfig, credentials: Credentials): Session

Create a session after a SSO successful login.

abstract suspend fun directAuthentication(homeServerConnectionConfig: HomeServerConnectionConfig, matrixId: String, password: String, initialDeviceName: String, deviceId: String? = null): Session

Authenticate with a matrixId and a password. Usually call this after a successful call to getWellKnownData().

abstract fun getFallbackUrl(forSignIn: Boolean, deviceId: String?): String?

Get the sign in or sign up fallback URL.

Get the last authenticated Session, if there is an active session.

Request the supported login flows for this homeserver. This is the first method to call to be able to get a wizard to login or to create an account.

Request the supported login flows for the corresponding sessionId.

Return a LoginWizard, to login to the homeserver. The login flow has to be retrieved first.

Return a RegistrationWizard, to create an matrix account on the homeserver. The login flow has to be retrieved first.

abstract fun getSsoUrl(redirectUrl: String, deviceId: String?, providerId: String?, action: SSOAction): String?

Get a SSO url.

abstract suspend fun getWellKnownData(matrixId: String, homeServerConnectionConfig: HomeServerConnectionConfig?): WellknownResult

Perform a wellknown request, using the domain from the matrixId.

Check if there is an authenticated Session.

True when login and password has been sent with success to the homeserver.

abstract suspend fun loginUsingQrLoginToken(homeServerConnectionConfig: HomeServerConnectionConfig, loginToken: String, initialDeviceName: String? = null, deviceId: String? = null): Session

Authenticate using m.login.token method during sign in with QR code.

abstract suspend fun reset()

Reset all pending settings, including current HomeServerConnectionConfig.