Package-level declarations

Types

@Serializable

data class SignUp(val id: String, val status: SignUp.Status = Status.UNKNOWN, val requiredFields: List<String>, val optionalFields: List<String>, val missingFields: List<String>, val unverifiedFields: List<String>, val verifications: Map<String, Verification?>, val username: String? = null, val emailAddress: String? = null, val phoneNumber: String? = null, val passwordEnabled: Boolean, val firstName: String? = null, val lastName: String? = null, val unsafeMetadata: JsonObject? = null, val createdSessionId: String? = null, val createdUserId: String? = null, val abandonedAt: Long? = null)

The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up process. Once a sign-up is complete, a new user is created.

Properties

firstFieldToCollect

val SignUp.firstFieldToCollect: String?

Helper property to get the first field that needs to be collected.

firstFieldToVerify

val SignUp.firstFieldToVerify: String?

Helper property to get the first field that needs to be verified.

Functions

attemptVerification

suspend fun SignUp.attemptVerification(params: SignUp.AttemptVerificationParams): ClerkResult<SignUp, ClerkErrorResponse>

Attempts to complete the verification process.

prepareVerification

suspend fun SignUp.prepareVerification(prepareVerification: SignUp.PrepareVerificationParams.Strategy): ClerkResult<SignUp, ClerkErrorResponse>

Prepares verification for the specified strategy.

sendCode

suspend fun SignUp.sendCode(block: SendCodeBuilder.() -> Unit): ClerkResult<SignUp, ClerkErrorResponse>

Sends a verification code to the specified email or phone.

sendEmailCode

suspend fun SignUp.sendEmailCode(): ClerkResult<SignUp, ClerkErrorResponse>

Sends a verification code to the email address associated with this sign-up.

sendPhoneCode

suspend fun SignUp.sendPhoneCode(): ClerkResult<SignUp, ClerkErrorResponse>

Sends a verification code to the phone number associated with this sign-up.

toMap

fun ERROR CLASS: Symbol not found for SignUp.AuthenticateWithRedirectParams.toMap(): Map<String, String>

fun ERROR CLASS: Symbol not found for SignUp.CreateParams.toMap(): Map<String, String>

fun ERROR CLASS: Symbol not found for SignUp.SignUpUpdateParams.toMap(): Map<String, String>

fun ERROR CLASS: Symbol not found for SignUp.AuthenticateWithRedirectParams.toMap(): Map<String, String>

fun ERROR CLASS: Symbol not found for SignUp.CreateParams.toMap(): Map<String, String>

fun ERROR CLASS: Symbol not found for SignUp.SignUpUpdateParams.toMap(): Map<String, String>

update

suspend fun SignUp.update(updateParams: SignUp.SignUpUpdateParams): ClerkResult<SignUp, ClerkErrorResponse>

suspend fun SignUp.update(block: SignUpBuilder.() -> Unit): ClerkResult<SignUp, ClerkErrorResponse>

Updates the sign-up with additional information.

verifyCode

suspend fun SignUp.verifyCode(code: String, type: VerificationType): ClerkResult<SignUp, ClerkErrorResponse>

Verifies with the provided code and type.