CallAgent interface

Paquete:

@azure/communication-calling

CallAgent se usa para controlar las llamadas.

Extends

CallAgentCommon

Propiedades

calls	Obtenga las llamadas.
displayName	Obtenga el nombre para mostrar del participante local para todas las llamadas nuevas.

Propiedades heredadas

connectionState	Obtenga el estado de conexión.
kind	Obtiene el tipo de objeto agente de llamada.

Métodos

join(GroupCallLocator, JoinCallOptions)	Únase a una llamada de grupo. Para unirse a una llamada de grupo, pase un groupId.
join(GroupChatCallLocator, JoinCallOptions)	Únase a una llamada de chat grupal. Para unirse a una llamada de chat grupal, pase un threadId.
join(MeetingLocator, JoinCallOptions)	Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un vínculo de reunión o coordenadas de reunión.
join(RoomCallLocator, JoinCallOptions)	Únase a una llamada a salas. Para unirse a una llamada a salas, pase un roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un identificador de reunión y un código de acceso.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un vínculo de reunión.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Cancelar la suscripción de la función para llamadasActualizar evento.
off("connectionStateChanged", ConnectionStateChangedEvent)	Función de cancelación de la suscripción para el evento connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Cancelar la suscripción de la función para el evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Función Subscribe para llamadasActualizar evento.
on("connectionStateChanged", ConnectionStateChangedEvent)	Función Subscribe para el evento connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Función Subscribe para el evento incomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Inicie una llamada a los participantes proporcionados.
startCall(CommunicationIdentifier[], StartCallOptions)	Inicie una llamada a los participantes proporcionados.

Métodos heredados

dispose()	Eliminación de este agente de llamada
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Recupera un objeto Feature inicializado y memoizado con la API extendida. Compruebe el objeto Features.* para ver todas las características disponibles del agente de llamadas extendidas en este paquete.
handlePushNotification(IncomingCallPushNotificationData)	Controla una notificación de inserción.

Detalles de las propiedades

calls

Obtenga las llamadas.

calls: readonly Call[]

Valor de propiedad

readonly Call[]

displayName

Obtenga el nombre para mostrar del participante local para todas las llamadas nuevas.

displayName?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

connectionState

Obtenga el estado de conexión.

connectionState: ConnectionState

Valor de propiedad

ConnectionState

heredado deCallAgentCommon.connectionState

kind

Obtiene el tipo de objeto agente de llamada.

kind: CallAgentKind

Valor de propiedad

CallAgentKind

Heredado deCallAgentCommon.kind

Detalles del método

join(GroupCallLocator, JoinCallOptions)

Únase a una llamada de grupo. Para unirse a una llamada de grupo, pase un groupId.

function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call

Parámetros

groupLocator

GroupCallLocator

Información de llamada de grupo.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

join(GroupChatCallLocator, JoinCallOptions)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Únase a una llamada de chat grupal. Para unirse a una llamada de chat grupal, pase un threadId.

function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call

Parámetros

groupChatCallLocator

GroupChatCallLocator

Información de llamada de GroupChat.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

join(MeetingLocator, JoinCallOptions)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un vínculo de reunión o coordenadas de reunión.

function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): Call

Parámetros

meetingLocator

MeetingLocator

Información de la reunión.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

join(RoomCallLocator, JoinCallOptions)

Únase a una llamada a salas. Para unirse a una llamada a salas, pase un roomId.

function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call

Parámetros

roomLocator

RoomCallLocator

Información de llamadas de la sala.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

join(TeamsMeetingIdLocator, JoinCallOptions)

Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un identificador de reunión y un código de acceso.

function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): Call

Parámetros

meetingLocator

TeamsMeetingIdLocator

Información de la reunión.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Unirse a una reunión de Teams. Para unirse a una reunión de Teams, pase un vínculo de reunión.

function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): Call

Parámetros

meetingLocator

TeamsMeetingLinkLocator

Información de la reunión.

options

JoinCallOptions

Opciones de inicio de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Cancelar la suscripción de la función para llamadasActualizar evento.

function off(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)

Parámetros

event

"callsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<Call>

callback fn que se usó para suscribirse a este evento.

off("connectionStateChanged", ConnectionStateChangedEvent)

Función de cancelación de la suscripción para el evento connectionStateChanged.

function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

Parámetros

event

"connectionStateChanged"

nombre del evento.

listener

ConnectionStateChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

off("incomingCall", IncomingCallEvent)

Cancelar la suscripción de la función para el evento incomingCall.

function off(event: "incomingCall", listener: IncomingCallEvent)

Parámetros

event

"incomingCall"

nombre del evento.

listener

IncomingCallEvent

callback fn que se usó para suscribirse a este evento.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Función Subscribe para llamadasActualizar evento.

function on(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)

Parámetros

event

"callsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<Call>

callback fn al que se llamará cuando cambie esta colección, pasará matrices de elementos agregados y quitados.

on("connectionStateChanged", ConnectionStateChangedEvent)

Función Subscribe para el evento connectionStateChanged.

function on(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

Parámetros

event

"connectionStateChanged"

nombre del evento.

listener

ConnectionStateChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("incomingCall", IncomingCallEvent)

Función Subscribe para el evento incomingCall.

function on(event: "incomingCall", listener: IncomingCallEvent)

Parámetros

event

"incomingCall"

nombre del evento.

listener

IncomingCallEvent

callback fn que se llamará cuando este callAgent recibirá una llamada entrante.

startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Inicie una llamada a los participantes proporcionados.

function startCall(participants: (PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call

Parámetros

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Iniciar opciones de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada iniciada.

startCall(CommunicationIdentifier[], StartCallOptions)

Inicie una llamada a los participantes proporcionados.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call

Parámetros

participants

CommunicationIdentifier[]

options

StartCallOptions

Iniciar opciones de llamada.

Devoluciones

Call

Objeto Call asociado a la llamada iniciada.

Detalles de los métodos heredados

dispose()

Eliminación de este agente de llamada

function dispose(): Promise<void>

Devoluciones

Promise<void>

heredado deCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Recupera un objeto Feature inicializado y memoizado con la API extendida. Compruebe el objeto Features.* para ver todas las características disponibles del agente de llamadas extendidas en este paquete.

function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature

Parámetros

factory

CallAgentFeatureFactory<TFeature>

Generador del constructor de características del agente de llamada que proporciona una API extendida.

Devoluciones

TFeature

heredado deCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Controla una notificación de inserción.

function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>

Parámetros

data

IncomingCallPushNotificationData

Datos de notificación de inserción

Devoluciones

Promise<void>

heredado deCallAgentCommon.handlePushNotification