diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index 723c77c..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 (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* @@ -81,7 +83,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 +114,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).