YipyipExAuth.Utils (YipyipExAuth v0.3.1) 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

Link to this function

get_access_token_payload(conn)

View Source

Specs

get_access_token_payload(Plug.Conn.t()) :: map() | nil

Get access token payload, if present.

Specs

get_auth_error(Plug.Conn.t()) :: binary() | nil

Get auth error, if present.

Link to this function

get_refresh_token_payload(conn)

View Source

Specs

get_refresh_token_payload(Plug.Conn.t()) :: map() | nil

Get refresh token payload, if present.

Specs

get_session(Plug.Conn.t()) :: YipyipExAuth.Models.Session.t() | nil

Get current session, if present.

Link to this function

get_token_signature_transport(conn)

View Source

Specs

get_token_signature_transport(Plug.Conn.t()) :: atom() | nil

Get token signature transport mechanism, if present.

Specs

get_tokens(Plug.Conn.t()) :: YipyipExAuth.Models.Tokens.t() | nil

Get tokens, if present.

Specs

get_user_id(Plug.Conn.t()) :: any()

Get user id for session creation, if present.

Link to this function

set_token_signature_transport(conn, token_signature_transport)

View Source

Specs

set_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
Link to this function

set_user_id(conn, user_id)

View Source

Specs

set_user_id(Plug.Conn.t(), any()) :: Plug.Conn.t()

Set user id for session creation