diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-06-21 18:14:06 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-06-21 19:32:27 +0300 |
| commit | 37d037773f42c662c701c79a8b66284633e10e09 (patch) | |
| tree | 95bb902f5bf69a0bb0f5f82d85835c195434ab92 /docs | |
| parent | 0103216b28be5198a1ed592c63fe60c2b05053ab (diff) | |
Add documentation for status flags
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conversation.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/conversation.md b/docs/conversation.md index e4713b138..d998ee0d4 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -9,6 +9,12 @@ * Method: `GET` * Endpoint: `/room` +* Data: + + field | type | Description + ---|---|--- + `noStatusUpdate` | int | Whether the "online" user status of the current user should be "kept-alive" (`1`) or not (`0`) (defaults to `0`) + `includeStatus` | bool | Whether the user status information of all one-to-one conversations should be loaded (default false) * Response: - Status code: @@ -66,6 +72,9 @@ `lastMessage` | message | v1 | | Last message in a conversation if available, otherwise empty `objectType` | string | v1 | | The type of object that the conversation is associated with; "share:password" if the conversation is used to request a password for a share, otherwise empty `objectId` | string | v1 | | Share token if "objectType" is "share:password", otherwise empty + `status` | string | v4 | | Optional: Only available for one-to-one conversations and when `includeStatus=true` is set + `statusIcon` | string | v4 | | Optional: Only available for one-to-one conversations and when `includeStatus=true` is set + `statusMessage` | string | v4 | | Optional: Only available for one-to-one conversations and when `includeStatus=true` is set `participants` | array | v1 | v2 | **Removed** `guestList` | string | v1 | v2 | **Removed** |