mirror of
https://github.com/processone/ejabberd.git
synced 2024-10-27 15:02:14 +01:00
Describe commands arguments and results in ejabberd_sm, ext_mod, mod_mam
This commit is contained in:
parent
250876ea1a
commit
1a0db3de3a
@ -957,30 +957,36 @@ cache_nodes(Mod, LServer) ->
|
|||||||
%%% ejabberd commands
|
%%% ejabberd commands
|
||||||
|
|
||||||
get_commands_spec() ->
|
get_commands_spec() ->
|
||||||
[#ejabberd_commands{name = connected_users,
|
[#ejabberd_commands{name = connected_users, tags = [session],
|
||||||
tags = [session],
|
|
||||||
desc = "List all established sessions",
|
desc = "List all established sessions",
|
||||||
policy = admin,
|
policy = admin,
|
||||||
module = ?MODULE, function = connected_users, args = [],
|
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}}}},
|
result = {connected_users, {list, {sessions, string}}}},
|
||||||
#ejabberd_commands{name = connected_users_number,
|
#ejabberd_commands{name = connected_users_number, tags = [session, stats],
|
||||||
tags = [session, stats],
|
|
||||||
desc = "Get the number of established sessions",
|
desc = "Get the number of established sessions",
|
||||||
policy = admin,
|
policy = admin,
|
||||||
module = ?MODULE, function = connected_users_number,
|
module = ?MODULE, function = connected_users_number,
|
||||||
|
result_example = 2,
|
||||||
args = [], result = {num_sessions, integer}},
|
args = [], result = {num_sessions, integer}},
|
||||||
#ejabberd_commands{name = user_resources,
|
#ejabberd_commands{name = user_resources, tags = [session],
|
||||||
tags = [session],
|
|
||||||
desc = "List user's connected resources",
|
desc = "List user's connected resources",
|
||||||
policy = user,
|
policy = user,
|
||||||
module = ?MODULE, function = user_resources,
|
module = ?MODULE, function = user_resources,
|
||||||
args = [],
|
args = [],
|
||||||
|
args_desc = ["User name", "Server name"],
|
||||||
|
args_example = [<<"user1">>, <<"example.com">>],
|
||||||
|
result_example = [<<"tka1">>, <<"Gajim">>, <<"mobile-app">>],
|
||||||
result = {resources, {list, {resource, string}}}},
|
result = {resources, {list, {resource, string}}}},
|
||||||
#ejabberd_commands{name = kick_user,
|
#ejabberd_commands{name = kick_user, tags = [session],
|
||||||
tags = [session],
|
|
||||||
desc = "Disconnect user's active sessions",
|
desc = "Disconnect user's active sessions",
|
||||||
module = ?MODULE, function = kick_user,
|
module = ?MODULE, function = kick_user,
|
||||||
args = [{user, binary}, {host, binary}],
|
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}}].
|
result = {num_resources, integer}}].
|
||||||
|
|
||||||
-spec connected_users() -> [binary()].
|
-spec connected_users() -> [binary()].
|
||||||
|
@ -80,16 +80,18 @@ code_change(_OldVsn, State, _Extra) ->
|
|||||||
get_commands_spec() ->
|
get_commands_spec() ->
|
||||||
[#ejabberd_commands{name = modules_update_specs,
|
[#ejabberd_commands{name = modules_update_specs,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "Update the module source code from Git",
|
||||||
longdesc = "",
|
longdesc = "A connection to Internet is required",
|
||||||
module = ?MODULE, function = update,
|
module = ?MODULE, function = update,
|
||||||
args = [],
|
args = [],
|
||||||
result = {res, rescode}},
|
result = {res, rescode}},
|
||||||
#ejabberd_commands{name = modules_available,
|
#ejabberd_commands{name = modules_available,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "List the contributed modules available to install",
|
||||||
longdesc = "",
|
|
||||||
module = ?MODULE, function = available_command,
|
module = ?MODULE, function = available_command,
|
||||||
|
result_desc = "List of tuples with module name and description",
|
||||||
|
result_example = [{mod_cron, "Execute scheduled commands"},
|
||||||
|
{mod_rest, "ReST frontend"}],
|
||||||
args = [],
|
args = [],
|
||||||
result = {modules, {list,
|
result = {modules, {list,
|
||||||
{module, {tuple,
|
{module, {tuple,
|
||||||
@ -97,9 +99,11 @@ get_commands_spec() ->
|
|||||||
{summary, string}]}}}}},
|
{summary, string}]}}}}},
|
||||||
#ejabberd_commands{name = modules_installed,
|
#ejabberd_commands{name = modules_installed,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "List the contributed modules already installed",
|
||||||
longdesc = "",
|
|
||||||
module = ?MODULE, function = installed_command,
|
module = ?MODULE, function = installed_command,
|
||||||
|
result_desc = "List of tuples with module name and description",
|
||||||
|
result_example = [{mod_cron, "Execute scheduled commands"},
|
||||||
|
{mod_rest, "ReST frontend"}],
|
||||||
args = [],
|
args = [],
|
||||||
result = {modules, {list,
|
result = {modules, {list,
|
||||||
{module, {tuple,
|
{module, {tuple,
|
||||||
@ -107,30 +111,35 @@ get_commands_spec() ->
|
|||||||
{summary, string}]}}}}},
|
{summary, string}]}}}}},
|
||||||
#ejabberd_commands{name = module_install,
|
#ejabberd_commands{name = module_install,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "Compile, install and start an available contributed module",
|
||||||
longdesc = "",
|
|
||||||
module = ?MODULE, function = install,
|
module = ?MODULE, function = install,
|
||||||
|
args_desc = "Module name",
|
||||||
|
args_example = mod_rest,
|
||||||
args = [{module, binary}],
|
args = [{module, binary}],
|
||||||
result = {res, rescode}},
|
result = {res, rescode}},
|
||||||
#ejabberd_commands{name = module_uninstall,
|
#ejabberd_commands{name = module_uninstall,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "Uninstall a contributed module",
|
||||||
longdesc = "",
|
|
||||||
module = ?MODULE, function = uninstall,
|
module = ?MODULE, function = uninstall,
|
||||||
|
args_desc = "Module name",
|
||||||
|
args_example = mod_rest,
|
||||||
args = [{module, binary}],
|
args = [{module, binary}],
|
||||||
result = {res, rescode}},
|
result = {res, rescode}},
|
||||||
#ejabberd_commands{name = module_upgrade,
|
#ejabberd_commands{name = module_upgrade,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "Upgrade the running code of an installed module",
|
||||||
longdesc = "",
|
longdesc = "In practice, this uninstalls and installs the module",
|
||||||
module = ?MODULE, function = upgrade,
|
module = ?MODULE, function = upgrade,
|
||||||
|
args_desc = "Module name",
|
||||||
|
args_example = mod_rest,
|
||||||
args = [{module, binary}],
|
args = [{module, binary}],
|
||||||
result = {res, rescode}},
|
result = {res, rescode}},
|
||||||
#ejabberd_commands{name = module_check,
|
#ejabberd_commands{name = module_check,
|
||||||
tags = [admin,modules],
|
tags = [admin,modules],
|
||||||
desc = "",
|
desc = "Check the contributed module repository compliance",
|
||||||
longdesc = "",
|
|
||||||
module = ?MODULE, function = check,
|
module = ?MODULE, function = check,
|
||||||
|
args_desc = "Module name",
|
||||||
|
args_example = mod_rest,
|
||||||
args = [{module, binary}],
|
args = [{module, binary}],
|
||||||
result = {res, rescode}}
|
result = {res, rescode}}
|
||||||
].
|
].
|
||||||
|
@ -1008,6 +1008,9 @@ get_commands_spec() ->
|
|||||||
longdesc = "Valid message TYPEs: "
|
longdesc = "Valid message TYPEs: "
|
||||||
"\"chat\", \"groupchat\", \"all\".",
|
"\"chat\", \"groupchat\", \"all\".",
|
||||||
module = ?MODULE, function = delete_old_messages,
|
module = ?MODULE, function = delete_old_messages,
|
||||||
|
args_desc = ["Type of messages to delete (chat, groupchat, all)",
|
||||||
|
"Days to keep messages"],
|
||||||
|
args_example = [<<"all">>, 31],
|
||||||
args = [{type, binary}, {days, integer}],
|
args = [{type, binary}, {days, integer}],
|
||||||
result = {res, rescode}}].
|
result = {res, rescode}}].
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user