1
0
Fork 0
mirror of https://github.com/processone/ejabberd synced 2025-10-02 17:29:27 +02:00

Improve roster API commands documentation

This commit is contained in:
Jérôme Sautret 2025-09-30 16:38:23 +02:00
parent c0c69394b9
commit 060992bafa

View file

@ -612,6 +612,7 @@ get_commands_spec() ->
result = {res, rescode}},
#ejabberd_commands{name = add_rosteritem, tags = [roster],
desc = "Add an item to a user's roster (supports ODBC)",
longdesc = "The client will receive a `jabber:iq:roster` IQ notifying them of the added entry.",
module = ?MODULE, function = add_rosteritem,
version = 1,
note = "updated in 24.02",
@ -630,6 +631,7 @@ get_commands_spec() ->
%%{"", "will add mike@server.com to peter@localhost roster"},
#ejabberd_commands{name = delete_rosteritem, tags = [roster],
desc = "Delete an item from a user's roster (supports ODBC)",
longdesc = "The client will receive a `jabber:iq:roster` IQ notifying them of the removed entry.",
module = ?MODULE, function = delete_rosteritem,
args = [{localuser, binary}, {localhost, binary},
{user, binary}, {host, binary}],