diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-05-17 18:10:37 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-05-27 12:09:26 +0300 |
| commit | af1827cfc1df1742fc73744682945fc1b0d74388 (patch) | |
| tree | 732b10c0e522bc842afa532f271455e5daa3daf4 /docs | |
| parent | 31c0dae2ae397f09beba6730ad729f7cb50b6e28 (diff) | |
Allow to specify meta-data for shares into a talk conversation
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/chat.md b/docs/chat.md index ceb4b608f..d3da178b8 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -131,6 +131,28 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob - Data: The full message array of the new message, as defined in [Receive chat messages of a conversation](#receive-chat-messages-of-a-conversation) +## Share a file to the chat + +* Method: `POST` +* Endpoint: `ocs/v2.php/apps/files_sharing/api/v1/shares` +* Data: + + field | type | Description + ---|---|--- + `shareType` | int | `10` means share to a conversation + `shareWith` | string | The token of the conversation to share the file to + `path` | string | The file path inside the user's root to share + `referenceId` | string | A reference string to be able to identify the generated chat message again in a "get messages" request, should be a random sha256 (only available with `chat-reference-id` capability) + `talkMetaData` | string | JSON encoded array of the meta data + +* `talkMetaData` array: + + field | type | Description + ---|---|--- + `messageType` | string | A message type to show the message in different styles. Currently known: `voice-message` and `comment` + +* Response: [See official OCS Share API docs](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-share-api.html?highlight=sharing#create-a-new-share) + ## Deleting a chat message * Required capability: `delete-messages` |