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

SessionParams

data class SessionParams(val credentials: Credentials, val homeServerConnectionConfig: HomeServerConnectionConfig, val isTokenValid: Boolean, val loginType: LoginType)

This data class holds necessary data to open a session. You don't have to manually instantiate it.

Constructors

SessionParams

constructor(credentials: Credentials, homeServerConnectionConfig: HomeServerConnectionConfig, isTokenValid: Boolean, loginType: LoginType)

Properties

credentials

val credentials: Credentials

Please consider using shortcuts instead.

defaultIdentityServerUrl

val defaultIdentityServerUrl: String?

The default identity server url if any, returned by the homeserver during login phase.

deviceId

val deviceId: String

The deviceId of the session (Ex: "ABCDEFGH").

homeServerConnectionConfig

val homeServerConnectionConfig: HomeServerConnectionConfig

Please consider using shortcuts instead.

homeServerHost

val homeServerHost: String?

The current homeserver host, using what has been entered by the user during login phase.

homeServerUrl

val homeServerUrl: String

The homeserver Url entered by the user during the login phase.

homeServerUrlBase

val homeServerUrlBase: String

The current homeserver Url for client-server API. It can be different that the homeserver url entered during login phase, because a redirection may have occurred

isTokenValid

val isTokenValid: Boolean

Set to false if the current token is not valid anymore. Application should not have to use this info.

loginType

val loginType: LoginType

The authentication method that was used to create the session.

userId

val userId: String

The userId of the session (Ex: "@user:domain.org").