ccp/com.ezzy.ccp.countrypicker.phone/PhoneVerificationState

PhoneVerificationState

sealed interface PhoneVerificationState(source)

Where a phone number is in the verification flow.

This is the whole observable surface of verification: a host that supplies its own OTP screen can drive it from these states and ignore the library's UI entirely.

Inheritors

Types

CodeSent

@Immutable

data class CodeSent(val verificationId: String, val destination: String, val resendAvailableAtMillis: Long? = null) : PhoneVerificationState

A code was sent and the user is expected to enter it.

Expired

data object Expired : PhoneVerificationState

The challenge timed out. The user must request a new code.

Failed

@Immutable

data class Failed(val message: UiText, val verificationId: String? = null, val retryable: Boolean = true) : PhoneVerificationState

A step failed. The user can act again.

Idle

data object Idle : PhoneVerificationState

Nothing started, or the number changed and any prior verification was invalidated.

SendingCode

data object SendingCode : PhoneVerificationState

A code request is in flight. Duplicate requests are rejected while in this state.

Verified

@Immutable

data class Verified(val e164Number: String) : PhoneVerificationState

The number is verified.

Verifying

@Immutable

data class Verifying(val verificationId: String) : PhoneVerificationState

A submitted code is being checked.

Properties

activeVerificationId

open val activeVerificationId: String?

The active challenge id, if any.

isInProgress

open val isInProgress: Boolean

True while a network call is in flight, for progress indicators and input blocking.