diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-06-07 15:21:28 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-06-07 15:21:28 +0300 |
| commit | 6116591ca1e51d9ccf81100bd18047578da4c84a (patch) | |
| tree | 6d1321f1d1a6bf82d0568af157dcac84517054e4 /docs | |
| parent | b7cc61b1d7525774b5f2a497e7e67b2ee734e9b6 (diff) | |
Document circles too
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/constants.md | 4 | ||||
| -rw-r--r-- | docs/conversation.md | 2 | ||||
| -rw-r--r-- | docs/participant.md | 2 |
3 files changed, 5 insertions, 3 deletions
diff --git a/docs/constants.md b/docs/constants.md index f32bd3265..7f0137381 100644 --- a/docs/constants.md +++ b/docs/constants.md @@ -53,14 +53,16 @@ title: Constants ### Attendee types * `users` - Logged-in users * `groups` - Groups +* `circles` - [Circle from the Circles app](https://github.com/nextcloud/circles) * `guests` - Guest without a login * `emails` - A guest invited by email address ### Actor types of chat messages * `guests` - guest users * `users` - logged-in users -* `emails` - users invited by email +* `emails` - A guest invited by email * `groups` - groups +* `circles` - [Circle from the Circles app](https://github.com/nextcloud/circles) * `bots` - used by commands (actor-id is the used `/command`) and the changelog conversation (actor-id is `changelog`) ## Signaling modes diff --git a/docs/conversation.md b/docs/conversation.md index 842bf6132..d2d139d1e 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -35,7 +35,7 @@ `participantType` | int | v1 | | Permissions level of the current user `attendeeId` | int | v3 | | Unique attendee id `attendeePin` | string | v3 | | Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute) - `actorType` | string | v3 | | Currently known `users|guests|emails|groups` + `actorType` | string | v3 | | Currently known `users|guests|emails|groups|circles` `actorId` | string | v3 | | The unique identifier for the given actor type `participantInCall` | bool | v1 | v2 | **Removed:** use `participantFlags` instead `participantFlags` | int | v1 | | "In call" flags of the user's session making the request (only available with `in-call-flags` capability) diff --git a/docs/participant.md b/docs/participant.md index 92d42526a..336f6bf4b 100644 --- a/docs/participant.md +++ b/docs/participant.md @@ -28,7 +28,7 @@ field | type | Added | Removed | Description ---|---|---|---|--- `attendeeId` | int | v3 | | Unique attendee id - `actorType` | string | v3 | | Currently known `users|guests|emails|groups` + `actorType` | string | v3 | | Currently known `users|guests|emails|groups|circles` `actorId` | string | v3 | | The unique identifier for the given actor type `displayName` | string | v1 | | Can be empty for guests `participantType` | int | v1 | | Permissions level of the participant (see [constants list](constants.md#participant-types)) |