Document that send_stanza_c2s requires an existing sender C2S session

This commit is contained in:
Badlop 2021-03-16 12:58:48 +01:00
parent c4d45ec08c
commit f6c6ff561a
1 changed files with 3 additions and 1 deletions

View File

@ -744,7 +744,9 @@ get_commands_spec() ->
"Receiver JID", "Subject, or empty string", "Body"],
result = {res, rescode}},
#ejabberd_commands{name = send_stanza_c2s, tags = [stanza],
desc = "Send a stanza as if sent from a c2s session",
desc = "Send a stanza from an existing C2S session",
longdesc = "USER@HOST/RESOURCE must be an existing C2S session."
" As an alternative, use send_stanza instead.",
module = ?MODULE, function = send_stanza_c2s,
args = [{user, binary}, {host, binary}, {resource, binary}, {stanza, binary}],
args_example = [<<"admin">>, <<"myserver.com">>, <<"bot">>,