Skip to content

Document circles too #5717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PVince81 merged 1 commit into from
Jun 7, 2021
Merged

Document circles too #5717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/constants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/conversation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/participant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
1 change: 1 addition & 0 deletions lib/Model/Attendee.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ class Attendee extends Entity {
public const ACTOR_GROUPS = 'groups';
public const ACTOR_GUESTS = 'guests';
public const ACTOR_EMAILS = 'emails';
public const ACTOR_CIRCLES = 'circles';

/** @var int */
protected $roomId;
Expand Down
1 change: 1 addition & 0 deletions src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export const ATTENDEE = {
GUESTS: 'guests',
EMAILS: 'emails',
GROUPS: 'groups',
CIRCLES: 'circles',
BOTS: 'bots',
},
BRIDGE_BOT_ID: 'bridge-bot',
Expand Down