View Source ArkeAuth.Core.User (arke_auth v0.3.4)

Documentation for User.

Summary

Functions

after_get_struct(arke, struct)

after_get_struct(arke, unit, struct)

arke_from_attr()

base_parameters()

before_create(arke, unit)

before_delete(arke, unit)

before_load(data, arg2)

before_struct_encode(_, unit)

before_update(arke, unit)

before_validate(arke, unit)

check_password(user, pwd)

Check if the given password is right

groups_from_attr()

import(arke)

on_create(arke, unit)

on_delete(arke, unit)

on_load(data, persistence_fn)

on_struct_encode(_, _, data, opts)

on_update(arke, old_unit, unit)

on_validate(arke, unit)

update_password(user, new_pwd)

Update the user password

Functions

after_get_struct(arke, struct)

after_get_struct(arke, unit, struct)

arke_from_attr()

base_parameters()

before_create(arke, unit)

before_delete(arke, unit)

before_load(data, arg2)

before_struct_encode(_, unit)

before_update(arke, unit)

before_validate(arke, unit)

check_password(user, pwd)

@spec check_password(user :: ArkeAuth.Core.Unit.t(), pwd :: String.t()) ::
  {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()

Check if the given password is right

Parameters

user => %Arke.Core.Unit{} => user struct
pwd => string => password to check

Return

{:ok, %Arke.Core.Unit{}}

groups_from_attr()

import(arke)

on_create(arke, unit)

on_delete(arke, unit)

on_load(data, persistence_fn)

on_struct_encode(_, _, data, opts)

on_update(arke, old_unit, unit)

on_validate(arke, unit)

update_password(user, new_pwd)

@spec update_password(user :: ArkeAuth.Core.Unit.t(), new_pwd :: String.t()) ::
  {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()

Update the user password

Parameters

user => %Arke.Core.Unit{} => user struct
new_pwd => string => password to check

Return

{:ok, %Arke.Core.Unit{}}