Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/spreed.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2020-05-15 11:17:16 +0300
committerJoas Schilling <coding@schilljs.com>2020-05-15 11:17:16 +0300
commitae0682a949e0cb7ef3df4046cc807c8d4ab71210 (patch)
tree5aab9fc9eec622a250bd370d1f1b0efabca342f2 /docs
parenteb9736a29fffdc3a546e7a843b8fd13ac9fa9eb0 (diff)
Add docs for message.parent
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/chat.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/chat.md b/docs/chat.md
index 742289d2f..1bb26b5b7 100644
--- a/docs/chat.md
+++ b/docs/chat.md
@@ -47,6 +47,21 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
`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))
+ `parent` | array | **Optional:** See `Parent data` below
+
+#### Parent data
+
+* When deleted:
+
+ field | type | Description
+ ------|------|------------
+ `id` | int | ID of the parent comment
+ `deleted` | bool | `true` when the parent is deleted
+
+* Regular message:
+
+ Full message array as shown above, but `parent` will never be set for a parent message.
+
## Sending a new chat message