summaryrefslogtreecommitdiff
path: root/docs/RPC/rpc_message.md
blob: de91767ae57454cdf287b808cc1dca07e785cf02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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.