Glific v0.3.1 Glific.Users View Source

The Users context.

Link to this section Summary

Functions

Return the count of users, using the same filter as list_users

Creates a user.

Deletes a user.

Gets a single user.

Returns the list of filtered users.

Reset user password

Updates a user.

Link to this section Functions

Specs

count_users(map()) :: integer()

Return the count of users, using the same filter as list_users

Specs

create_user(map()) ::
  {:ok, Glific.Users.User.t()} | {:error, Ecto.Changeset.t()}

Creates a user.

Examples

iex> create_user(%{field: value})
{:ok, %User{}}

iex> create_user(%{field: bad_value})
{:error, %Ecto.Changeset{}}

Specs

delete_user(Glific.Users.User.t()) ::
  {:ok, Glific.Users.User.t()} | {:error, Ecto.Changeset.t()}

Deletes a user.

Examples

iex> delete_user(user)
{:ok, %User{}}

iex> delete_user(user)
{:error, %Ecto.Changeset{}}

Specs

get_user!(integer()) :: Glific.Users.User.t()

Gets a single user.

Raises Ecto.NoResultsError if the User does not exist.

Examples

iex> get_user!(123)
%User{}

iex> get_user!(456)
** (Ecto.NoResultsError)

Specs

list_users(map()) :: [Glific.Users.User.t()]

Returns the list of filtered users.

Examples

iex> list_users()
[%User{}, ...]
Link to this function

reset_user_password(user, attrs)

View Source

Specs

reset_user_password(Glific.Users.User.t(), map()) ::
  {:ok, Glific.Users.User.t()} | {:error, Ecto.Changeset.t()}

Reset user password

Link to this function

update_user(user, attrs)

View Source

Specs

update_user(Glific.Users.User.t(), map()) ::
  {:ok, Glific.Users.User.t()} | {:error, Ecto.Changeset.t()}

Updates a user.

Examples

iex> update_user(user, %{field: new_value})
{:ok, %User{}}

iex> update_user(user, %{field: bad_value})
{:error, %Ecto.Changeset{}}