Package com.stytch.sdk.consumer.otp
Class OTP.SmsOTP.Parameters
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class OTP.SmsOTP.Parameters implements Parcelable
Data class used for wrapping parameters used with SMS OTP
-
-
Field Summary
Fields Modifier and Type Field Description private final StringphoneNumberprivate final IntegerexpirationMinutesprivate final BooleanenableAutofillprivate final IntegerautofillSessionDurationMinutesprivate final Localelocale
-
Constructor Summary
Constructors Constructor Description OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill, Integer autofillSessionDurationMinutes, Locale locale)OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill, Integer autofillSessionDurationMinutes)OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill)OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes)OTP.SmsOTP.Parameters(String phoneNumber)
-
Method Summary
Modifier and Type Method Description final StringgetPhoneNumber()the number the OTP code should be sent to via SMS, in E.164 format (i.e. final IntegergetExpirationMinutes()indicates how long the OTP should last before it expires final BooleangetEnableAutofill()indicates whether the SMS message should include autofill metadata final IntegergetAutofillSessionDurationMinutes()indicates how long an autofilled session should last final LocalegetLocale()Used to determine which language to use when sending the user this delivery method. -
-
Constructor Detail
-
OTP.SmsOTP.Parameters
OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill, Integer autofillSessionDurationMinutes, Locale locale)
-
OTP.SmsOTP.Parameters
OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill, Integer autofillSessionDurationMinutes)
-
OTP.SmsOTP.Parameters
OTP.SmsOTP.Parameters(String phoneNumber, Integer expirationMinutes, Boolean enableAutofill)
-
OTP.SmsOTP.Parameters
OTP.SmsOTP.Parameters(String phoneNumber)
-
-
Method Detail
-
getPhoneNumber
final String getPhoneNumber()
the number the OTP code should be sent to via SMS, in E.164 format (i.e. +1XXXXXXXXXX)
-
getExpirationMinutes
final Integer getExpirationMinutes()
indicates how long the OTP should last before it expires
-
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
-
getLocale
final Locale getLocale()
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.
-
-
-
-