Compartir a través de

CallConnection class

  • Referencia
Paquete:
@azure/communication-call-automation

La clase CallConnection representa las API basadas en la conexión de llamadas.

Constructores

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

Métodos

addParticipant(CallInvite, AddParticipantOptions)

Incorporación de un participante a la llamada
cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)

Cancelar la operación agregar participante.
getCallConnectionProperties(OperationOptions)

Obtención de las propiedades de conexión de llamada de la llamada
getCallMedia()

Inicializa una nueva instancia de CallMedia.
getParticipant(CommunicationIdentifier, OperationOptions)

Obtener un participante de la llamada
hangUp(boolean, OperationOptions)

Cuelga la llamada por sí misma o finaliza toda la llamada.
listParticipants(OperationOptions)

Obtener todos los participantes de la llamada
muteParticipant(CommunicationIdentifier, MuteParticipantOption)

Silenciar al participante de la llamada.
removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)

Quitar un participante de la llamada
transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)

Transferir la llamada a un participante de destino

Detalles del constructor

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

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

Parámetros

callConnectionId

string

endpoint

string

credential

TokenCredential | KeyCredential

options

CallAutomationApiClientOptionalParams

Detalles del método

addParticipant(CallInvite, AddParticipantOptions)

Incorporación de un participante a la llamada

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

Parámetros

targetParticipant
CallInvite
options
AddParticipantOptions

Devoluciones

Promise<AddParticipantResult>

cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)

Cancelar la operación agregar participante.

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

Parámetros

invitationId

string

Id. de invitación usado para cancelar la solicitud de agregar participante.

options
CancelAddParticipantOperationOptions

Atributos adicionales para cancelar la operación agregar participante.

Devoluciones

Promise<CancelAddParticipantOperationResult>

getCallConnectionProperties(OperationOptions)

Obtención de las propiedades de conexión de llamada de la llamada

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

Parámetros

options
OperationOptions

Devoluciones

Promise<CallConnectionProperties>

getCallMedia()

Inicializa una nueva instancia de CallMedia.

function getCallMedia(): CallMedia

Devoluciones

CallMedia

getParticipant(CommunicationIdentifier, OperationOptions)

Obtener un participante de la llamada

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

Parámetros

targetParticipant
CommunicationIdentifier

Identificador de comunicación del participante solicitado.

options
OperationOptions

Devoluciones

Promise<CallParticipant>

hangUp(boolean, OperationOptions)

Cuelga la llamada por sí misma o finaliza toda la llamada.

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

Parámetros

isForEveryone

boolean

options
OperationOptions

Devoluciones

Promise<void>

listParticipants(OperationOptions)

Obtener todos los participantes de la llamada

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

Parámetros

options
OperationOptions

Devoluciones

Promise<ListParticipantsResult>

muteParticipant(CommunicationIdentifier, MuteParticipantOption)

Silenciar al participante de la llamada.

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

Parámetros

participant
CommunicationIdentifier

Participante que se silenciará de la llamada.

options
MuteParticipantOption

Atributos adicionales para el participante silenciado.

Devoluciones

Promise<MuteParticipantResult>

removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)

Quitar un participante de la llamada

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

Parámetros

participant
CommunicationIdentifier

El participante se quitará de la llamada.

options
RemoveParticipantsOption

Devoluciones

Promise<RemoveParticipantResult>

transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)

Transferir la llamada a un participante de destino

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

Parámetros

targetParticipant
CommunicationIdentifier

Destino al que se va a transferir.

options
TransferCallToParticipantOptions

Devoluciones

Promise<TransferCallResult>