Raxol.Core.UserPreferences.Behaviour behaviour (Raxol v0.3.0)
View SourceDefines the behaviour for UserPreferences services.
Summary
Callbacks
Gets a user preference value by key path.
Retrieves the entire preferences map.
Forces an immediate save of the current preferences.
Sets a user preference value by key path.
Callbacks
@callback get( key_or_path :: atom() | [atom()] | String.t(), pid_or_name :: GenServer.server() | atom() | nil ) :: any()
Gets a user preference value by key path.
@callback get_all() :: map()
@callback get_all(pid_or_name :: GenServer.server() | atom() | nil) :: map()
Retrieves the entire preferences map.
@callback save!() :: :ok | {:error, any()}
@callback save!(pid_or_name :: GenServer.server() | atom() | nil) :: :ok | {:error, any()}
Forces an immediate save of the current preferences.
@callback set( key_or_path :: atom() | [atom()] | String.t(), value :: any(), pid_or_name :: GenServer.server() | atom() | nil ) :: :ok
Sets a user preference value by key path.