diff options
| author | Vitor Mattos <vitor@php.rio> | 2023-05-02 09:33:34 -0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2023-05-03 05:00:09 -0300 |
| commit | 7a0ac60c920d7138a97e2a2c015fe52801dff0e2 (patch) | |
| tree | c95539a0f91c4bd55d679541d844d23ceb8e65ef /docs | |
| parent | 7f50f59e0ca7996001d9c330315c2f8ad5712aa8 (diff) | |
Replace the header X-NC-IsCustomAvatar by conversation property isCustomAvatar
With the header isn't possible to check if `isCustomAvatar` without
retrieve the avatar to verify the header. Because this, isCUstomAvatar
was moved to a conversation property.
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/avatar.md | 8 | ||||
| -rw-r--r-- | docs/conversation.md | 1 |
2 files changed, 3 insertions, 6 deletions
diff --git a/docs/avatar.md b/docs/avatar.md index 8b748e38f..d2288aeb1 100644 --- a/docs/avatar.md +++ b/docs/avatar.md @@ -24,6 +24,8 @@ ## Delete conversations avatar +> **PS**: To check if need to delete when is customized, you need to verify the property `isCustomAvatar` from [conversation](conversation.md). + * Required capability: `avatar` * Method: `DELETE` * Endpoint: `/room/{token}/avatar` @@ -46,12 +48,6 @@ - Status code: + `200 OK` + `404 Not Found` When the conversation could not be found for the participant - - Header: - -| field | type | Description | -| ------------------- | ------ | ----------------------------------------------------------------- | -| X-NC-IsCustomAvatar | string | Return 1 when is custom avatar and 0 when is not a custom a vatar | - - Body: the image file ## Get dark mode conversations avatar (binary) diff --git a/docs/conversation.md b/docs/conversation.md index 61369ae62..6e64db591 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -104,6 +104,7 @@ | `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. | +| `isCustomAvatar` | bool | v4 | | Flag if the conversation have a custom avatar | | `callStartTime` | int | v4 | | Timestamp when the call was started (only available with `recording-v1` capability) | | `callRecording` | int | v4 | | Type of call recording (see [Constants - Call recording status](constants.md#call-recording-status)) (only available with `recording-v1` capability) | |