authex

v0.1.4

authex v0.1.4 Authex.Banlist behaviour View Source

Link to this section Summary

Types

banlist()
sub()
token_or_sub()

Functions

del(token_or_sub)

Takes an Authex.Token struct or binary sub and deletes it from the banlist using the default banlist

del(module, sub)

Takes an Authex.Token struct or binary sub and deletes it from the banlist using the provided module

get(token_or_sub)

Takes an Authex.Token struct or binary sub and checks if its banned using the default banlist

get(module, sub)

Takes an Authex.Token struct or binary sub and checks whether it has been banned using the provided module

set(token_or_sub)

Takes an Authex.Token struct or binary sub and sets it as being banlisted using the default banlist

set(module, sub)

Takes an Authex.Token struct or binary sub and sets it as being banlisted using the provided module

Callbacks

handle_del(sub)

Removes the provided binary sub from the banlist

handle_get(sub)

Checks whether the banlist contains the provided binary sub

handle_set(sub)

Puts the provided binary sub into the banlist

Link to this section Types

Link to this type banlist() View Source 
banlist() :: atom()
Link to this type sub() View Source 
sub() :: binary()
Link to this type token_or_sub() View Source 
token_or_sub() :: Authex.Token.t() | binary()

Link to this section Functions

Link to this function del(token_or_sub) View Source 
del(token_or_sub()) :: :ok | :error

Takes an Authex.Token struct or binary sub and deletes it from the banlist using the default banlist.

The default banlist is set through the :banlist config option.

See del/2 for further details.

Parameters

  • token_or_sub: An Authex.Token struct or binary sub.
Link to this function del(module, sub) View Source

Takes an Authex.Token struct or binary sub and deletes it from the banlist using the provided module.

Returns :ok if the operation was successful.

Returns :error if an error occured.

Parameters

  • token_or_sub: An Authex.Token struct or binary sub.
Link to this function get(token_or_sub) View Source 
get(token_or_sub()) :: :ok | :error

Takes an Authex.Token struct or binary sub and checks if its banned using the default banlist.

The default banlist is set through the :banlist config option.

See get/2 for further details.

Parameters

  • token_or_sub: An Authex.Token struct or binary sub.
Link to this function get(module, sub) View Source 
get(banlist(), token_or_sub()) :: boolean() | :error

Takes an Authex.Token struct or binary sub and checks whether it has been banned using the provided module.

Returns false if the sub is not banned.

Returns true if the sub is banned.

Otherwise, returns :error.

Parameters

  • banlist: A banlist module.
  • token_or_sub: An Authex.Token struct or binary sub.
Link to this function set(token_or_sub) View Source

Takes an Authex.Token struct or binary sub and sets it as being banlisted using the default banlist.

The default banlist is set through the :banlist config option.

See set/2 for further details.

Parameters

  • token_or_sub: An Authex.Token struct or binary sub.
Link to this function set(module, sub) View Source 
set(banlist(), token_or_sub()) :: :ok | :error
set(banlist(), token_or_sub()) :: :ok | :error

Takes an Authex.Token struct or binary sub and sets it as being banlisted using the provided module.

Returns :ok if the operation was successful.

Returns :error if an error occured.

Parameters

  • banlist: A banlist module.
  • token_or_sub: An Authex.Token struct or binary sub.

Link to this section Callbacks

Link to this callback handle_del(sub) View Source 
handle_del(sub()) :: :ok | :error

Removes the provided binary sub from the banlist.

Returning :ok signals the operation was successful.

Returning :error signals an error occured.

Parameters

  • sub: A binary sub.
Link to this callback handle_get(sub) View Source 
handle_get(sub()) :: boolean() | :error

Checks whether the banlist contains the provided binary sub.

Returning true signals that the sub is banned.

Returning false signals that the sub is not banned.

Returning :error signals an error occured.

Parameters

  • sub: A binary sub.
Link to this callback handle_set(sub) View Source 
handle_set(sub()) :: :ok | :error

Puts the provided binary sub into the banlist.

Returning :ok signals the operation was successful.

Returning :error signals an error occured.

Parameters

  • sub: A binary sub.