ParticipantsCanvas
This component renders a collection of participants.
Can be themed with Theme.ParticipantsCanvas in Theme.
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| onHold | styled(div) | Visible only if task is conference call and worker is on hold | Wrapper for on hold container. Displays CallCanvasWorkerOnHold template and button to unhold worker | |
| participantsContainer | styled(div) | Scrollable wrapper for ParticipantsContainer that renders the participants of the call | ||
| transcriptContainer | styled(div) | Wrapper component that renders the list of participants in the CCAI flow | ||
| trasncriptDisclosure | Twilio paste component | Twilio paste component that displays the list of participants in a collapsable element in CCAI flow | ||
| transcriptDisclosureHeading | Twilio paste component | A part of Twilio paste component (Disclosure) that displays heading | ||
| transcriptDisclosureContent | Twilio paste component | A part of Twilio paste component (Disclosure) that displays the content in the Disclosure component | ||
| transcriptParticipantContainer | styled(div) | A container component |
Static Properties#
| Name | Type | Description |
|---|---|---|
| Content | DynamicContentStore<ParticipantsCanvas.ParticipantsCanvasChildrenProps, ParticipantsCanvasChildrenKeys> | Dynamic content store |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| includeMyself | boolean | Identifies if current logged in worker is included. | Yes | |
| hideActions | boolean | Identifies if the participant actions are hidden | Yes | |
| isCCAICall | boolean | Identifies if the call is a Google CCAI call or not. | Yes |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| external | Array<CallCanvasParticipant> | external call canvas participants. | No | |
| participantsByCallSid | Record<string, Participant> | dictionary of participants with participantSid as the key. | No | |
| theme.ParticipantsCanvas | ParticipantsCanvasThemeProps | Theme | Yes | |
| includeMyself | boolean | Identifies if current logged in worker is included. | Yes | |
| hideActions | boolean | Identifies if the participant actions are hidden | Yes | |
| isCCAICall | boolean | Identifies if the call is a Google CCAI call or not. | Yes |