Package version:

Class CallConnection

CallConnection class represents call connection based APIs.

Index

Constructors

Methods

addParticipant cancelAddParticipantOperation getCallConnectionProperties getCallMedia getParticipant hangUp listParticipants muteParticipant removeParticipant transferCallToParticipant

Constructors

constructor

new CallConnection(callConnectionId, endpoint, credential, options?): CallConnection
Parameters
- callConnectionId: string
- endpoint: string
- credential: any
- Optionaloptions: CallAutomationApiClientOptionalParams
Returns CallConnection
- Defined in callConnection.ts:64

Methods

addParticipant

addParticipant(targetParticipant, options?): Promise<AddParticipantResult>
Add a participant to the call
Parameters
- targetParticipant: CallInvite
- options: AddParticipantOptions = {}
Returns Promise<AddParticipantResult>
- Defined in callConnection.ts:202

cancelAddParticipantOperation

cancelAddParticipantOperation(invitationId, options?): Promise<CancelAddParticipantOperationResult>
Cancel add participant operation.
Parameters
- invitationId: string
  Invitation ID used to cancel the add participant request.
- options: CancelAddParticipantOperationOptions = {}
  Additional attributes for cancel add participant operation.
Returns Promise<CancelAddParticipantOperationResult>
- Defined in callConnection.ts:339

getCallConnectionProperties

getCallConnectionProperties(options?): Promise<CallConnectionProperties>
Get call connection properties of the call
Parameters
- options: OperationOptions = {}
Returns Promise<CallConnectionProperties>
- Defined in callConnection.ts:95

getCallMedia

getCallMedia(): CallMedia
Initializes a new instance of CallMedia.

Returns CallMedia
- Defined in callConnection.ts:83

getParticipant

getParticipant(targetParticipant, options?): Promise<CallParticipant>
Get a participant from the call
Parameters
- targetParticipant: CommunicationIdentifier
  The communication identifier of requested participant.
- options: OperationOptions = {}
Returns Promise<CallParticipant>
- Defined in callConnection.ts:137

hangUp

hangUp(isForEveryone, options?): Promise<void>
Hang up the call for itself or terminate the whole call.
Parameters
- isForEveryone: boolean
- options: OperationOptions = {}
Returns Promise<void>
- Defined in callConnection.ts:118

listParticipants

listParticipants(options?): Promise<ListParticipantsResult>
Get all participants from the call
Parameters
- options: OperationOptions = {}
Returns Promise<ListParticipantsResult>
- Defined in callConnection.ts:158

muteParticipant

muteParticipant(participant, options?): Promise<MuteParticipantResult>
Mute participant from the call.
Parameters
- participant: CommunicationIdentifier
  Participant to be muted from the call.
- options: MuteParticipantOption = {}
  Additional attributes for mute participant.
Returns Promise<MuteParticipantResult>
- Defined in callConnection.ts:310

removeParticipant

removeParticipant(participant, options?): Promise<RemoveParticipantResult>
Remove a participant from the call
Parameters
- participant: CommunicationIdentifier
  The participant is going to be removed from the call.
- options: RemoveParticipantsOption = {}
Returns Promise<RemoveParticipantResult>
- Defined in callConnection.ts:279

transferCallToParticipant

transferCallToParticipant(targetParticipant, options?): Promise<TransferCallResult>
Transfer the call to a target participant
Parameters
- targetParticipant: CommunicationIdentifier
  The target to be transferred to.
- options: TransferCallToParticipantOptions = {}
Returns Promise<TransferCallResult>
- Defined in callConnection.ts:246