Docs: Also add the streaming docs to the Chat api doc.
authorlain <lain@soykaf.club>
Fri, 29 May 2020 14:07:40 +0000 (16:07 +0200)
committerlain <lain@soykaf.club>
Fri, 29 May 2020 14:07:40 +0000 (16:07 +0200)
docs/API/chats.md

index 2e415e4dac1284deb0e9daea7d0df51470d60c0b..2eca5adf6c11762b0ba3b0ce872ae6ce700afd91 100644 (file)
@@ -220,3 +220,7 @@ There's a new `pleroma:chat_mention` notification, which has this form:
   "created_at": "somedate"
 }
 ```
+
+### Streaming
+
+There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.