hippoz/brainlet
Archived
5
1
Fork 1
Code Issues 6 Pull requests Releases Wiki Activity

docs: update to reflect protocol changes

Browse source
This commit is contained in:
hippoz 2021-10-03 21:08:57 +03:00
parent 1008e68d54
commit 50cc87b399
No known key found for this signature in database
GPG key ID: 7C52899193467641
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
resources/Docs/DOCS.md
View file

@ -26,11 +26,15 @@ Packets can also have JSON as a payload:
Sent by the server to the client as soon as possible after they connect to the gateway. Sent by the server to the client as soon as possible after they connect to the gateway.
This payload contains a `pingInterval` property. Every *pingInterval*, the client must send a packet simply containing `7@1`. This is the ACTION_PING payload. If the client does not send this payload at the right time, it is disconnected. JSON data format:
| Field | Description |
| - | - |
| pingInterval | Every *pingInterval*, the client must send a packet simply containing `7@1`. This is the ACTION_PING payload. If the client does not send this payload at the right time, it is disconnected. |
| supportedAttributes | An array of attributes supported by the server. If a client requests an unsupported attribute, it is disconnected from the server. |
Example: Example:
```json ```json
0@{"pingInterval":14750} 0@{"pingInterval":14750,"supportedAttributes":["PRESENCE_UPDATES"]}
``` ```
## 1:YOO ## 1:YOO
@ -194,7 +198,7 @@ Voice server signaling is done through a websocket gateway. This gateway is spec
| content | The text content of the message (max 2000 characters, min 1 character, trimmed) | | content | The text content of the message (max 2000 characters, min 1 character, trimmed) |
| channel | A [message channel object](#message-channel-object) | | channel | A [message channel object](#message-channel-object) |
| author | A [message author object](#message-author-object) | | author | A [message author object](#message-author-object) |
| _id | A UUIDv4 | | _id | An ObjectId |
## Message channel object ## Message channel object