Supabase.GoTrue.Schemas.SignInWithOTP behaviour (supabase_gotrue v0.3.10)

This schema is used to validate and parse the parameters for signing in with OTP.

Fields

  • email - The user's email.
  • phone - The user's phone.
  • options - The options for signing in with OTP.
    • data - The data for the sign in.
    • email_redirect_to - The redirect URL for the email.
    • captcha_token - The captcha token.
    • channel - The channel for the OTP.

Summary

Types

changeset()
options()
t()

Callbacks

changeset(t, map)
parse(map)

Functions

parse(attrs)
to_sign_in_params(signin)
to_sign_in_params(signin, code_challenge, code_method)

Types

Link to this opaque

changeset()

@opaque changeset()
Link to this type

options()

@type options() :: %Supabase.GoTrue.Schemas.SignInWithOTP.Options{
  captcha_token: String.t(),
  channel: String.t(),
  data: map(),
  email_redirect_to: String.t(),
  should_create_user: boolean()
}
Link to this type

t()

@type t() :: %Supabase.GoTrue.Schemas.SignInWithOTP{
  email: String.t(),
  options: options(),
  phone: String.t()
}

Callbacks

Link to this callback

changeset(t, map)

(optional) 
@callback changeset(t(), map()) :: changeset()
Link to this callback

parse(map)

(optional) 
@callback parse(map()) :: {:ok, t()} | {:error, changeset()}

Functions

Link to this function

parse(attrs)

Link to this function

to_sign_in_params(signin)

Link to this function

to_sign_in_params(signin, code_challenge, code_method)