Class Conference

Hierarchy

Conference

Constructors

constructor

new Conference(): Conference
Returns Conference

Properties

emitter

emitter: EventEmitter2

invitationCount

invitationCount: number

Use to keep the number of invitations sent in this conference.

isOnHold

isOnHold: boolean

Check if conference is on hold state.

Methods

callAgent

callAgent(mediaTypes?: MediaTypes, contextInfo?: ContextInfo, token?: string): Promise<any>
Invites an agent to a conference.
Parameters
- Optional mediaTypes: MediaTypes
- Optional contextInfo: ContextInfo
- Optional token: string
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:46

callSkilledAgent

callSkilledAgent(mediaTypes?: MediaTypes, skill?: string, contextInfo?: ContextInfo, token?: string): Promise<any>
Invites an agent with a particular skill to a conference.
Parameters
- Optional mediaTypes: MediaTypes
- Optional skill: string
- Optional contextInfo: ContextInfo
- Optional token: string
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:55

callVoiceMail

callVoiceMail(mediaTypes?: MediaTypes): Promise<any>
Invites the voicemail to a conference.
Parameters
- Optional mediaTypes: MediaTypes
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:65

cancelInvitation

cancelInvitation(invitation: Invitation, session?: string): void
Parameters
- invitation: Invitation
- Optional session: string
Returns void
- Defined in src/conferences/Conference.d.ts:182

expelParticipant

expelParticipant(participant: string, session?: string): Promise<any>
Expels a participant from this conference.
Parameters
- participant: string
- Optional session: string
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:70

expelParticipants

expelParticipants(participants: string[]): Promise<any>
Expels a list of participants from this conference.
Parameters
- participants: string[]
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:75

getCurrentParticipants

getCurrentParticipants(): number
Returns the current participant count.

Returns number
- Defined in src/conferences/Conference.d.ts:80

getId

getId(): string
Returns the ID of the conference.

Returns string
- Defined in src/conferences/Conference.d.ts:90

getInvite

getInvite(): ConferenceInvite
Returns the invitation to the conference if the participant was invited.

Returns ConferenceInvite
- Defined in src/conferences/Conference.d.ts:100

getJoinTimestamp

getJoinTimestamp(): number
Returns the timestamp when the join to this conference was completed

Returns number
- Defined in src/conferences/Conference.d.ts:95

getLocalMediaHandler

getLocalMediaHandler(): LocalMediaHandler
Allows access to local streams and actions related to changing what local media is shared

Returns LocalMediaHandler
- Defined in src/conferences/Conference.d.ts:41

getOutgoingInvitations

getOutgoingInvitations(): Set<object>
Returns a set of outgoing invitations.

Returns Set<object>
- Defined in src/conferences/Conference.d.ts:105

getRemoteGatewayUsernames

getRemoteGatewayUsernames(): Set<string>
Returns a set of strings containing the gateway username of every remote participant.

Returns Set<string>
- Defined in src/conferences/Conference.d.ts:111

getRemoteParticipants

getRemoteParticipants(): Map<string, "HOLD" | "IN_CALL">
Returns Map<string, "HOLD" | "IN_CALL">
- Defined in src/conferences/Conference.d.ts:119

getRemoteStreams

getRemoteStreams(): Map<string, ManagedStream[]>
Returns a Map containing a list of ManagedStreams per participant (gateway user name).

Returns Map<string, ManagedStream[]>
- Defined in src/conferences/Conference.d.ts:117

getStatus

getStatus(): ConferenceStatus
Returns the current status of the conference.

Returns ConferenceStatus
- Defined in src/conferences/Conference.d.ts:124

getStatus$

getStatus$(): Observable<ConferenceStatus>
Returns Observable<ConferenceStatus>
- Defined in src/conferences/Conference.d.ts:125

hasRemoteVideo

hasRemoteVideo(): boolean
Returns a boolean value indicating if at least one of the remote conference participants has a video track.

Returns boolean
- Defined in src/conferences/Conference.d.ts:131

hold

hold(): Promise<any>
Enable/disable local hold Local hold mutes conference audio streams (local and remote) and stops receiving/sending video (if any).

Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:137

inviteMany

inviteMany(participants: string[], mediaTypes?: MediaTypes, context?: Record<string, string>): Promise<any>
Invites many participants to a conference.
Parameters
- participants: string[]
- Optional mediaTypes: MediaTypes
- Optional context: Record<string, string>
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:153

inviteParticipant

inviteParticipant(participant: string, mediaTypes?: MediaTypes, context?: Record<string, string>): Promise<any>
Invites a new participant to this conference.
Parameters
- participant: string
- Optional mediaTypes: MediaTypes
- Optional context: Record<string, string>
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:148

inviteParticipants

inviteParticipants(participants: string[]): Promise<any>
Invites a list of new participant to this conference.
Parameters
- participants: string[]
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:158

isBeingTransfered

isBeingTransfered(): boolean
Check if a conference is being transfering.

Returns boolean
- Defined in src/conferences/Conference.d.ts:163

isRecorded

isRecorded(): boolean
Returns if the conference is recorded

Returns boolean
- Defined in src/conferences/Conference.d.ts:85

isRecovered

isRecovered(): boolean
Returns boolean
- Defined in src/conferences/Conference.d.ts:165

join

join(): Promise<any>
Connects to the conference.

Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:170

leave

leave(errorCode?: number): any
Leaves the conference.
Parameters
- Optional errorCode: number
Returns any
- Defined in src/conferences/Conference.d.ts:175

unattendedCallTransfer

unattendedCallTransfer(participant: string, mediaConstraints?: MediaStreamConstraints): Promise<any>
Create an unattendedCallTransfer towards a user in the system.
Parameters
- participant: string
- Optional mediaConstraints: MediaStreamConstraints
Returns Promise<any>
- Defined in src/conferences/Conference.d.ts:180

unhold

unhold(): Promise<void>
Republishes all previously published media, subscribes to previously subscribed media and notifies new status to other participants

Returns Promise<void>
- Defined in src/conferences/Conference.d.ts:143

`Static` create

create(room: any, mediaConstraints: MediaStreamConstraints): Promise<Conference>
Parameters
- room: any
- mediaConstraints: MediaStreamConstraints
Returns Promise<Conference>
- Defined in src/conferences/Conference.d.ts:23

Generated using TypeDoc