CallConnection class
Klasa CallConnection reprezentuje interfejsy API oparte na połączeniu wywołań.
Konstruktory
| Call |
Metody
| add |
Dodawanie uczestnika do połączenia |
| cancel |
Anuluj prośbę o dodanie uczestnika. |
| get |
Pobieranie właściwości połączenia połączenia wywołania |
| get |
Inicjuje nowe wystąpienie obiektu CallMedia. |
| get |
Pobierz uczestnika z połączenia |
| hang |
Zawiesić wywołanie dla siebie lub zakończyć całe połączenie. |
| list |
Pobierz wszystkich uczestników z połączenia |
| mute |
Wycisz uczestnika połączenia. |
| remove |
Usuwanie uczestnika z połączenia |
| transfer |
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
- credential
- options
-
CallAutomationApiClientOptionalParams
Szczegóły metody
addParticipant(CallInvite, AddParticipantOptions)
Dodawanie uczestnika do połączenia
function addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>
Parametry
- targetParticipant
- CallInvite
- options
- AddParticipantOptions
Zwraca
Promise<AddParticipantResult>
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
Promise<CancelAddParticipantOperationResult>
getCallConnectionProperties(OperationOptions)
Pobieranie właściwości połączenia połączenia wywołania
function getCallConnectionProperties(options?: OperationOptions): Promise<CallConnectionProperties>
Parametry
- options
- OperationOptions
Zwraca
Promise<CallConnectionProperties>
getCallMedia()
getParticipant(CommunicationIdentifier, OperationOptions)
Pobierz uczestnika z połączenia
function getParticipant(targetParticipant: CommunicationIdentifier, options?: OperationOptions): Promise<CallParticipant>
Parametry
- targetParticipant
- CommunicationIdentifier
Identyfikator komunikacji żądanego uczestnika.
- options
- OperationOptions
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
- options
- OperationOptions
Zwraca
Promise<void>
listParticipants(OperationOptions)
Pobierz wszystkich uczestników z połączenia
function listParticipants(options?: OperationOptions): Promise<ListParticipantsResult>
Parametry
- options
- OperationOptions
Zwraca
Promise<ListParticipantsResult>
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
Promise<MuteParticipantResult>
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.
- options
- RemoveParticipantsOption
Zwraca
Promise<RemoveParticipantResult>
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.
- options
- TransferCallToParticipantOptions
Zwraca
Promise<TransferCallResult>