Chapril
/
xmpp.chapril.org-ejabberd
mirror of https://github.com/processone/ejabberd.git
24
1
Fork 0
Code Releases Activity

Annotate options and commands recently added

This commit is contained in:
Badlop 2022-05-04 15:18:57 +02:00
parent 32dee33070
commit 30b3c6c908
7 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/ejabberd_admin.erl
View File

@ -322,6 +322,7 @@ get_commands_spec() ->
args = [{days, integer}], result = {res, rescode}},
#ejabberd_commands{name = delete_old_messages_batch, tags = [purge],
desc = "Delete offline messages older than DAYS",
note = "added in 22.05",
module = ?MODULE, function = delete_old_messages_batch,
args_desc = ["Name of host where messages should be deleted",
"Days to keep messages",
@ -334,6 +335,7 @@ get_commands_spec() ->
result_example = {ok, <<"Removal of 5000 messages in progress">>}},
#ejabberd_commands{name = delete_old_messages_status, tags = [purge],
desc = "Status of delete old offline messages operation",
note = "added in 22.05",
module = ?MODULE, function = delete_old_messages_status,
args_desc = ["Name of host where messages should be deleted"],
args_example = [<<"localhost">>],
@ -343,6 +345,7 @@ get_commands_spec() ->
result_example = "Operation in progress, delete 5000 messages"},
#ejabberd_commands{name = abort_delete_old_messages, tags = [purge],
desc = "Abort currently running delete old offline messages operation",
note = "added in 22.05",
module = ?MODULE, function = delete_old_messages_abort,
args_desc = ["Name of host where operation should be aborted"],
args_example = [<<"localhost">>],

1
src/ejabberd_oauth.erl
View File

@ -101,6 +101,7 @@ get_commands_spec() ->
},
#ejabberd_commands{name = oauth_revoke_token, tags = [oauth],
desc = "Revoke authorization for a token",
note = "changed in 22.05",
module = ?MODULE, function = oauth_revoke_token,
args = [{token, binary}],
policy = restricted,

5
src/mod_conversejs.erl
View File

@ -243,7 +243,8 @@ mod_doc() ->
#{desc =>
[?T("This module serves a simple page for the "
"https://conversejs.org/[Converse] XMPP web browser client."), "",
?T("This module is available since ejabberd 21.12."), "",
?T("This module is available since ejabberd 21.12."),
?T("Several options were improved in ejabberd 22.05."), "",
?T("To use this module, in addition to adding it to the 'modules' "
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
"http://../listen-options/#request-handlers[request_handlers]."), "",
@ -320,11 +321,13 @@ mod_doc() ->
"The default value is '@HOST@'.")}},
{conversejs_resources,
#{value => ?T("Path"),
note => "added in 22.05",
desc =>
?T("Local path to the Converse files. "
"If not set, the public Converse client will be used instead.")}},
{conversejs_options,
#{value => "{Name: Value}",
note => "added in 22.05",
desc =>
?T("Specify additional options to be passed to Converse. "
"See https://conversejs.org/docs/html/configuration.html[Converse configuration]. "

2
src/mod_host_meta.erl
View File

@ -192,7 +192,7 @@ mod_doc() ->
[?T("This module serves small 'host-meta' files as described in "
"https://xmpp.org/extensions/xep-0156.html[XEP-0156: Discovering "
"Alternative XMPP Connection Methods]."), "",
?T("This module is available since ejabberd 22.xx."), "",
?T("This module is available since ejabberd 22.05."), "",
?T("To use this module, in addition to adding it to the 'modules' "
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
"http://../listen-options/#request-handlers[request_handlers]."), "",

3
src/mod_mam.erl
View File

@ -1446,6 +1446,7 @@ get_commands_spec() ->
result = {res, rescode}},
#ejabberd_commands{name = delete_old_mam_messages_batch, tags = [purge],
desc = "Delete MAM messages older than DAYS",
note = "added in 22.05",
longdesc = "Valid message TYPEs: "
"\"chat\", \"groupchat\", \"all\".",
module = ?MODULE, function = delete_old_messages_batch,
@ -1461,6 +1462,7 @@ get_commands_spec() ->
result_example = {ok, <<"Removal of 5000 messages in progress">>}},
#ejabberd_commands{name = delete_old_mam_messages_status, tags = [purge],
desc = "Status of delete old MAM messages operation",
note = "added in 22.05",
module = ?MODULE, function = delete_old_messages_status,
args_desc = ["Name of host where messages should be deleted"],
args_example = [<<"localhost">>],
@ -1470,6 +1472,7 @@ get_commands_spec() ->
result_example = "Operation in progress, delete 5000 messages"},
#ejabberd_commands{name = abort_delete_old_mam_messages, tags = [purge],
desc = "Abort currently running delete old MAM messages operation",
note = "added in 22.05",
module = ?MODULE, function = delete_old_messages_abort,
args_desc = ["Name of host where operation should be aborted"],
args_example = [<<"localhost">>],

2
src/mod_muc.erl
View File

@ -1634,11 +1634,13 @@ mod_doc() ->
" street: Elm Street"]}]}},
{cleanup_affiliations_on_start,
#{value => "true | false",
note => "added in 22.05",
desc =>
?T("Remove affiliations for non-existing local users on startup. "
"The default value is 'false'.")}},
{default_room_options,
#{value => ?T("Options"),
note => "improved in 22.05",
desc =>
?T("This option allows to define the desired "
"default room options. Note that the creator of a room "

2
src/mod_muc_admin.erl
View File

@ -337,6 +337,7 @@ get_commands_spec() ->
result = {nodes, {list, {node, string}}}},
#ejabberd_commands{name = subscribe_room_many, tags = [muc_room],
desc = "Subscribe several users to a MUC conference",
note = "added in 22.05",
longdesc = "This command accept up to 50 users at once (this is configurable with `subscribe_room_many_max_users` option)",
module = ?MODULE, function = subscribe_room_many,
args_desc = ["Users JIDs and nicks",
@ -1469,6 +1470,7 @@ mod_doc() ->
opts =>
[{subscribe_room_many_max_users,
#{value => ?T("Number"),
note => "added in 22.05",
desc =>
?T("How many users can be subscribed to a room at once using "
"the 'subscribe_room_many' command. "