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.

Returns the list of site_settings.

Functions

Link to this function

change_site_setting(site_setting, attrs \\ %{})

View Source
@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{}}
Link to this function

create_site_setting(attrs \\ %{})

View Source
@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{}}
Link to this function

delete_site_setting(site_setting)

View Source
@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{}}
Link to this function

get_site_setting(site_setting_id, query_args \\ [])

View Source
@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
Link to this function

get_site_setting!(site_setting_id, query_args \\ [])

View Source

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)
Link to this function

list_site_settings(query_args \\ [])

View Source
@spec list_site_settings(list()) :: list()

Returns the list of site_settings.

Examples

iex> list_site_settings()
[%SiteSetting{}, ...]
Link to this function

update_site_setting(site_setting, attrs)

View Source
@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{}}