diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-02-16 11:43:16 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-02-16 11:43:16 +0300 |
| commit | 35ec8361b70ada92ed9a11f23f1b0e00cb06a0a1 (patch) | |
| tree | 27dafe81d600dbe7a839cc82197fadc02d93025d /docs | |
| parent | 54c8d9c59b06d5ffef5e130ed20271a70827f4c1 (diff) | |
Add docs and capability for callFlag of conversations
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 1 | ||||
| -rw-r--r-- | docs/constants.md | 1 | ||||
| -rw-r--r-- | docs/conversation.md | 3 |
3 files changed, 4 insertions, 1 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index 5c1e5a77b..ffddfb30e 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -68,3 +68,4 @@ title: Capabilities ## 12.0 * `delete-messages` - Allows to delete chat messages up to 6 hours for your own messages or when being a moderator. On deleting the message text will be replaced and a follow up system message will make sure clients and users update it in their cache and storage. * `rich-object-sharing` - Rich objects can be shared to chats. See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob/master/lib/public/RichObjectStrings/Definitions.php) for more details on supported rich objects and required data. +* `conversation-call-flags` - Whether the room api provides the `callFlag` to tell apart video and audio calls diff --git a/docs/constants.md b/docs/constants.md index dd4f0e02f..f8d8e9a6f 100644 --- a/docs/constants.md +++ b/docs/constants.md @@ -30,6 +30,7 @@ title: Constants * `1` in-call * `2` provides audio * `4` provides video +* `8` uses SIP dial-in ## Participant notification levels * `0` Default (`1` for one-to-one conversations, `2` for other conversations) diff --git a/docs/conversation.md b/docs/conversation.md index 7c3ae7e40..446b0a881 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -44,7 +44,7 @@ field | type | API | Description ------|------|-----|------------ `token` | string | * | Token identifier of the conversation which is used for further interaction - `type` | int | * | See list of conversation types in the [constants list](constants.md#Conversation-types) + `type` | int | * | See list of conversation types in the [constants list](constants.md#conversation-types) `name` | string | * | Name of the conversation (can also be empty) `displayName` | string | * | `name` if non empty, otherwise it falls back to a list of participants `description` | string | v3 | Description of the conversation (can also be empty) (only available with `room-description` capability) @@ -63,6 +63,7 @@ `sessionId` | string | * | `'0'` if not connected, otherwise a 512 character long string `hasPassword` | bool | * | Flag if the conversation has a password `hasCall` | bool | * | Flag if the conversation has an active call + `callFlag` | int | v3 | Combined flag of all participants in the current call (see [constants list](constants.md#participant-in-call-flag), only available with `conversation-call-flags` capability) `canStartCall` | bool | * | Flag if the user can start a new call in this conversation (joining is always possible) (only available with `start-call-flag` capability) `canDeleteConversation` | bool | 🆕 v2 | Flag if the user can delete the conversation for everyone (not possible without moderator permissions or in one-to-one conversations) `canLeaveConversation` | bool | 🆕 v2 | Flag if the user can leave the conversation (not possible for the last user with moderator permissions) |