Steamex v0.0.9 Steamex.Auth.Phoenix.View View Source

View helpers for using Steamex auth with Phoenix.

Link to this section Summary

Functions

Returns the URL that the user must visit to begin the Steam authentication process

Link to this section Functions

Link to this function steamex_auth_url(conn, options \\ []) View Source
steamex_auth_url(Plug.Conn.t(), Keyword.t()) :: String.t()

Returns the URL that the user must visit to begin the Steam authentication process.

You can pass the option :redirect_to in order to redirect to a page other than the default upon successful authentication. This option allows any path to be specified, but this value will be validated to ensure it is a local path upon successful authentication.

You can override the Steamex auth return_to helper name (by default, it is :steamex_auth_return_to_url) by passing the option :return_to_helper. If you have used the default options for steamex_route_auth, you do not need to set this option.