Glific v0.3.1 Glific.Groups View Source
The Groups context.
Link to this section Summary
Functions
Returns an %Ecto.Changeset{}
for tracking group changes.
Return the count of group contacts
Return the count of groups, using the same filter as list_groups
Creates a contact group.
Creates a group.
Creates a user group.
Deletes a contact group.
Delete contact groups
Deletes a group.
Delete group contacts
Delete group users
Deletes a user group.
Delete user groups
Gets a single group.
Returns the list of groups.
Updates a group.
Updates user groups entries
Return the count of group users
Link to this section Functions
Specs
change_group(Glific.Groups.Group.t(), map()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking group changes.
Examples
iex> change_group(group)
%Ecto.Changeset{data: %Group{}}
Specs
Return the count of group contacts
Specs
Return the count of groups, using the same filter as list_groups
Specs
create_contact_group(map()) :: {:ok, Glific.Groups.ContactGroup.t()} | {:error, Ecto.Changeset.t()}
Creates a contact group.
Examples
iex> create_contact_group(%{field: value})
{:ok, %Contact{}}
iex> create_contact_group(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Specs
create_group(map()) :: {:ok, Glific.Groups.Group.t()} | {:error, Ecto.Changeset.t()}
Creates a group.
Examples
iex> create_group(%{field: value})
{:ok, %Group{}}
iex> create_group(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Specs
create_user_group(map()) :: {:ok, Glific.Groups.UserGroup.t()} | {:error, Ecto.Changeset.t()}
Creates a user group.
Examples
iex> create_user_group(%{field: value})
{:ok, %User{}}
iex> create_user_group(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Specs
delete_contact_group(Glific.Groups.ContactGroup.t()) :: {:ok, Glific.Groups.ContactGroup.t()} | {:error, Ecto.Changeset.t()}
Deletes a contact group.
Examples
iex> delete_contact_group(contact_group)
{:ok, %ContactGroup{}}
iex> delete_contact_group(contact_group)
{:error, %Ecto.Changeset{}}
Specs
Delete contact groups
Specs
delete_group(Glific.Groups.Group.t()) :: {:ok, Glific.Groups.Group.t()} | {:error, Ecto.Changeset.t()}
Deletes a group.
Examples
iex> delete_group(group)
{:ok, %Group{}}
iex> delete_group(group)
{:error, %Ecto.Changeset{}}
Specs
Delete group contacts
Specs
Delete group users
Specs
delete_user_group(Glific.Groups.UserGroup.t()) :: {:ok, Glific.Groups.UserGroup.t()} | {:error, Ecto.Changeset.t()}
Deletes a user group.
Examples
iex> delete_user_group(user_group)
{:ok, %UserGroup{}}
iex> delete_user_group(user_group)
{:error, %Ecto.Changeset{}}
Specs
Delete user groups
Specs
get_group!(integer()) :: Glific.Groups.Group.t()
Gets a single group.
Raises Ecto.NoResultsError
if the Group does not exist.
Examples
iex> get_group!(123)
%Group{}
iex> get_group!(456)
** (Ecto.NoResultsError)
Specs
list_groups(map()) :: [Glific.Groups.Group.t()]
Returns the list of groups.
Examples
iex> list_groups()
[%Group{}, ...]
Specs
update_group(Glific.Groups.Group.t(), map()) :: {:ok, Glific.Groups.Group.t()} | {:error, Ecto.Changeset.t()}
Updates a group.
Examples
iex> update_group(group, %{field: new_value})
{:ok, %Group{}}
iex> update_group(group, %{field: bad_value})
{:error, %Ecto.Changeset{}}
Specs
update_user_groups(map()) :: :ok
Updates user groups entries
Specs
Return the count of group users