View Source PowAssent.Ecto.UserIdentities.Context behaviour (PowAssent v0.4.13)
Handles pow assent user identity context for user identities.
usage
Usage
This module will be used by PowAssent by default. If you wish to have control
over context methods, you can do configure
lib/my_project/user_identities/user_identities.ex
the following way:
defmodule MyApp.UserIdentities do
use PowAssent.Ecto.UserIdentities.Context,
repo: MyApp.Repo,
user: MyApp.Users.User
def all(user) do
pow_assent_all(user)
end
end
Remember to update the PowAssent configuration with
user_identities_context: MyApp.UserIdentities
.
The following Pow methods can be accessed:
pow_assent_get_user_by_provider_uid/3
pow_assent_upsert/2
pow_assent_create_user/3
pow_assent_delete/2
pow_assent_all/1
configuration-options
Configuration options
:repo
- the ecto repo module (required):user
- the user schema module (required)
Link to this section Summary
Functions
Fetches all user identities for user.
Creates a user with user identity.
Deletes a user identity for the provider and user.
Finds a user based on the provider and uid.
Upserts a user identity.
Link to this section Types
Link to this section Callbacks
Specs
all(user()) :: [user_identity()]
Specs
create(user(), user_identity_params()) :: any()
Specs
create_user(user_identity_params(), user_params(), user_id_params() | nil) :: {:ok, user()} | {:error, {:bound_to_different_user | :invalid_user_id_field, changeset()}} | {:error, changeset()}
Specs
Specs
Specs
upsert(user(), user_identity_params()) :: {:ok, user_identity()} | {:error, {:bound_to_different_user, changeset()}} | {:error, changeset()}
Link to this section Functions
Specs
all(user(), PowAssent.Config.t()) :: [user_identity()]
Fetches all user identities for user.
Repo module will be fetched from config.
create_user(user_identity_params, user_params, user_id_params, config)
View SourceSpecs
create_user( user_identity_params(), user_params(), user_id_params() | nil, PowAssent.Config.t() ) :: {:ok, user()} | {:error, {:bound_to_different_user | :invalid_user_id_field, changeset()}} | {:error, changeset()}
Creates a user with user identity.
User schema module and repo module will be fetched from config.
Specs
delete(user(), binary(), PowAssent.Config.t()) :: {:ok, {number(), nil}} | {:error, {:no_password, changeset()}}
Deletes a user identity for the provider and user.
Repo module will be fetched from config.
Specs
get_user_by_provider_uid(binary(), binary() | integer(), PowAssent.Config.t()) :: user() | nil
Finds a user based on the provider and uid.
User schema module and repo module will be fetched from the config.
See Pow.Config.repo!/1
.
Specs
upsert(user(), user_identity_params(), PowAssent.Config.t()) :: {:ok, user_identity()} | {:error, {:bound_to_different_user, changeset()}} | {:error, changeset()}
Upserts a user identity.
If a matching user identity already exists for the user, the identity will be updated, otherwise a new identity is inserted.
Repo module will be fetched from config.
See Pow.Config.user!/1
.