SendParameters

data class SendParameters @JvmOverloads constructor(val organizationId: String, val memberId: String, val mfaPhoneNumber: String? = null, val locale: Locale? = null, val enableAutofill: Boolean = false, val autofillSessionDurationMinutes: Int = DEFAULT_SESSION_TIME_MINUTES)

A data class wrapping the parameters needed to send an SMS OTP

Constructors

Link copied to clipboard
constructor(organizationId: String, memberId: String, mfaPhoneNumber: String? = null, locale: Locale? = null, enableAutofill: Boolean = false, autofillSessionDurationMinutes: Int = DEFAULT_SESSION_TIME_MINUTES)

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
val locale: Locale? = null

The locale is used to determine which language to use in the email. Parameter is a []IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. "en". 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 ID of the member to send the OTP to

Link copied to clipboard
val mfaPhoneNumber: String? = null

The phone number to send the OTP to. If the member already has a phone number, this argument is not needed. If the member does not have a phone number and this argument is not provided, an error will be thrown.

Link copied to clipboard

The ID of the organization the member belongs to