Auctoritas

v0.9.1

Auctoritas v0.9.1 Auctoritas.DataStorage.Data View Source

Link to this section Summary

Types

expiration()

Token expiration in seconds

inserted_at()

When was token inserted (UNIX Epoch time)

metadata()
t()

Data struct with data and metadata maps

  • data is data associated when inserting token into data_storage
  • metadata contains inserted_at, updated_at, expires_in time inserted when using get_token_data function from data_storage
token()

Refresh token

updated_at()

When was token updated (UNIX Epoch time)

Functions

add_expiration(data, expiration)
decode(data_json)
encode(data)
get_data(data)
get_metadata(data)
get_refresh_token(data)
initial_metadata(expiration)
new(data_map)
new(data, expiration)
new(data, refresh_token, expiration)
update_data(data, new_data)
update_metadata(data, new_metadata)

Link to this section Types

Link to this type

expiration() View Source 
expiration() :: non_neg_integer()

Token expiration in seconds

Link to this type

inserted_at() View Source 
inserted_at() :: non_neg_integer()

When was token inserted (UNIX Epoch time)

Link to this type

metadata() View Source 
metadata() :: %{
  inserted_at: inserted_at(),
  updated_at: updated_at(),
  expires_in: expiration()
}

Link to this type

t() View Source 
t() :: %Auctoritas.DataStorage.Data{
  data: map(),
  metadata: metadata(),
  refresh_token: token() | nil
}

Data struct with data and metadata maps

  • data is data associated when inserting token into data_storage
  • metadata contains inserted_at, updated_at, expires_in time inserted when using get_token_data function from data_storage
Link to this type

token() View Source 
token() :: String.t()

Refresh token

Link to this type

updated_at() View Source 
updated_at() :: non_neg_integer()

When was token updated (UNIX Epoch time)

Link to this section Functions

Link to this function

add_expiration(data, expiration) View Source 
add_expiration(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  },
  expiration :: expiration()
) :: %Auctoritas.DataStorage.Data{
  data: term(),
  metadata: term(),
  refresh_token: term()
}

Link to this function

decode(data_json) View Source

Link to this function

encode(data) View Source

Link to this function

get_data(data) View Source 
get_data(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  }
) :: map()

Link to this function

get_metadata(data) View Source 
get_metadata(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  }
) :: map()

Link to this function

get_refresh_token(data) View Source 
get_refresh_token(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  }
) :: token()

Link to this function

initial_metadata(expiration) View Source 
initial_metadata(expiration :: expiration()) :: metadata()

Link to this function

new(data_map) View Source 
new(data_map :: map()) :: %Auctoritas.DataStorage.Data{
  data: term(),
  metadata: term(),
  refresh_token: term()
}

Link to this function

new(data, expiration) View Source 
new(data :: map(), expiration :: expiration()) :: %Auctoritas.DataStorage.Data{
  data: term(),
  metadata: term(),
  refresh_token: term()
}

Link to this function

new(data, refresh_token, expiration) View Source 
new(data :: map(), refresh_token :: token(), expiration :: expiration()) ::
  %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  }

Link to this function

update_data(data, new_data) View Source 
update_data(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  },
  data :: map()
) :: %Auctoritas.DataStorage.Data{
  data: term(),
  metadata: term(),
  refresh_token: term()
}

Link to this function

update_metadata(data, new_metadata) View Source 
update_metadata(
  data :: %Auctoritas.DataStorage.Data{
    data: term(),
    metadata: term(),
    refresh_token: term()
  },
  new_metadata :: map()
) :: %Auctoritas.DataStorage.Data{
  data: term(),
  metadata: term(),
  refresh_token: term()
}