CPub.Web.Authorization.Token (CPub v0.3.0) View Source

An OAuth 2.0 Token that can be used to access ressources.

Link to this section Summary

Types

t()

Functions

create(authorization)

Creates a new (initial) token for an Authorization.

expired?(token)

Returns true if the Token is expired and can no longer be used to access a ressource.

get(access_token)

Get token by access token.

refresh(authorization)

Creates a refreshed token for an Authorization.

valid_for()

Returns the numer of seconds the Token is valid for after creation.

Link to this section Types

t()

Specs

t() :: %CPub.Web.Authorization.Token{
  __meta__: term(),
  access_token: String.t(),
  authorization: String.t(),
  created_at: NaiveDateTime.t(),
  id: String.t()
}

Link to this section Functions

create(authorization)

Specs

create(CPub.Web.Authorization.t()) :: {:ok, t()} | {:error, any()}

Creates a new (initial) token for an Authorization.

expired?(token)

Specs

expired?(t()) :: bool()

Returns true if the Token is expired and can no longer be used to access a ressource.

get(access_token)

Specs

get(String.t()) :: {:ok, t()} | {:error, any()}

Get token by access token.

refresh(authorization)

Specs

refresh(CPub.Web.Authorization.t()) :: {:ok, t()} | {:error, any()}

Creates a refreshed token for an Authorization.

valid_for()

Specs

valid_for() :: non_neg_integer()

Returns the numer of seconds the Token is valid for after creation.