diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-03-11 14:55:51 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2020-04-22 16:35:36 +0300 |
| commit | c28a43f1e70d220c7b062c841ef6a4b9cb88fffa (patch) | |
| tree | 0565fb227354ebf108dbd51bc1d11fb682f91a8c /docs | |
| parent | a05d075d738a3cee16fbe4e3878282997a20fbfd (diff) | |
Handle the new reference id in the backend
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 1 | ||||
| -rw-r--r-- | docs/chat.md | 2 |
2 files changed, 3 insertions, 0 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index 8764232b3..03c878d7d 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -50,3 +50,4 @@ title: Capabilities * `config => conversations => can-create` - Whether the user can create public and group conversations, if not only one-to-one conversations are allowed * `force-mute` - "forceMute" signaling messages can be sent to mute other participants. * `conversation-v2` - The conversations API v2 is less load heavy and should be used by clients when available. Check the difference in the [Conversation API documentation](conversation.md). +* `chat-reference-id` - an optional referenceId can be sent with a chat message to be able to identify it in parallel get requests to earlier fade out a temporary message diff --git a/docs/chat.md b/docs/chat.md index ab1983dfb..742289d2f 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -44,6 +44,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` `systemMessage` | string | empty for normal chat message or the type of the system message (untranslated) `messageType` | string | Currently known types are `comment`, `system` and `command` `isReplyable` | bool | True if the user can post a reply to this message (only available with `chat-replies` capability) + `referenceId` | string | A reference string that was given while posting the message to be able to identify a sent message again (only available with `chat-reference-id` capability) `message` | string | Message string with placeholders (see [Rich Object String](https://github.com/nextcloud/server/issues/1706)) `messageParameters` | array | Message parameters for `message` (see [Rich Object String](https://github.com/nextcloud/server/issues/1706)) @@ -58,6 +59,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` `message` | string | The message the user wants to say `actorDisplayName` | string | Guest display name (ignored for logged in users) `replyTo` | int | The message ID this message is a reply to (only allowed for messages from the same conversation and when the message type is not `system` or `command`) + `referenceId` | string | A reference string to be able to identify the message again in a "get messages" request, should be a random sha256 (only available with `chat-reference-id` capability) * Response: - Header: |