Clerk Android/com.clerk.emailaddress

Package-level declarations

Types

Link copied to clipboard
@Serializable
data class EmailAddress(val id: String, val emailAddress: String, val verification: Verification? = null, val linkedTo: List<EmailAddress.LinkedEntity>? = null)

The EmailAddress object represents an email address associated with a user.

Properties

Link copied to clipboard
val EmailAddress.isPrimary: Boolean

Convenience function to tell whether the email is the user's primary email.

Link copied to clipboard
val EmailAddress.isVerified: Boolean

Convenience function to tell whether the email is verified.

Functions

Link copied to clipboard
suspend fun EmailAddress.attemptVerification(code: String): ClerkResult<EmailAddress, ClerkErrorResponse>

Attempts to verify the email address with the given code.

Link copied to clipboard
suspend fun EmailAddress.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes the EmailAddress from the server.

Link copied to clipboard
suspend fun EmailAddress.get(): ClerkResult<EmailAddress, ClerkErrorResponse>

Retrieves the EmailAddress from the server.

Link copied to clipboard
suspend fun EmailAddress.prepareVerification(params: EmailAddress.PrepareVerificationParams): ClerkResult<EmailAddress, ClerkErrorResponse>

Prepares the email address for verification using the specified strategy.