diff options
Diffstat (limited to 'docs/RPC/rpc_message.md')
-rw-r--r-- | docs/RPC/rpc_message.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/RPC/rpc_message.md b/docs/RPC/rpc_message.md new file mode 100644 index 000000000..de91767ae --- /dev/null +++ b/docs/RPC/rpc_message.md @@ -0,0 +1,67 @@ +# Anope `rpc_message` RPC interface + +## `anope.messageNetwork` + +Sends a message to all users on the network. + +### Parameters + +Index | Description +----- | ----------- +0+ | One or more messages to send. + +### Errors + +Code | Description +------ | ----------- +-32099 | The global service is not available. + +### Result + +This procedure returns no result. + +## `anope.messageServer` + +Sends a message to all users on the specified server. + +### Parameters + +Index | Description +----- | ----------- +0 | The name of the server to message users on. +1+ | One or more messages to send. + +### Errors + +Code | Description +------ | ----------- +-32099 | The global service is not available. +-32098 | The specified server does not exist. + +### Result + +This procedure returns no result. + +## `anope.messageUser` + +Sends a message to the specified user. + +### Parameters + +Index | Description +----- | ----------- +0 | The source pseudoclient to send the message from. +1 | The target user to send the message to. +2+ | One or more messages to send. + +### Errors + +Code | Description +------ | ----------- +-32099 | The specified source does not exist. +-32098 | The specified target does not exist. + +### Result + +This procedure returns no result. + |