CallConnection class
Klassen CallConnection representerar samtalsanslutningsbaserade API:er.
Konstruktorer
| Call |
Metoder
| add |
Lägga till en deltagare i anropet |
| cancel |
Avbryt begäran om att lägga till deltagare. |
| get |
Hämta samtalsanslutningsegenskaper för anropet |
| get |
Initierar en ny instans av CallMedia. |
| get |
Hämta en deltagare från samtalet |
| hang |
Lägg på anropet för sig själv eller avsluta hela samtalet. |
| list |
Hämta alla deltagare från samtalet |
| mute |
Stäng av ljudet på deltagaren från anropet. |
| remove |
Ta bort en deltagare från anropet |
| transfer |
Överföra anropet till en måldeltagare |
Konstruktorinformation
CallConnection(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)
new CallConnection(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)
Parametrar
- callConnectionId
-
string
- endpoint
-
string
- credential
- options
-
CallAutomationApiClientOptionalParams
Metodinformation
addParticipant(CallInvite, AddParticipantOptions)
Lägga till en deltagare i anropet
function addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>
Parametrar
- targetParticipant
- CallInvite
- options
- AddParticipantOptions
Returer
Promise<AddParticipantResult>
cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)
Avbryt begäran om att lägga till deltagare.
function cancelAddParticipantOperation(invitationId: string, options?: CancelAddParticipantOperationOptions): Promise<CancelAddParticipantOperationResult>
Parametrar
- invitationId
-
string
Inbjudnings-ID som används för att avbryta begäran om att lägga till deltagare.
Returer
Promise<CancelAddParticipantOperationResult>
getCallConnectionProperties(OperationOptions)
Hämta samtalsanslutningsegenskaper för anropet
function getCallConnectionProperties(options?: OperationOptions): Promise<CallConnectionProperties>
Parametrar
- options
- OperationOptions
Returer
Promise<CallConnectionProperties>
getCallMedia()
getParticipant(CommunicationIdentifier, OperationOptions)
Hämta en deltagare från samtalet
function getParticipant(targetParticipant: CommunicationIdentifier, options?: OperationOptions): Promise<CallParticipant>
Parametrar
- targetParticipant
- CommunicationIdentifier
Kommunikationsidentifieraren för den begärda deltagaren.
- options
- OperationOptions
Returer
Promise<CallParticipant>
hangUp(boolean, OperationOptions)
Lägg på anropet för sig själv eller avsluta hela samtalet.
function hangUp(isForEveryone: boolean, options?: OperationOptions): Promise<void>
Parametrar
- isForEveryone
-
boolean
- options
- OperationOptions
Returer
Promise<void>
listParticipants(OperationOptions)
Hämta alla deltagare från samtalet
function listParticipants(options?: OperationOptions): Promise<ListParticipantsResult>
Parametrar
- options
- OperationOptions
Returer
Promise<ListParticipantsResult>
muteParticipant(CommunicationIdentifier, MuteParticipantOption)
Stäng av ljudet på deltagaren från anropet.
function muteParticipant(participant: CommunicationIdentifier, options?: MuteParticipantOption): Promise<MuteParticipantResult>
Parametrar
- participant
- CommunicationIdentifier
Deltagare som ska stängas av från anropet.
- options
- MuteParticipantOption
Ytterligare attribut för att stänga av deltagare.
Returer
Promise<MuteParticipantResult>
removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)
Ta bort en deltagare från anropet
function removeParticipant(participant: CommunicationIdentifier, options?: RemoveParticipantsOption): Promise<RemoveParticipantResult>
Parametrar
- participant
- CommunicationIdentifier
Deltagaren kommer att tas bort från anropet.
- options
- RemoveParticipantsOption
Returer
Promise<RemoveParticipantResult>
transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)
Överföra anropet till en måldeltagare
function transferCallToParticipant(targetParticipant: CommunicationIdentifier, options?: TransferCallToParticipantOptions): Promise<TransferCallResult>
Parametrar
- targetParticipant
- CommunicationIdentifier
Målet som ska överföras till.
- options
- TransferCallToParticipantOptions
Returer
Promise<TransferCallResult>