View Source KeenAuth.Storage behaviour (KeenAuth v0.2.2)

Summary

Callbacks

@callback authenticated?(conn :: Plug.Conn.t()) :: boolean()
@callback current_user(conn :: Plug.Conn.t()) :: any() | nil
@callback delete(conn :: Plug.Conn.t()) :: Plug.Conn.t()
@callback get_access_token(conn :: Plug.Conn.t()) :: binary() | nil
@callback get_id_token(conn :: Plug.Conn.t()) :: binary() | nil
@callback get_provider(conn :: Plug.Conn.t()) :: binary() | nil
@callback get_refresh_token(conn :: Plug.Conn.t()) :: binary() | nil
Link to this callback

put_current_user(conn, provider, arg3)

View Source
@callback put_current_user(
  conn :: Plug.Conn.t(),
  provider :: atom(),
  KeenAuth.User.t() | map()
) ::
  Plug.Conn.t()
Link to this callback

put_provider(conn, provider)

View Source
@callback put_provider(conn :: Plug.Conn.t(), provider :: atom()) :: Plug.Conn.t()
Link to this callback

put_tokens(conn, provider, tokens_map)

View Source
@callback put_tokens(
  conn :: Plug.Conn.t(),
  provider :: atom(),
  KeenAuth.AuthenticationController.tokens_map()
) :: Plug.Conn.t()
Link to this callback

store(conn, provider, mapped_user, oauth_response)

View Source
@callback store(
  conn :: Plug.Conn.t(),
  provider :: atom(),
  mapped_user :: KeenAuth.User.t() | map(),
  oauth_response ::
    KeenAuth.AuthenticationController.oauth_callback_response() | nil
) :: {:ok, Plug.Conn.t()}

Functions