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

RegistrationFlowResponse

@JsonClass(generateAdapter = true)

data class RegistrationFlowResponse( @Json(name = "flows") val flows: List<InteractiveAuthenticationFlow>? = null, @Json(name = "completed") val completedStages: List<String>? = null, @Json(name = "session") val session: String? = null, @Json(name = "params") val params: JsonDict? = null)

Constructors

fun RegistrationFlowResponse( @Json(name = "flows") flows: List<InteractiveAuthenticationFlow>? = null, @Json(name = "completed") completedStages: List<String>? = null, @Json(name = "session") session: String? = null, @Json(name = "params") params: JsonDict? = null)

Properties

completedStages

val completedStages: List<String>? = null

The list of stages the client has completed successfully.

flows

val flows: List<InteractiveAuthenticationFlow>? = null

The list of flows.

params

val params: JsonDict? = null

The information that the client will need to know in order to use a given type of authentication. For each login stage type presented, that type may be present as a key in this dictionary. For example, the public key of reCAPTCHA stage could be given here. other example "params": { "m.login.sso": { "identity_providers": { "id": "google", "name": "Google", "icon": "https://..." } } }

session

val session: String? = null

The session identifier that the client must pass back to the homeserver, if one is provided, in subsequent attempts to authenticate in the same API call.

Extensions

nextUncompletedStage

fun RegistrationFlowResponse.nextUncompletedStage(flowIndex: Int = 0): String?

toFlowResult

fun RegistrationFlowResponse.toFlowResult(): FlowResult

Convert to something easier to handle on client side.