Class MagicLinks.EmailMagicLinks.Parameters
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class MagicLinks.EmailMagicLinks.Parameters implements Parcelable
Data class used for wrapping parameters used with MagicLinks.EmailMagicLinks.loginOrCreate
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringemailprivate final StringloginMagicLinkUrlprivate final StringsignupMagicLinkUrlprivate final IntegerloginExpirationMinutesprivate final IntegersignupExpirationMinutesprivate final StringloginTemplateIdprivate final StringsignupTemplateIdprivate final Localelocale
-
Constructor Summary
Constructors Constructor Description MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId, String signupTemplateId, Locale locale)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId, String signupTemplateId)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl)MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl)MagicLinks.EmailMagicLinks.Parameters(String email)
-
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 StringgetLoginMagicLinkUrl()is the url where you should be redirected for login final StringgetSignupMagicLinkUrl()is the url where you should be redirected for signup final IntegergetLoginExpirationMinutes()is the duration after which the login url should expire final IntegergetSignupExpirationMinutes()is the duration after which the signup url should expire 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
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId, String signupTemplateId, Locale locale)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId, String signupTemplateId)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes, String loginTemplateId)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes, Integer signupExpirationMinutes)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl, Integer loginExpirationMinutes)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl, String signupMagicLinkUrl)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email, String loginMagicLinkUrl)
-
MagicLinks.EmailMagicLinks.Parameters
MagicLinks.EmailMagicLinks.Parameters(String email)
-
-
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
-
getLoginMagicLinkUrl
final String getLoginMagicLinkUrl()
is the url where you should be redirected for login
-
getSignupMagicLinkUrl
final String getSignupMagicLinkUrl()
is the url where you should be redirected for signup
-
getLoginExpirationMinutes
final Integer getLoginExpirationMinutes()
is the duration after which the login url should expire
-
getSignupExpirationMinutes
final Integer getSignupExpirationMinutes()
is the duration after which the signup url should expire
-
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.
-
-
-
-