View Source PowAssent.Ecto.UserIdentities.Context behaviour (PowAssent v0.4.18)

Handles pow assent user identity context for user identities.

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

:repo - the ecto repo module (required)
:user - the user schema module (required)

Summary

Types

changeset()

user()

user_id_params()

user_identity()

user_identity_params()

user_params()

Callbacks

all(user)

create(user, user_identity_params)

create_user(user_identity_params, user_params, arg3)

delete(user, binary)

get_user_by_provider_uid(binary, binary)

upsert(user, user_identity_params)

Functions

all(user, config)

Fetches all user identities for user.

create_user(user_identity_params, user_params, user_id_params, config)

Creates a user with user identity.

delete(user, provider, config)

Deletes a user identity for the provider and user.

get_user_by_provider_uid(provider, uid, config)

Finds a user based on the provider and uid.

repo!(config)

See Pow.Config.repo!/1.

upsert(user, user_identity_params, config)

Upserts a user identity.

user!(config)

See Pow.Config.user!/1.

Types

changeset()

@type changeset() :: map()

user()

@type user() :: map()

user_id_params()

@type user_id_params() :: map()

user_identity()

@type user_identity() :: map()

user_identity_params()

@type user_identity_params() :: map()

user_params()

@type user_params() :: map()

Callbacks

all(user)

@callback all(user()) :: [user_identity()]

create(user, user_identity_params)

@callback create(user(), user_identity_params()) :: any()

create_user(user_identity_params, user_params, arg3)

@callback 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()}

delete(user, binary)

@callback delete(user(), binary()) ::
  {:ok, {number(), nil}} | {:error, {:no_password, changeset()}}

get_user_by_provider_uid(binary, binary)

@callback get_user_by_provider_uid(binary(), binary()) :: user() | nil

upsert(user, user_identity_params)

@callback upsert(user(), user_identity_params()) ::
  {:ok, user_identity()}
  | {:error, {:bound_to_different_user, changeset()}}
  | {:error, changeset()}

Functions

all(user, config)

@spec 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)

@spec 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.

delete(user, provider, config)

@spec 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.

get_user_by_provider_uid(provider, uid, config)

@spec 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.

repo!(config)

See Pow.Config.repo!/1.

upsert(user, user_identity_params, config)

@spec 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.

user!(config)

See Pow.Config.user!/1.