Parameters

data class Parameters @JvmOverloads constructor(val phoneNumber: String, val expirationMinutes: Int = DEFAULT_OTP_EXPIRATION_TIME_MINUTES, val enableAutofill: Boolean = false, val autofillSessionDurationMinutes: Int = DEFAULT_SESSION_TIME_MINUTES, val locale: Locale? = null) : Parcelable

Data class used for wrapping parameters used with SMS OTP

Constructors

Link copied to clipboard
constructor(phoneNumber: String, expirationMinutes: Int = DEFAULT_OTP_EXPIRATION_TIME_MINUTES, enableAutofill: Boolean = false, autofillSessionDurationMinutes: Int = DEFAULT_SESSION_TIME_MINUTES, locale: Locale? = null)

Properties

Link copied to clipboard

indicates how long an autofilled session should last

Link copied to clipboard
val enableAutofill: Boolean = false

indicates whether the SMS message should include autofill metadata

Link copied to clipboard

indicates how long the OTP should last before it expires

Link copied to clipboard
val locale: Locale? = null

Used to determine which language to use when sending the user this delivery method. Currently supported languages are English ("en"), Spanish ("es"), and Brazilian Portuguese ("pt-br"); if no value is provided, the copy defaults to English.

Link copied to clipboard

the number the OTP code should be sent to via SMS, in E.164 format (i.e. +1XXXXXXXXXX)