CallConnection class

Klasa CallConnection reprezentuje interfejsy API oparte na połączeniu wywołań.

Konstruktory

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

Metody

addParticipant(CallInvite, AddParticipantOptions)

Dodawanie uczestnika do połączenia

cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)

Anuluj prośbę o dodanie uczestnika.

getCallConnectionProperties(OperationOptions)

Pobieranie właściwości połączenia połączenia wywołania

getCallMedia()

Inicjuje nowe wystąpienie obiektu CallMedia.

getParticipant(CommunicationIdentifier, OperationOptions)

Pobierz uczestnika z połączenia

hangUp(boolean, OperationOptions)

Zawiesić wywołanie dla siebie lub zakończyć całe połączenie.

listParticipants(OperationOptions)

Pobierz wszystkich uczestników z połączenia

muteParticipant(CommunicationIdentifier, MuteParticipantOption)

Wycisz uczestnika połączenia.

removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)

Usuwanie uczestnika z połączenia

transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)

Przenoszenie połączenia do uczestnika docelowego

Szczegóły konstruktora

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

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

Parametry

callConnectionId

string

endpoint

string

options

CallAutomationApiClientOptionalParams

Szczegóły metody

addParticipant(CallInvite, AddParticipantOptions)

Dodawanie uczestnika do połączenia

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

Parametry

targetParticipant
CallInvite

Zwraca

cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)

Anuluj prośbę o dodanie uczestnika.

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

Parametry

invitationId

string

Identyfikator zaproszenia używany do anulowania żądania dodawania uczestnika.

Zwraca

getCallConnectionProperties(OperationOptions)

Pobieranie właściwości połączenia połączenia wywołania

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

Parametry

Zwraca

getCallMedia()

Inicjuje nowe wystąpienie obiektu CallMedia.

function getCallMedia(): CallMedia

Zwraca

getParticipant(CommunicationIdentifier, OperationOptions)

Pobierz uczestnika z połączenia

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

Parametry

targetParticipant
CommunicationIdentifier

Identyfikator komunikacji żądanego uczestnika.

Zwraca

Promise<CallParticipant>

hangUp(boolean, OperationOptions)

Zawiesić wywołanie dla siebie lub zakończyć całe połączenie.

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

Parametry

isForEveryone

boolean

Zwraca

Promise<void>

listParticipants(OperationOptions)

Pobierz wszystkich uczestników z połączenia

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

Parametry

Zwraca

muteParticipant(CommunicationIdentifier, MuteParticipantOption)

Wycisz uczestnika połączenia.

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

Parametry

participant
CommunicationIdentifier

Uczestnik, który ma być wyciszony z połączenia.

options
MuteParticipantOption

Dodatkowe atrybuty dla uczestnika wyciszenia.

Zwraca

removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)

Usuwanie uczestnika z połączenia

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

Parametry

participant
CommunicationIdentifier

Uczestnik zostanie usunięty z połączenia.

Zwraca

transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)

Przenoszenie połączenia do uczestnika docelowego

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

Parametry

targetParticipant
CommunicationIdentifier

Element docelowy, do który ma zostać przeniesiony.

Zwraca