CallAgent interface

Pacote:

@azure/communication-calling

O CallAgent é usado para lidar com chamadas.

Extends

CallAgentCommon

Propriedades

calls	Receba as chamadas.
displayName	Obtenha o nome de exibição do participante local para todas as novas chamadas.

Propriedades Herdadas

connectionState	Obtenha o estado da conexão.
kind	Obtenha o tipo de objeto do agente de chamada.

Métodos

join(GroupCallLocator, JoinCallOptions)	Participe de uma chamada em grupo. Para participar de uma chamada de grupo, passe um groupId.
join(GroupChatCallLocator, JoinCallOptions)	Participe de uma chamada de bate-papo em grupo. Para participar de uma chamada de chat em grupo, passe um threadId.
join(MeetingLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para participar de uma reunião do Teams, passe um link de reunião ou as coordenadas da reunião.
join(RoomCallLocator, JoinCallOptions)	Participe de uma chamada de salas. Para participar de uma chamada de salas, passe um roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para participar numa reunião do Teams, passe um ID de reunião e um código de acesso.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para participar de uma reunião do Teams, passe um link de reunião.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Função de cancelamento de inscrição para callsUpdated event.
off("connectionStateChanged", ConnectionStateChangedEvent)	Função de cancelamento de inscrição para o evento connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Função de cancelamento de inscrição para o evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Função de inscrição para chamadasEvento atualizado.
on("connectionStateChanged", ConnectionStateChangedEvent)	Função Subscribe para o evento connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Função Subscribe para o evento incomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Inicie uma chamada para os participantes fornecidos.
startCall(CommunicationIdentifier[], StartCallOptions)	Inicie uma chamada para os participantes fornecidos.

Métodos Herdados

dispose()	Eliminar este Agente de Chamada
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de agente de chamada estendida disponíveis neste pacote.
handlePushNotification(IncomingCallPushNotificationData)	Lida com uma notificação push.

Detalhes de Propriedade

calls

Receba as chamadas.

calls: readonly Call[]

Valor de Propriedade

readonly Call[]

displayName

Obtenha o nome de exibição do participante local para todas as novas chamadas.

displayName?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

connectionState

Obtenha o estado da conexão.

connectionState: ConnectionState

Valor de Propriedade

ConnectionState

herdado de CallAgentCommon.connectionState

kind

Obtenha o tipo de objeto do agente de chamada.

kind: CallAgentKind

Valor de Propriedade

CallAgentKind

herdado deCallAgentCommon.kind

Detalhes de Método

join(GroupCallLocator, JoinCallOptions)

Participe de uma chamada em grupo. Para participar de uma chamada de grupo, passe um groupId.

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

Parâmetros

groupLocator

GroupCallLocator

Informações de chamada em grupo.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

join(GroupChatCallLocator, JoinCallOptions)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Participe de uma chamada de bate-papo em grupo. Para participar de uma chamada de chat em grupo, passe um threadId.

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

Parâmetros

groupChatCallLocator

GroupChatCallLocator

Informações de chamada do Chat de Grupo.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

join(MeetingLocator, JoinCallOptions)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Participe de uma reunião do Teams. Para participar de uma reunião do Teams, passe um link de reunião ou as coordenadas da reunião.

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

Parâmetros

meetingLocator

MeetingLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

join(RoomCallLocator, JoinCallOptions)

Participe de uma chamada de salas. Para participar de uma chamada de salas, passe um roomId.

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

Parâmetros

roomLocator

RoomCallLocator

Informações sobre a chamada de quarto.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

join(TeamsMeetingIdLocator, JoinCallOptions)

Participe de uma reunião do Teams. Para participar numa reunião do Teams, passe um ID de reunião e um código de acesso.

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

Parâmetros

meetingLocator

TeamsMeetingIdLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Participe de uma reunião do Teams. Para participar de uma reunião do Teams, passe um link de reunião.

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

Parâmetros

meetingLocator

TeamsMeetingLinkLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

Call

O objeto Call associado à chamada.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Função de cancelamento de inscrição para callsUpdated event.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<Call>

retorno de chamada fn que foi usado para se inscrever neste evento.

off("connectionStateChanged", ConnectionStateChangedEvent)

Função de cancelamento de inscrição para o evento connectionStateChanged.

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

Parâmetros

event

"connectionStateChanged"

nome do evento.

listener

ConnectionStateChangedEvent

retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.

off("incomingCall", IncomingCallEvent)

Função de cancelamento de inscrição para o evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

IncomingCallEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Função de inscrição para chamadasEvento atualizado.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<Call>

retorno de chamada fn que será chamado quando essa coleção for alterada, ele passará matrizes de elementos adicionados e removidos.

on("connectionStateChanged", ConnectionStateChangedEvent)

Função Subscribe para o evento connectionStateChanged.

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

Parâmetros

event

"connectionStateChanged"

nome do evento.

listener

ConnectionStateChangedEvent

retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.

on("incomingCall", IncomingCallEvent)

Função Subscribe para o evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

IncomingCallEvent

callback fn que será chamado quando este callAgent receber uma chamada de entrada.

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

Inicie uma chamada para os participantes fornecidos.

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

Parâmetros

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Iniciar opções de chamada.

Devoluções

Call

O objeto Call associado à chamada iniciada.

startCall(CommunicationIdentifier[], StartCallOptions)

Inicie uma chamada para os participantes fornecidos.

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

Parâmetros

participants

CommunicationIdentifier[]

options

StartCallOptions

Iniciar opções de chamada.

Devoluções

Call

O objeto Call associado à chamada iniciada.

Detalhes do Método Herdado

dispose()

Eliminar este Agente de Chamada

function dispose(): Promise<void>

Devoluções

Promise<void>

herdado deCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de agente de chamada estendida disponíveis neste pacote.

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

Parâmetros

factory

CallAgentFeatureFactory<TFeature>

A fábrica do construtor de recursos do agente de chamada que fornece uma API estendida.

Devoluções

TFeature

herdado de CallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Lida com uma notificação push.

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

Parâmetros

data

IncomingCallPushNotificationData

Dados de notificação por push

Devoluções

Promise<void>

herdado de CallAgentCommon.handlePushNotification