Class OTP.Email.LoginOrSignupParameters
-
- All Implemented Interfaces:
public final class OTP.Email.LoginOrSignupParametersA data class wrapping the parameters needed to send an Email OTP LoginOrSignup request
-
-
Field Summary
Fields Modifier and Type Field Description private final StringorganizationIdprivate final StringemailAddressprivate final StringloginTemplateIdprivate final StringsignupTemplateIdprivate final Localelocale
-
Constructor Summary
Constructors Constructor Description OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId, String signupTemplateId, Locale locale)OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId, String signupTemplateId)OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId)OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress)
-
Method Summary
Modifier and Type Method Description final StringgetOrganizationId()The ID of the organization the member belongs to final StringgetEmailAddress()The email address of the member final StringgetLoginTemplateId()Use a custom template for login emails. final StringgetSignupTemplateId()Use a custom template for sign-up emails. final LocalegetLocale()The locale is used to determine which language to use in the email. -
-
Constructor Detail
-
OTP.Email.LoginOrSignupParameters
OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId, String signupTemplateId, Locale locale)
-
OTP.Email.LoginOrSignupParameters
OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId, String signupTemplateId)
-
OTP.Email.LoginOrSignupParameters
OTP.Email.LoginOrSignupParameters(String organizationId, String emailAddress, String loginTemplateId)
-
-
Method Detail
-
getOrganizationId
final String getOrganizationId()
The ID of the organization the member belongs to
-
getEmailAddress
final String getEmailAddress()
The email address of the member
-
getLoginTemplateId
final String getLoginTemplateId()
Use a custom template for login emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for
-
getSignupTemplateId
final String getSignupTemplateId()
Use a custom template for sign-up emails. By default, it will use your default OTP - Login. email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - Sign-up.
-
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.
-
-
-
-