CallConnection class

Pakket:

@azure/communication-call-automation

CallConnection-klasse vertegenwoordigt aanroepverbindingen gebaseerde API's.

Constructors

CallConnection(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

Methoden

addParticipant(CallInvite, AddParticipantOptions)	Een deelnemer toevoegen aan het gesprek
cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)	Annuleren Verzoek deelnemer toevoegen.
getCallConnectionProperties(OperationOptions)	Gespreksverbindingseigenschappen van de aanroep ophalen
getCallMedia()	Initialiseert een nieuw exemplaar van CallMedia.
getParticipant(CommunicationIdentifier, OperationOptions)	Een deelnemer ophalen uit het gesprek
hangUp(boolean, OperationOptions)	Hang de oproep voor zichzelf op of beëindig de hele oproep.
listParticipants(OperationOptions)	Alle deelnemers ophalen uit het gesprek
muteParticipant(CommunicationIdentifier, MuteParticipantOption)	Demp deelnemer uit het gesprek.
removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)	Een deelnemer uit het gesprek verwijderen
transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)	De oproep doorschakelen naar een doeldeelnemer

Constructordetails

CallConnection(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

new CallConnection(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)

Parameters

callConnectionId

string

endpoint

string

credential

TokenCredential | KeyCredential

options

CallAutomationApiClientOptionalParams

Methodedetails

addParticipant(CallInvite, AddParticipantOptions)

Een deelnemer toevoegen aan het gesprek

function addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>

Parameters

targetParticipant

CallInvite

options

AddParticipantOptions

Retouren

Promise<AddParticipantResult>

cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)

Annuleren Verzoek deelnemer toevoegen.

function cancelAddParticipantOperation(invitationId: string, options?: CancelAddParticipantOperationOptions): Promise<CancelAddParticipantOperationResult>

Parameters

invitationId

string

Uitnodigings-id die wordt gebruikt om de aanvraag van de deelnemer toevoegen te annuleren.

options

CancelAddParticipantOperationOptions

Retouren

Promise<CancelAddParticipantOperationResult>

getCallConnectionProperties(OperationOptions)

Gespreksverbindingseigenschappen van de aanroep ophalen

function getCallConnectionProperties(options?: OperationOptions): Promise<CallConnectionProperties>

Parameters

options

OperationOptions

Retouren

Promise<CallConnectionProperties>

getCallMedia()

Initialiseert een nieuw exemplaar van CallMedia.

function getCallMedia(): CallMedia

Retouren

CallMedia

getParticipant(CommunicationIdentifier, OperationOptions)

Een deelnemer ophalen uit het gesprek

function getParticipant(targetParticipant: CommunicationIdentifier, options?: OperationOptions): Promise<CallParticipant>

Parameters

targetParticipant

CommunicationIdentifier

De communicatie-id van de aangevraagde deelnemer.

options

OperationOptions

Retouren

Promise<CallParticipant>

hangUp(boolean, OperationOptions)

Hang de oproep voor zichzelf op of beëindig de hele oproep.

function hangUp(isForEveryone: boolean, options?: OperationOptions): Promise<void>

Parameters

isForEveryone

boolean

options

OperationOptions

Retouren

Promise<void>

listParticipants(OperationOptions)

Alle deelnemers ophalen uit het gesprek

function listParticipants(options?: OperationOptions): Promise<ListParticipantsResult>

Parameters

options

OperationOptions

Retouren

Promise<ListParticipantsResult>

muteParticipant(CommunicationIdentifier, MuteParticipantOption)

Demp deelnemer uit het gesprek.

function muteParticipant(participant: CommunicationIdentifier, options?: MuteParticipantOption): Promise<MuteParticipantResult>

Parameters

participant

CommunicationIdentifier

Deelnemer die moet worden gedempt vanuit het gesprek.

options

MuteParticipantOption

Aanvullende kenmerken voor deelnemer dempen.

Retouren

Promise<MuteParticipantResult>

removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)

Een deelnemer uit het gesprek verwijderen

function removeParticipant(participant: CommunicationIdentifier, options?: RemoveParticipantsOption): Promise<RemoveParticipantResult>

Parameters

participant

CommunicationIdentifier

De deelnemer wordt uit het gesprek verwijderd.

options

RemoveParticipantsOption

Retouren

Promise<RemoveParticipantResult>

transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)

De oproep doorschakelen naar een doeldeelnemer

function transferCallToParticipant(targetParticipant: CommunicationIdentifier, options?: TransferCallToParticipantOptions): Promise<TransferCallResult>

Parameters

targetParticipant

CommunicationIdentifier

Het doel waaraan moet worden overgedragen.

options

TransferCallToParticipantOptions

Retouren

Promise<TransferCallResult>