diff options
| author | Vitor Mattos <vitor@php.rio> | 2022-07-01 16:25:43 +0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2022-07-01 16:25:43 +0300 |
| commit | af34125e66b3c7c2b4e8ea1e6167c8bd23b7aa32 (patch) | |
| tree | 22aa93296e50a039bf8af1e2542b683586c05853 /docs | |
| parent | 5a9ca1bf26259872f86edbcd25b79c36542c50b9 (diff) | |
Rename text
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 2 | ||||
| -rw-r--r-- | docs/conversation.md | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index 50f7536c5..5c29bf390 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -97,7 +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 +* `message-expiration` - 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 5afb8df5e..fcc9aa0fe 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) - `expireDate` | int | v4 | | The expire date time in seconds in this chat. Zero if disabled. (only available with `message-expire` capability) + `messageExpiration` | int | v4 | | The message expiration time in seconds in this chat. Zero if disabled. (only available with `message-expiration` 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 @@ -337,16 +337,16 @@ + `401 Unauthorized` When the participant is a guest + `404 Not Found` When the conversation could not be found for the participant -## Set expire date for messages in a conversation +## Set message expiration -* Required capability: `message-expire` +* Required capability: `message-expiration` * Method: `POST` -* Endpoint: `/room/{token}/message-expire` +* Endpoint: `/room/{token}/message-expiration` * Data: field | type | Description ---|---|--- - `seconds` | int | The messages expire time in seconds. If is zero, messages will not be deleted automatically. + `seconds` | int | The messages expiration in seconds. If is zero, messages will not be deleted automatically. * Response: - Status code: |