Haytni v0.7.0

Haytni.LockablePlugin.Config (Haytni v0.7.0) View Source

Link to this section Summary

Types

t()
unlock_strategy()

Functions

available_strategies()

Returns all available strategies (all possible values for unlock_strategy parameter)

email_strategies()

Returns strategies involving sending emails

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Haytni.LockablePlugin.Config{
  maximum_attempts: pos_integer(),
  unlock_in: Haytni.duration(),
  unlock_keys: [atom(), ...],
  unlock_strategy: unlock_strategy(),
  unlock_within: Haytni.duration()
}
Link to this type

unlock_strategy()

View Source

Specs

unlock_strategy() :: :both | :email | :time | :none

Link to this section Functions

Link to this function

available_strategies()

View Source

Specs

available_strategies() :: [unlock_strategy(), ...]

Returns all available strategies (all possible values for unlock_strategy parameter)

Link to this function

email_strategies()

View Source

Specs

email_strategies() :: [unlock_strategy(), ...]

Returns strategies involving sending emails