Stytch Android/com.stytch.sdk.consumer.magicLinks/MagicLinks/EmailMagicLinks/Parameters

Parameters

data class Parameters @JvmOverloads constructor(val email: String, val loginMagicLinkUrl: String? = null, val signupMagicLinkUrl: String? = null, val loginExpirationMinutes: Int? = null, val signupExpirationMinutes: Int? = null, val loginTemplateId: String? = null, val signupTemplateId: String? = null, val locale: Locale? = null) : Parcelable

Data class used for wrapping parameters used with MagicLinks.EmailMagicLinks.loginOrCreate

Constructors

Parameters

@JvmOverloads

constructor(email: String, loginMagicLinkUrl: String? = null, signupMagicLinkUrl: String? = null, loginExpirationMinutes: Int? = null, signupExpirationMinutes: Int? = null, loginTemplateId: String? = null, signupTemplateId: String? = null, locale: Locale? = null)

Properties

val email: String

is the account identifier for the account in the form of an Email address where you wish to receive a magic link to authenticate

locale

val locale: Locale? = null

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.

loginExpirationMinutes

val loginExpirationMinutes: Int? = null

is the duration after which the login url should expire

loginMagicLinkUrl

val loginMagicLinkUrl: String? = null

is the url where you should be redirected for login

loginTemplateId

val loginTemplateId: String? = null

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.

signupExpirationMinutes

val signupExpirationMinutes: Int? = null

is the duration after which the signup url should expire

signupMagicLinkUrl

val signupMagicLinkUrl: String? = null

is the url where you should be redirected for signup

signupTemplateId

val signupTemplateId: String? = null

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.