diff options
| author | Vitor Mattos <vitor@php.rio> | 2022-06-02 14:04:30 -0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2022-06-30 15:01:29 -0300 |
| commit | 6c7d0d31177dd4f10074fd42db4e60cdf2217787 (patch) | |
| tree | 7d0b3f8661042608d9a11bd9b879b5c9a4a8d779 /docs | |
| parent | 7fe6f4a1acf86cedf106f68e220cb3217378a1a9 (diff) | |
Rename more ttl to message-expire
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 1 | ||||
| -rw-r--r-- | docs/conversation.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index ef67a04ad..a21e7f5c7 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -97,6 +97,7 @@ title: Capabilities * `unified-search` - When the extended attributes of unified search results are there * `chat-permission` - When permission 128 is required to post chat messages, reaction or share items to the conversation * `silent-send` - Whether the chat API allows to send chat messages without triggering notifications +* `message-expire` - Message expiration time for a conversation * `sip-support-nopin` - Whether SIP can be configured to not require a custom attendee PIN * `send-call-notification` - When the API allows to resend call notifications for individual users that did not join yet * `silent-call` - Allow to start calls without sending notification diff --git a/docs/conversation.md b/docs/conversation.md index 976c32b9e..600fe4525 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -51,7 +51,7 @@ `participantFlags` | int | v1 | | "In call" flags of the user's session making the request (only available with `in-call-flags` capability) `readOnly` | int | v1 | | Read-only state for the current user (only available with `read-only-rooms` capability) `listable` | int | v3 | | Listable scope for the room (only available with `listable-rooms` capability) - `messageExpire` | int | v4 | | The message expire time in seconds in this chat. Zero if disabled. (only available with `time-to-live` capability) + `messageExpire` | int | v4 | | The message expire time in seconds in this chat. Zero if disabled. (only available with `message-expire` capability) `count` | int | v1 | v2 | **Removed:** Count the users on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoint `numGuests` | int | v1 | v2 | **Removed:** Count the guests on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoin `lastPing` | int | v1 | | Timestamp of the user's session making the request @@ -339,14 +339,14 @@ ## Set message expire for messages in a conversation -* Required capability: `time-to-live` +* Required capability: `message-expire` * Method: `POST` -* Endpoint: `/room/{token}/ttl` +* Endpoint: `/room/{token}/message-expire` * Data: field | type | Description ---|---|--- - `ttl` | int | The time to live for messages in seconds. If is zero, messages will not be deleted automatically. + `seconds` | int | The messages expire time in seconds. If is zero, messages will not be deleted automatically. * Response: - Status code: |