Clerk Android API/com.clerk.api.phonenumber

Package-level declarations

Types

@Serializable

data class PhoneNumber(val id: String, val phoneNumber: String, val verification: Verification? = null, val reservedForSecondFactor: Boolean = false, val defaultSecondFactor: Boolean = false, val createdAt: Long? = null, val updatedAt: Long? = null, val linkedTo: List<String>? = null, val backupCodes: List<String>? = null)

The PhoneNumber object is a model around a phone number entity.

Properties

val PhoneNumber.isPrimary: Boolean

Convenience function for telling whether or not the phone number is the primary one

val PhoneNumber.isVerified: Boolean

Convenience function for telling whether or not the phone number is verified

Functions

attemptVerification

suspend fun PhoneNumber.attemptVerification(code: String): ClerkResult<PhoneNumber, ClerkErrorResponse>

Attempts to verify this phone number using the provided verification code.

suspend fun PhoneNumber.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes this phone number from the user's account.

makeDefaultSecondFactor

suspend fun PhoneNumber.makeDefaultSecondFactor(): ClerkResult<PhoneNumber, ClerkErrorResponse>

Sets this phone number as the default for multi-factor authentication.

prepareVerification

suspend fun PhoneNumber.prepareVerification(): ClerkResult<PhoneNumber, ClerkErrorResponse>

Initiates the phone number verification process by sending a verification code via SMS.

suspend fun PhoneNumber.sendCode(): ClerkResult<PhoneNumber, ClerkErrorResponse>

Sends a verification code to this phone number via SMS.

setReservedForSecondFactor

suspend fun PhoneNumber.setReservedForSecondFactor(reservedForSecondFactor: Boolean): ClerkResult<PhoneNumber, ClerkErrorResponse>

Sets whether this phone number is reserved for multi-factor authentication.

suspend fun PhoneNumber.update(reservedForSecondFactor: Boolean? = null, defaultSecondFactor: Boolean? = null): ClerkResult<PhoneNumber, ClerkErrorResponse>

Updates the properties of this phone number.

suspend fun PhoneNumber.verifyCode(code: String): ClerkResult<PhoneNumber, ClerkErrorResponse>

Verifies this phone number using the provided verification code.