View Source Teiserver.Game.MatchMembershipLib (Teiserver v0.0.4)
TODO: Library of match_membership related functions.
Summary
Functions
Returns an %Ecto.Changeset{}
for tracking match_membership changes.
Creates many match_memberships. Not unlike most other create functions this will raise an exception on failure and should not be caught using the normal case functions.
Creates a match_membership.
Deletes a match_membership.
Gets a single match_membership.
Gets a single match_membership.
Returns the list of match_memberships.
Updates a match_membership.
Functions
@spec change_match_membership(Teiserver.Game.MatchMembership.t(), map()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking match_membership changes.
Examples
iex> change_match_membership(match_membership)
%Ecto.Changeset{data: %MatchMembership{}}
Creates many match_memberships. Not unlike most other create functions this will raise an exception on failure and should not be caught using the normal case functions.
Expects a map of values which can be turned into valid match memberships.
Examples
iex> create_many_match_memberships([%{field: value}])
{:ok, %MatchMembership{}}
iex> create_many_match_memberships([%{field: bad_value}])
raise Postgrex.Error
@spec create_match_membership(map()) :: {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}
Creates a match_membership.
Examples
iex> create_match_membership(%{field: value})
{:ok, %MatchMembership{}}
iex> create_match_membership(%{field: bad_value})
{:error, %Ecto.Changeset{}}
@spec delete_match_membership(Teiserver.Game.MatchMembership.t()) :: {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}
Deletes a match_membership.
Examples
iex> delete_match_membership(match_membership)
{:ok, %MatchMembership{}}
iex> delete_match_membership(match_membership)
{:error, %Ecto.Changeset{}}
@spec get_match_membership( Teiserver.match_id(), Teiserver.user_id(), Teiserver.query_args() ) :: Teiserver.Game.MatchMembership.t() | nil
Gets a single match_membership.
Returns nil if the MatchMembership does not exist.
Examples
iex> get_match_membership(123)
%MatchMembership{}
iex> get_match_membership(456)
nil
@spec get_match_membership!( Teiserver.match_id(), Teiserver.user_id(), Teiserver.query_args() ) :: Teiserver.Game.MatchMembership.t()
Gets a single match_membership.
Raises Ecto.NoResultsError
if the MatchMembership does not exist.
Examples
iex> get_match_membership!(123)
%MatchMembership{}
iex> get_match_membership!(456)
** (Ecto.NoResultsError)
@spec list_match_memberships(Teiserver.query_args()) :: [ Teiserver.Game.MatchMembership.t() ]
Returns the list of match_memberships.
Examples
iex> list_match_memberships()
[%MatchMembership{}, ...]
@spec update_match_membership(Teiserver.Game.MatchMembership.t(), map()) :: {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}
Updates a match_membership.
Examples
iex> update_match_membership(match_membership, %{field: new_value})
{:ok, %MatchMembership{}}
iex> update_match_membership(match_membership, %{field: bad_value})
{:error, %Ecto.Changeset{}}