Pow v1.0.16 Pow.Phoenix.Routes behaviour View Source

Module that handles routes.

Usage

defmodule MyAppWeb.Pow.Routes do
  use Pow.Phoenix.Routes
  alias MyAppWeb.Router.Helpers, as: Routes

  @impl true
  def after_sign_out_path(conn), do: Routes.some_path(conn, :index)
end

Update configuration with routes_backend: MyAppWeb.Pow.Routes.

You can also customize path generation:

defmodule MyAppWeb.Pow.Routes do
  use Pow.Phoenix.Routes
  alias MyAppWeb.Router.Helpers, as: Routes

  @impl true
  def url_for(conn, verb, vars \ [], query_params \ [])
  def url_for(conn, PowEmailConfirmation.Phoenix.ConfirmationController, :show, [token], _query_params),
    do: Routes.custom_confirmation_url(conn, :new, token)
  def url_for(conn, plug, verb, vars, query_params),
    do: Pow.Phoenix.Routes.url_for(conn, plug, verb, vars, query_params)
end

Link to this section Summary

Functions

after_registration_path(conn)

Path to redirect user to when user has signed up.

after_sign_in_path(arg1)

Path to redirect user to when user has signed in.

after_sign_out_path(conn)

Path to redirect user to when user has signed out.

after_user_deleted_path(conn)

Path to redirect user to when user has deleted their account.

after_user_updated_path(conn)

Path to redirect user to when user has updated their account.

path_for(conn, plug, verb, vars \\ [], query_params \\ [])

Generates a path route.

url_for(conn, plug, verb, vars \\ [], query_params \\ [])

Generates a url route.

user_already_authenticated_path(conn)

Path to redirect user to when user has already been authenticated.

user_not_authenticated_path(conn)

Path to redirect user to when user is not authenticated.

Callbacks

after_registration_path(arg1)

after_sign_in_path(arg1)

after_sign_out_path(arg1)

after_user_deleted_path(arg1)

after_user_updated_path(arg1)

path_for(arg1, atom, atom, list, arg5)

registration_path(arg1, atom)

session_path(arg1, atom, list)

url_for(arg1, atom, atom, list, arg5)

user_already_authenticated_path(arg1)

user_not_authenticated_path(arg1)

Link to this section Functions

after_registration_path(conn)

Path to redirect user to when user has signed up.

By default this is the same as after_sign_in_path/1.

after_sign_in_path(arg1)

Path to redirect user to when user has signed in.

This will look for a :request_path assigns key, and redirect to this value if it exists.

after_sign_out_path(conn)

Path to redirect user to when user has signed out.

after_user_deleted_path(conn)

Path to redirect user to when user has deleted their account.

By default this is the same as after_sign_out_path/1.

after_user_updated_path(conn)

Path to redirect user to when user has updated their account.

path_for(conn, plug, verb, vars \\ [], query_params \\ [])

path_for(Plug.Conn.t(), atom(), atom(), list(), Keyword.t()) :: binary()

Generates a path route.

url_for(conn, plug, verb, vars \\ [], query_params \\ [])

url_for(Plug.Conn.t(), atom(), atom(), list(), Keyword.t()) :: binary()

Generates a url route.

user_already_authenticated_path(conn)

Path to redirect user to when user has already been authenticated.

By default this is the same as after_sign_in_path/1.

user_not_authenticated_path(conn)

Path to redirect user to when user is not authenticated.

This will put a :request_path param into the path that can be used to redirect users back the the page they first attempted to visit. See after_sign_in_path/1 for how :request_path is handled.

The :request_path will only be added if the request uses "GET" method.

See Pow.Phoenix.SessionController for more on how this value is handled.

Link to this section Callbacks

after_registration_path(arg1)

after_registration_path(Plug.Conn.t()) :: binary()

after_sign_in_path(arg1)

after_sign_in_path(Plug.Conn.t()) :: binary()

after_sign_out_path(arg1)

after_sign_out_path(Plug.Conn.t()) :: binary()

after_user_deleted_path(arg1)

after_user_deleted_path(Plug.Conn.t()) :: binary()

after_user_updated_path(arg1)

after_user_updated_path(Plug.Conn.t()) :: binary()

path_for(arg1, atom, atom, list, arg5)

path_for(Plug.Conn.t(), atom(), atom(), list(), Keyword.t()) :: binary()

registration_path(arg1, atom)

registration_path(Plug.Conn.t(), atom()) :: binary()

session_path(arg1, atom, list)

session_path(Plug.Conn.t(), atom(), list()) :: binary()

url_for(arg1, atom, atom, list, arg5)

url_for(Plug.Conn.t(), atom(), atom(), list(), Keyword.t()) :: binary()

user_already_authenticated_path(arg1)

user_already_authenticated_path(Plug.Conn.t()) :: binary()

user_not_authenticated_path(arg1)

user_not_authenticated_path(Plug.Conn.t()) :: binary()