View Source Squeeze.Accounts (OpenPace v0.0.1)
The Accounts context which is responsible for users, preferences, and credentials.
Link to this section Summary
Functions
Returns an %Ecto.Changeset{} for tracking user changes.
Returns an %Ecto.Changeset{} for tracking user_prefs changes.
Creates a credential
Creates a user.
Deletes a Credential.
Deletes a User.
Get user by email address.
Gets a single credential by provider and uid.
Gets a single user.
Gets a single user.
Get user by email address.
Something something
Returns the list of credentials by user.
Updates a credential
Updates a user.
Updates a user_prefs.
Link to this section Functions
Returns an %Ecto.Changeset{} for tracking user changes.
examples
Examples
iex> change_user(user)
%Ecto.Changeset{source: %User{}}
Returns an %Ecto.Changeset{} for tracking user_prefs changes.
examples
Examples
iex> change_user_prefs(user_prefs)
%Ecto.Changeset{source: %UserPrefs{}}
Creates a credential
Creates a user.
examples
Examples
iex> create_user(%{field: value})
{:ok, %User{}}
iex> create_user(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Deletes a Credential.
examples
Examples
iex> delete_credential(credential) {:ok, %Credential{}}
iex> delete_credential(credential) {:error, %Ecto.Changeset{}}
Deletes a User.
examples
Examples
iex> delete_user(user)
{:ok, %User{}}
iex> delete_user(user)
{:error, %Ecto.Changeset{}}
Get user by email address.
examples
Examples
iex> get_by_email(email) {:ok, %User{}}
iex> get_by_email(bad_email)
Gets a single credential by provider and uid.
Returns nil if Credential does not exist.
examples
Examples
iex> get_credential("strava", 1)
%Credential{}
iex> get_credential("strava", 2)
nil
Gets a single user.
Raises Ecto.NoResultsError if the User does not exist.
examples
Examples
iex> get_user!(123) %User{}
iex> get_user!(456) ** (Ecto.NoResultsError)
Gets a single user.
Raises Ecto.NoResultsError if the User does not exist.
examples
Examples
iex> get_user!(123)
%User{}
iex> get_user!(456)
** (Ecto.NoResultsError)
Get user by email address.
examples
Examples
iex> get_user_by_email(email)
%User{}
iex> get_user_by_email(bad_email)
nil
Something something
examples
Examples
iex> get_user_by_slug(slug)
%User{}
Returns the list of credentials by user.
examples
Examples
iex> list_credentials(user) [%Credential{}, ...]
Updates a credential
Updates a user.
examples
Examples
iex> update_user(user, %{field: new_value})
{:ok, %User{}}
iex> update_user(user, %{field: bad_value})
{:error, %Ecto.Changeset{}}
Updates a user_prefs.
examples
Examples
iex> update_user_prefs(user_prefs, %{field: new_value}) {:ok, %UserPrefs{}}
iex> update_user_prefs(user_prefs, %{field: bad_value}) {:error, %Ecto.Changeset{}}