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 de agente de chamada.

Métodos

join(GroupCallLocator, JoinCallOptions)	Ingresse em uma chamada de grupo. Para ingressar em uma chamada de grupo, passe uma groupId.
join(GroupChatCallLocator, JoinCallOptions)	Ingresse em uma chamada de chat em grupo. Para ingressar em uma chamada de chat em grupo, passe uma threadId.
join(MeetingLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para ingressar em uma reunião do Teams, passe um link de reunião ou coordenadas de reunião.
join(RoomCallLocator, JoinCallOptions)	Ingresse em uma chamada de salas. Para ingressar em uma chamada de salas, passe uma roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para ingressar em uma reunião do Teams, passe uma ID de reunião e uma senha.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Participe de uma reunião do Teams. Para ingressar em uma reunião do Teams, passe um link de reunião.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Função Desinscreva para o evento callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Função Cancelar assinatura do evento connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Função Cancelar assinatura do evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Função de assinatura para evento callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Função de assinatura do evento connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Função de assinatura do 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()	Descartar este agente de chamada
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Recupera um objeto Feature inicializado e memorando com a API estendida. Verifique o objeto Features.* para obter todos os recursos de agente de chamada estendida disponíveis neste pacote.
handlePushNotification(IncomingCallPushNotificationData)	Manipula uma notificação por push.

Detalhes da propriedade

calls

Receba as chamadas.

calls: readonly Call[]

Valor da propriedade

readonly Call[]

displayName

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

displayName?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

connectionState

Obtenha o estado da conexão.

connectionState: ConnectionState

Valor da propriedade

ConnectionState

Herdado deCallAgentCommon.connectionState

kind

Obtenha o tipo de objeto de agente de chamada.

kind: CallAgentKind

Valor da propriedade

CallAgentKind

herdado deCallAgentCommon.kind

Detalhes do método

join(GroupCallLocator, JoinCallOptions)

Ingresse em uma chamada de grupo. Para ingressar em uma chamada de grupo, passe uma groupId.

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

Parâmetros

groupLocator

GroupCallLocator

Informações de chamada de grupo.

options

JoinCallOptions

Opções de início de chamada.

Retornos

Call

O objeto Call associado à chamada.

join(GroupChatCallLocator, JoinCallOptions)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Ingresse em uma chamada de chat em grupo. Para ingressar em uma chamada de chat em grupo, passe uma threadId.

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

Parâmetros

groupChatCallLocator

GroupChatCallLocator

Informações de chamada do GroupChat.

options

JoinCallOptions

Opções de início de chamada.

Retornos

Call

O objeto Call associado à chamada.

join(MeetingLocator, JoinCallOptions)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Participe de uma reunião do Teams. Para ingressar em uma reunião do Teams, passe um link de reunião ou coordenadas de 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.

Retornos

Call

O objeto Call associado à chamada.

join(RoomCallLocator, JoinCallOptions)

Ingresse em uma chamada de salas. Para ingressar em uma chamada de salas, passe uma roomId.

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

Parâmetros

roomLocator

RoomCallLocator

Informações de chamada de sala.

options

JoinCallOptions

Opções de início de chamada.

Retornos

Call

O objeto Call associado à chamada.

join(TeamsMeetingIdLocator, JoinCallOptions)

Participe de uma reunião do Teams. Para ingressar em uma reunião do Teams, passe uma ID de reunião e uma senha.

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.

Retornos

Call

O objeto Call associado à chamada.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Participe de uma reunião do Teams. Para ingressar em 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.

Retornos

Call

O objeto Call associado à chamada.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Função Desinscreva para o evento callsUpdated.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<Call>

fn de retorno de chamada que foi usado para assinar este evento.

off("connectionStateChanged", ConnectionStateChangedEvent)

Função Cancelar assinatura do evento connectionStateChanged.

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

Parâmetros

event

"connectionStateChanged"

nome do evento.

listener

ConnectionStateChangedEvent

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

off("incomingCall", IncomingCallEvent)

Função Cancelar assinatura do evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

IncomingCallEvent

fn de retorno de chamada que foi usado para assinar este evento.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Função de assinatura para evento callsUpdated.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<Call>

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

on("connectionStateChanged", ConnectionStateChangedEvent)

Função de assinatura do evento connectionStateChanged.

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

Parâmetros

event

"connectionStateChanged"

nome do evento.

listener

ConnectionStateChangedEvent

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

on("incomingCall", IncomingCallEvent)

Função de assinatura do evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

IncomingCallEvent

fn de retorno de chamada que será chamado quando esse 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

Inicie as opções de Chamada.

Retornos

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

Inicie as opções de Chamada.

Retornos

Call

O objeto Call associado à chamada iniciada.

Detalhes do método herdado

dispose()

Descartar este agente de chamada

function dispose(): Promise<void>

Retornos

Promise<void>

Herdado deCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Recupera um objeto Feature inicializado e memorando com a API estendida. Verifique o objeto Features.* para obter 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.

Retornos

TFeature

herdado de callagentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Manipula uma notificação por push.

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

Parâmetros

data

IncomingCallPushNotificationData

Dados de notificação por push

Retornos

Promise<void>

Herdado deCallAgentCommon.handlePushNotification