Class B2BMagicLinks.EmailMagicLinks.Parameters
-
- All Implemented Interfaces:
public final class B2BMagicLinks.EmailMagicLinks.ParametersData class used for wrapping parameters used with requesting an email magic link
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringemailprivate final StringorganizationIdprivate final StringloginRedirectUrlprivate final StringsignupRedirectUrlprivate final StringloginTemplateIdprivate final StringsignupTemplateIdprivate final Localelocale
-
Constructor Summary
Constructors Constructor Description B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId, String signupTemplateId, Locale locale)B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId, String signupTemplateId)B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId)B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl)B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl)B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId)
-
Method Summary
Modifier and Type Method Description final StringgetEmail()is the account identifier for the account in the form of an Email address where you wish to receive a magic link to authenticate final StringgetOrganizationId()is the member's organization ID final StringgetLoginRedirectUrl()is the url where you should be redirected for login final StringgetSignupRedirectUrl()is the url where you should be redirected for signup final StringgetLoginTemplateId()Use a custom template for login emails. final StringgetSignupTemplateId()Use a custom template for sign-up emails. final LocalegetLocale()Used to determine which language to use when sending the user this delivery method. -
-
Constructor Detail
-
B2BMagicLinks.EmailMagicLinks.Parameters
B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId, String signupTemplateId, Locale locale)
-
B2BMagicLinks.EmailMagicLinks.Parameters
B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId, String signupTemplateId)
-
B2BMagicLinks.EmailMagicLinks.Parameters
B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl, String loginTemplateId)
-
B2BMagicLinks.EmailMagicLinks.Parameters
B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl, String signupRedirectUrl)
-
B2BMagicLinks.EmailMagicLinks.Parameters
B2BMagicLinks.EmailMagicLinks.Parameters(String email, String organizationId, String loginRedirectUrl)
-
-
Method Detail
-
getEmail
final String getEmail()
is the account identifier for the account in the form of an Email address where you wish to receive a magic link to authenticate
-
getOrganizationId
final String getOrganizationId()
is the member's organization ID
-
getLoginRedirectUrl
final String getLoginRedirectUrl()
is the url where you should be redirected for login
-
getSignupRedirectUrl
final String getSignupRedirectUrl()
is the url where you should be redirected for signup
-
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 Magic links - Login.
-
getSignupTemplateId
final String getSignupTemplateId()
Use a custom template for sign-up 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 Magic links - Sign-up.
-
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.
-
-
-
-