diff options
| author | Badlop <badlop@process-one.net> | 2017-07-21 11:18:44 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2017-07-21 11:26:53 +0200 |
| commit | 1a0db3de3a6ab53557772f2db8a84de771d46f87 (patch) | |
| tree | d09da15e1c803b5d1af9cc6c2d666f0c9ea9e464 /src/ejabberd_sm.erl | |
| parent | Fix indentation of commands lines (diff) | |
Describe commands arguments and results in ejabberd_sm, ext_mod, mod_mam
Diffstat (limited to 'src/ejabberd_sm.erl')
| -rw-r--r-- | src/ejabberd_sm.erl | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index 344febb5..79a7bdb2 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -957,30 +957,36 @@ cache_nodes(Mod, LServer) -> %%% ejabberd commands get_commands_spec() -> - [#ejabberd_commands{name = connected_users, - tags = [session], + [#ejabberd_commands{name = connected_users, tags = [session], desc = "List all established sessions", policy = admin, module = ?MODULE, function = connected_users, args = [], + result_desc = "List of users sessions", + result_example = [<<"user1@example.com">>, <<"user2@example.com">>], result = {connected_users, {list, {sessions, string}}}}, - #ejabberd_commands{name = connected_users_number, - tags = [session, stats], + #ejabberd_commands{name = connected_users_number, tags = [session, stats], desc = "Get the number of established sessions", policy = admin, module = ?MODULE, function = connected_users_number, + result_example = 2, args = [], result = {num_sessions, integer}}, - #ejabberd_commands{name = user_resources, - tags = [session], + #ejabberd_commands{name = user_resources, tags = [session], desc = "List user's connected resources", policy = user, module = ?MODULE, function = user_resources, args = [], + args_desc = ["User name", "Server name"], + args_example = [<<"user1">>, <<"example.com">>], + result_example = [<<"tka1">>, <<"Gajim">>, <<"mobile-app">>], result = {resources, {list, {resource, string}}}}, - #ejabberd_commands{name = kick_user, - tags = [session], + #ejabberd_commands{name = kick_user, tags = [session], desc = "Disconnect user's active sessions", module = ?MODULE, function = kick_user, args = [{user, binary}, {host, binary}], + args_desc = ["User name", "Server name"], + args_example = [<<"user1">>, <<"example.com">>], + result_desc = "Number of resources that were kicked", + result_example = 3, result = {num_resources, integer}}]. -spec connected_users() -> [binary()]. |