Pow v1.0.1 Pow.Plug View Source
Plug helper methods.
Link to this section Summary
Functions
Assign an authenticated user to the connection
Authenticates a user
Creates a changeset from the current authenticated user
Clears the user authentication from the session
Creates a new user
Get the current authenticated user
Deletes the current authenticated user
Fetch configuration from the private key in the connection
Prepend namespace found in Plug Pow configuration to binary
Put the provided config as a private key in the connection
Updates the current authenticated user
Link to this section Functions
assign_current_user(conn, user, config)
View Source
assign_current_user(Plug.Conn.t(), any(), Pow.Config.t()) :: Plug.Conn.t()
assign_current_user(Plug.Conn.t(), any(), Pow.Config.t()) :: Plug.Conn.t()
Assign an authenticated user to the connection.
authenticate_user(conn, params)
View Source
authenticate_user(Plug.Conn.t(), map()) :: {:ok | :error, Plug.Conn.t()}
authenticate_user(Plug.Conn.t(), map()) :: {:ok | :error, Plug.Conn.t()}
Authenticates a user.
If successful, a new session will be created.
change_user(conn, params \\ %{})
View Source
change_user(Plug.Conn.t(), map()) :: map()
change_user(Plug.Conn.t(), map()) :: map()
Creates a changeset from the current authenticated user.
clear_authenticated_user(conn)
View Source
clear_authenticated_user(Plug.Conn.t()) :: {:ok, Plug.Conn.t()}
clear_authenticated_user(Plug.Conn.t()) :: {:ok, Plug.Conn.t()}
Clears the user authentication from the session.
create_user(conn, params)
View Source
create_user(Plug.Conn.t(), map()) ::
{:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
create_user(Plug.Conn.t(), map()) :: {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
Creates a new user.
If successful, a new session will be created.
current_user(conn)
View Source
current_user(Plug.Conn.t()) :: map() | nil
current_user(Plug.Conn.t()) :: map() | nil
current_user(map, config)
View Source
current_user(Plug.Conn.t(), Pow.Config.t()) :: map() | nil
current_user(Plug.Conn.t(), Pow.Config.t()) :: map() | nil
Get the current authenticated user.
delete_user(conn)
View Source
delete_user(Plug.Conn.t()) ::
{:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
delete_user(Plug.Conn.t()) :: {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
Deletes the current authenticated user.
If successful, the user authentication will be cleared from the session.
fetch_config(conn)
View Source
fetch_config(Plug.Conn.t()) :: Pow.Config.t()
fetch_config(Plug.Conn.t()) :: Pow.Config.t()
Fetch configuration from the private key in the connection.
It'll raise an error if configuration hasn't been set as a private key.
get_mod(config)
View Source
get_mod(Pow.Config.t()) :: atom() | nil
get_mod(Pow.Config.t()) :: atom() | nil
prepend_with_namespace(config, string)
View Source
prepend_with_namespace(Pow.Config.t(), binary()) :: binary()
prepend_with_namespace(Pow.Config.t(), binary()) :: binary()
Prepend namespace found in Plug Pow configuration to binary.
Will prepend :otp_app
if exists in configuration.
put_config(conn, config)
View Source
put_config(Plug.Conn.t(), Pow.Config.t()) :: Plug.Conn.t()
put_config(Plug.Conn.t(), Pow.Config.t()) :: Plug.Conn.t()
Put the provided config as a private key in the connection.
update_user(conn, params)
View Source
update_user(Plug.Conn.t(), map()) ::
{:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
update_user(Plug.Conn.t(), map()) :: {:ok, map(), Plug.Conn.t()} | {:error, map(), Plug.Conn.t()}
Updates the current authenticated user.
If successful, a new session will be created.