From 83eb80ce05d2f267751ae55f0f8f4dfb70fc580c Mon Sep 17 00:00:00 2001 From: hippoz Date: Tue, 16 Mar 2021 01:44:44 +0200 Subject: [PATCH 1/3] Update 'resources/Docs/DOCS.md' --- resources/Docs/DOCS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index 723c77c..11664be 100644 --- a/resources/Docs/DOCS.md +++ b/resources/Docs/DOCS.md @@ -81,7 +81,7 @@ JSON data format: Example: ```json -3@{"content":"i hate you","channel_id":"totally real channel id"} +3@{"content":"i hate you","channel":{"_id":"totally real channel id"}} ``` ## 4:EVENT\_NEW\_MESSAGE @@ -112,7 +112,7 @@ Example: *Auth required, Server to client* -Sent by the server after YOO\_ACK, and otherwise when the entire status needs to be updated. If only one user's status changes, use EVENT\_CHANNEL\_MEMBER\_UPDATE. +Sent by the server after YOO\_ACK, and otherwise when the entire status needs to be updated. Usually, this will be sent only once, and when subsequent user status updates need to happen, EVENT\_CHANNEL\_MEMBER\_UPDATE should be sent. JSON data format (this ones tough): Contains a JSON object, where each key is a channel id and each property is an array of [user presence objects](#user-presence-object). From 8345fc1af3510a0f566600f140bfb45b003823b4 Mon Sep 17 00:00:00 2001 From: hippoz Date: Tue, 16 Mar 2021 01:52:43 +0200 Subject: [PATCH 2/3] Update 'resources/Docs/DOCS.md' --- resources/Docs/DOCS.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index 11664be..29a4736 100644 --- a/resources/Docs/DOCS.md +++ b/resources/Docs/DOCS.md @@ -47,7 +47,7 @@ JSON data format: | Field | Description | | - | - | | token | The authentication token | -| client | The name of the application the client is connecting from (e.g. browser_react_app) | +| client | The name of the application the client is connecting from (see below) | Example: ```json @@ -56,6 +56,8 @@ Example: If the token is invalid, or the connection is otherwise rejected, the client should be disconnected as soon as possible, and no YOO\_ACK should be sent. +It is suggested that the field "client" is send in the format of "(operating system)/(user agent vendor)/(user agent)/(optional full user agent string)", example: "Linux/Mozilla/Firefox/some firefox useragent string idk" + ## 2:YOO\_ACK *Part of handshake, Server to client* From c25008d73fc7dd72147446783d06eaf3bc69afd8 Mon Sep 17 00:00:00 2001 From: hippoz Date: Tue, 16 Mar 2021 05:04:44 +0200 Subject: [PATCH 3/3] DOCS: Mark the client field as optional --- resources/Docs/DOCS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index 29a4736..85e486b 100644 --- a/resources/Docs/DOCS.md +++ b/resources/Docs/DOCS.md @@ -47,7 +47,7 @@ JSON data format: | Field | Description | | - | - | | token | The authentication token | -| client | The name of the application the client is connecting from (see below) | +| client? | The name of the application the client is connecting from (see below) | Example: ```json