New Documentation: README.md for stream-livechat-room (RocketChat#895)

* Added readme for stream-livechat-room Added README.md for stream-livechat-room method to subscribe to livechat room * Updated toc.yml Updated toc.yml file to reflect the table of contents of new added entry. * Update README.md
karlitschek · Nov 21, 2018 · dc903f7 · dc903f7
1 parent c981075
commit dc903f7
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/_data/toc.yml b/_data/toc.yml
@@ -224,6 +224,7 @@
         - registerGuest
         - sendMessageLivechat
         - sendOfflineMessage
+        - streamlivechatroom
     - Rest API:
       - Assets:
         - setAsset

diff --git a/developer-guides/realtime-api/livechat-api/streamlivechatroom/README.md b/developer-guides/realtime-api/livechat-api/streamlivechatroom/README.md
@@ -0,0 +1,35 @@
+# Method: `stream-livechat-room`
+
+## DDP message
+
+```json
+
+{
+    "msg":"sub",
+    "id":"6NctZomXL3ZdtKNsn",
+    "name":"stream-livechat-room",
+    "params":[
+        "KTZqPAR9DQGxKcxzf",
+        {
+            "useCollection":false,
+            "args":[
+                {
+                    "token":"jkGaw6duhiuh45"
+                }
+            ]
+        }
+    ]
+};
+
+```
+
+## Response
+
+```json
+{
+    "msg":"ready",
+    "subs":[
+        "JHalkajwdh67"
+    ]
+}
+```