Module escalus_users

Behaviours: escalus_user_db.

Data Types

host()

host() = inet:hostname() | inet:ip4_address() | binary()

named_user()

named_user() = {user_name(), user_spec()}

resource_spec()

resource_spec() = {user_name(), pos_integer()}

user()

user() = user_name() | user_spec()

user_name()

user_name() = atom()

user_option()

user_option() = username | server | password | compression | ssl | transport | path | port | wspath | host | auth_method | connection_steps | parser_opts | received_stanza_handlers | sent_stanza_handlers

user_spec()

user_spec() = [{user_option(), any()}]

xmpp_domain()

xmpp_domain() = inet:hostname() | binary()

Function Index

create_user/2
create_users/1
create_users/2
delete_user/2
delete_users/1
delete_users/2
get_host/2
get_jid/2
get_options/2
get_options/3
get_options/4
get_server/2
get_user_by_name/1
get_user_by_name/2
get_username/2
get_users/1
get_userspec/2
get_usp/2
is_mod_register_enabled/1
start/1
stop/1
update_userspec/4
verify_creation/1

Function Details

create_user/2

create_user(Config::escalus:config(), X2::named_user()) -> any()

create_users/1

create_users(Config::escalus:config()) -> escalus:config()

create_users/2

create_users(Config::escalus:config(), Users::[named_user()]) -> escalus:config()

delete_user/2

delete_user(Config::escalus:config(), X2::named_user()) -> {ok, term(), term()} | {error, term(), term()}

delete_users/1

delete_users(Config::escalus:config()) -> escalus:config()

delete_users/2

delete_users(Config::escalus:config(), Users::[named_user()]) -> escalus:config()

get_host/2

get_host(Config::escalus:config(), User::user()) -> host()

get_jid/2

get_jid(Config::escalus:config(), User::user()) -> binary()

get_options/2

get_options(Config::escalus:config(), User::user()) -> escalus:config()

get_options/3

get_options(Config::escalus:config(), User::user(), Resource::binary()) -> escalus:config()

get_options/4

get_options(Config::escalus:config(), User::user(), Resource::binary(), EventClient::escalus_event:event_client()) -> escalus:config()

get_server/2

get_server(Config::escalus:config(), User::user()) -> xmpp_domain()

get_user_by_name/1

get_user_by_name(Name::user_name()) -> {user_name(), escalus:config()}

get_user_by_name/2

get_user_by_name(Name::user_name(), Users::escalus:config()) -> {user_name(), escalus:config()}

get_username/2

get_username(Config::escalus:config(), User::user()) -> binary()

get_users/1

get_users(Names::all | [user_name()] | {by_name, [user_name()]}) -> [named_user()]

get_userspec/2

get_userspec(Config::escalus:config(), Username::user_name() | user_spec()) -> user_spec()

get_usp/2

get_usp(Config::escalus:config(), User::user()) -> [binary() | xmpp_domain()]

is_mod_register_enabled/1

is_mod_register_enabled(Config::escalus:config()) -> boolean()

start/1

start(Config::escalus:config()) -> any()

stop/1

stop(Config::escalus:config()) -> any()

update_userspec/4

update_userspec(Config::escalus:config(), UserName::atom(), Option::atom(), Value::any()) -> escalus:config()

verify_creation/1

verify_creation(X1::{ok, term(), term()} | {error, term(), term()}) -> ok


Generated by EDoc