Class OTP.SMS.SendParameters

  • All Implemented Interfaces:

    
    public final class OTP.SMS.SendParameters
    
                        

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

    • 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)
      • OTP.SMS.SendParameters

        OTP.SMS.SendParameters(String organizationId, String memberId)
    • Method Detail

      • 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