mirror of
https://github.com/processone/ejabberd
synced 2025-10-03 17:59:31 +02:00
Improve roster API commands documentation
This commit is contained in:
parent
c0c69394b9
commit
060992bafa
1 changed files with 2 additions and 0 deletions
|
@ -612,6 +612,7 @@ get_commands_spec() ->
|
||||||
result = {res, rescode}},
|
result = {res, rescode}},
|
||||||
#ejabberd_commands{name = add_rosteritem, tags = [roster],
|
#ejabberd_commands{name = add_rosteritem, tags = [roster],
|
||||||
desc = "Add an item to a user's roster (supports ODBC)",
|
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,
|
module = ?MODULE, function = add_rosteritem,
|
||||||
version = 1,
|
version = 1,
|
||||||
note = "updated in 24.02",
|
note = "updated in 24.02",
|
||||||
|
@ -630,6 +631,7 @@ get_commands_spec() ->
|
||||||
%%{"", "will add mike@server.com to peter@localhost roster"},
|
%%{"", "will add mike@server.com to peter@localhost roster"},
|
||||||
#ejabberd_commands{name = delete_rosteritem, tags = [roster],
|
#ejabberd_commands{name = delete_rosteritem, tags = [roster],
|
||||||
desc = "Delete an item from a user's roster (supports ODBC)",
|
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,
|
module = ?MODULE, function = delete_rosteritem,
|
||||||
args = [{localuser, binary}, {localhost, binary},
|
args = [{localuser, binary}, {localhost, binary},
|
||||||
{user, binary}, {host, binary}],
|
{user, binary}, {host, binary}],
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue