diff options
| author | Joas Schilling <coding@schilljs.com> | 2023-05-02 13:11:12 +0200 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2023-05-02 13:11:12 +0200 |
| commit | eac2b0c50031857c8239a1f3222a59c5b10d9f82 (patch) | |
| tree | 3f8f42a7c383153247556954f3034d5bf180ec11 /docs | |
| parent | 5e28cae6cc66bd11af0ed2893507bfeb3aadd17c (diff) | |
fix(docs): Improve user_status documentation on conversations API
Signed-off-by: Joas Schilling <coding@schilljs.com>
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. | |