diff options
| author | Joas Schilling <213943+nickvergessen@users.noreply.github.com> | 2023-05-02 16:51:44 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-02 16:51:44 +0200 |
| commit | 53f8ce5eeeb6424e657d7dadd9c7f7ec2fd87e72 (patch) | |
| tree | 3c80ea9dd1bb91a895d2d3d2125ba8c108b866e4 /docs | |
| parent | 9b495d247049d3820212a7bf07cd8540ca644328 (diff) | |
| parent | 5c2471866a7a8a3ecda3ae57b126c3514a513059 (diff) | |
Merge pull request #9421 from nextcloud/followup/9411/improve-documentation
fix(docs): Improve user_status documentation on conversations API
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conversation.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/conversation.md b/docs/conversation.md index 5b6e4ac03..61369ae62 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -97,10 +97,10 @@ | `objectId` | string | v1 | | See [Object types](constants.md#object-types) documentation for explanation | | `breakoutRoomMode` | string | v4 | | Breakout room configuration mode (see [constants list](constants.md#breakout-room-modes)) (only available with `breakout-rooms-v1` capability) | | `breakoutRoomStatus` | string | v4 | | Breakout room status (see [constants list](constants.md#breakout-room-status)) (only available with `breakout-rooms-v1` capability) | -| `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 | -| `statusClearAt` | int | v4 | | Optional: Only available for one-to-one conversations and when `includeStatus=true` is set | +| `status` | string | v4 | | Optional: Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status | +| `statusIcon` | ?string | v4 | | Optional: Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status | +| `statusMessage` | ?string | v4 | | Optional: Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status | +| `statusClearAt` | ?int | v4 | | Optional: Only available for one-to-one conversations, when `includeStatus=true` is set and the user has a status, can still be null even with a status | | `participants` | array | v1 | v2 | **Removed** | | `guestList` | string | v1 | v2 | **Removed** | | `avatarVersion` | string | v4 | | Version of conversation avatar used to easier expiration of the avatar in case a moderator updates it, since the avatar endpoint should be cached for 24 hours. | |