Class OTP.SMS.SendParameters
-
- All Implemented Interfaces:
public final class OTP.SMS.SendParametersA data class wrapping the parameters needed to send an SMS OTP
-
-
Field Summary
Fields Modifier and Type Field Description private final StringorganizationIdprivate final StringmemberIdprivate final StringmfaPhoneNumberprivate final Localelocaleprivate final BooleanenableAutofillprivate final IntegerautofillSessionDurationMinutes
-
Constructor Summary
Constructors Constructor Description OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale, Boolean enableAutofill, Integer autofillSessionDurationMinutes)OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale, Boolean enableAutofill)OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale)OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber)OTP.SMS.SendParameters(String organizationId, String memberId)
-
Method Summary
Modifier and Type Method Description final StringgetOrganizationId()The ID of the organization the member belongs to final StringgetMemberId()The ID of the member to send the OTP to final StringgetMfaPhoneNumber()The phone number to send the OTP to. final LocalegetLocale()The locale is used to determine which language to use in the email. final BooleangetEnableAutofill()indicates whether the SMS message should include autofill metadata final IntegergetAutofillSessionDurationMinutes()indicates how long an autofilled session should last -
-
Constructor Detail
-
OTP.SMS.SendParameters
OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale, Boolean enableAutofill, Integer autofillSessionDurationMinutes)
-
OTP.SMS.SendParameters
OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale, Boolean enableAutofill)
-
OTP.SMS.SendParameters
OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber, Locale locale)
-
OTP.SMS.SendParameters
OTP.SMS.SendParameters(String organizationId, String memberId, String mfaPhoneNumber)
-
-
Method Detail
-
getOrganizationId
final String getOrganizationId()
The ID of the organization the member belongs to
-
getMemberId
final String getMemberId()
The ID of the member to send the OTP to
-
getMfaPhoneNumber
final String getMfaPhoneNumber()
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.
-
getLocale
final Locale getLocale()
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.
-
getEnableAutofill
final Boolean getEnableAutofill()
indicates whether the SMS message should include autofill metadata
-
getAutofillSessionDurationMinutes
final Integer getAutofillSessionDurationMinutes()
indicates how long an autofilled session should last
-
-
-
-