YipyipExAuth v0.2.0-alpha.1 YipyipExAuth.Utils View Source
Utility functions, mainly getters and setters for module internals.
Link to this section Summary
Functions
Get access token payload, if present.
Get auth error, if present.
Get refresh token payload, if present.
Get current session, if present.
Get token signature transport mechanism, if present.
Get tokens, if present.
Get user id for session creation, if present.
Set token signature transport mechanism. Must be one of
"bearer"
, "cookie"
, :bearer
or :cookie
.
Set user id for session creation
Link to this section Functions
get_access_token_payload(conn)
View Sourceget_access_token_payload(Plug.Conn.t()) :: map() | nil
Get access token payload, if present.
get_auth_error(conn)
View Sourceget_auth_error(Plug.Conn.t()) :: binary() | nil
Get auth error, if present.
get_refresh_token_payload(conn)
View Sourceget_refresh_token_payload(Plug.Conn.t()) :: map() | nil
Get refresh token payload, if present.
get_session(conn)
View Sourceget_session(Plug.Conn.t()) :: YipyipExAuth.Models.Session.t() | nil
Get current session, if present.
get_token_signature_transport(conn)
View Sourceget_token_signature_transport(Plug.Conn.t()) :: atom() | nil
Get token signature transport mechanism, if present.
get_tokens(conn)
View Sourceget_tokens(Plug.Conn.t()) :: YipyipExAuth.Models.Tokens.t() | nil
Get tokens, if present.
Get user id for session creation, if present.
set_token_signature_transport(conn, token_signature_transport)
View Sourceset_token_signature_transport(Plug.Conn.t(), binary() | :bearer | :cookie) :: Plug.Conn.t()
Set token signature transport mechanism. Must be one of
"bearer"
, "cookie"
, :bearer
or :cookie
.
Examples / doctests
iex> :bearer = %Conn{} |> set_token_signature_transport("bearer") |> get_token_signature_transport()
iex> :bearer = %Conn{} |> set_token_signature_transport(:bearer) |> get_token_signature_transport()
iex> :cookie = %Conn{} |> set_token_signature_transport("cookie") |> get_token_signature_transport()
iex> :cookie = %Conn{} |> set_token_signature_transport(:cookie) |> get_token_signature_transport()
iex> set_token_signature_transport(%Conn{}, "anything else")
** (FunctionClauseError) no function clause matching in YipyipExAuth.Utils.set_token_signature_transport/2
set_user_id(conn, user_id)
View Sourceset_user_id(Plug.Conn.t(), any()) :: Plug.Conn.t()
Set user id for session creation