From 50cc87b399b55757e3d0af52513a4a779a14b70e Mon Sep 17 00:00:00 2001 From: hippoz Date: Sun, 3 Oct 2021 21:08:57 +0300 Subject: [PATCH] docs: update to reflect protocol changes --- resources/Docs/DOCS.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index 6b3483b..b256e59 100644 --- a/resources/Docs/DOCS.md +++ b/resources/Docs/DOCS.md @@ -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. -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: ```json -0@{"pingInterval":14750} +0@{"pingInterval":14750,"supportedAttributes":["PRESENCE_UPDATES"]} ``` ## 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) | | channel | A [message channel object](#message-channel-object) | | author | A [message author object](#message-author-object) | -| _id | A UUIDv4 | +| _id | An ObjectId | ## Message channel object