View Source Teiserver.Settings.SiteSettingLib (Teiserver v0.0.1)
Library of site_setting related functions.
Summary
Functions
Returns an %Ecto.Changeset{}
for tracking site_setting changes.
Creates a site_setting.
Deletes a site_setting.
Gets a single site_setting.
Gets a single site_setting.
Returns the list of site_settings.
Updates a site_setting.
Functions
@spec change_site_setting(Teiserver.Settings.SiteSetting.t(), map()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking site_setting changes.
Examples
iex> change_site_setting(site_setting)
%Ecto.Changeset{data: %SiteSetting{}}
@spec create_site_setting(map()) :: {:ok, Teiserver.Settings.SiteSetting.t()} | {:error, Ecto.Changeset}
Creates a site_setting.
Examples
iex> create_site_setting(%{field: value})
{:ok, %SiteSetting{}}
iex> create_site_setting(%{field: bad_value})
{:error, %Ecto.Changeset{}}
@spec delete_site_setting(Teiserver.Settings.SiteSetting.t()) :: {:ok, Teiserver.Settings.SiteSetting.t()} | {:error, Ecto.Changeset.t()}
Deletes a site_setting.
Examples
iex> delete_site_setting(site_setting)
{:ok, %SiteSetting{}}
iex> delete_site_setting(site_setting)
{:error, %Ecto.Changeset{}}
@spec get_site_setting(non_neg_integer(), list()) :: Teiserver.Settings.SiteSetting.t() | nil
Gets a single site_setting.
Returns nil if the SiteSetting does not exist.
Examples
iex> get_site_setting(123)
%SiteSetting{}
iex> get_site_setting(456)
nil
Gets a single site_setting.
Raises Ecto.NoResultsError
if the SiteSetting does not exist.
Examples
iex> get_site_setting!(123)
%SiteSetting{}
iex> get_site_setting!(456)
** (Ecto.NoResultsError)
Returns the list of site_settings.
Examples
iex> list_site_settings()
[%SiteSetting{}, ...]
@spec update_site_setting(Teiserver.Settings.SiteSetting.t(), map()) :: {:ok, Teiserver.Settings.SiteSetting.t()} | {:error, Ecto.Changeset.t()}
Updates a site_setting.
Examples
iex> update_site_setting(site_setting, %{field: new_value})
{:ok, %SiteSetting{}}
iex> update_site_setting(site_setting, %{field: bad_value})
{:error, %Ecto.Changeset{}}