TeamsCallAgent interface

Pacote:

@azure/communication-calling

O TeamsCallAgent é usado para lidar com chamadas do Teams.

Extends

CallAgentCommon

Propriedades

calls

Receba as chamadas.

Propriedades herdadas

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

Métodos

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 uma ID de reunião ou coordenadas de reunião.
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<TeamsCall>)	Função Desinscreva para o evento callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Função Cancelar assinatura do evento connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Função Cancelar assinatura do evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Função de assinatura para evento callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Função de assinatura do evento connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Função de assinatura do evento incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Inicie uma chamada 1:N.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Inicie a chamada 1:1.

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 TeamsCall[]

Valor da propriedade

readonly TeamsCall[]

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(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 uma ID de reunião ou coordenadas de reunião.

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

Parâmetros

meetingLocator

MeetingLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada do Teams.

Retornos

TeamsCall

O objeto TeamsCall 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): TeamsCall

Parâmetros

meetingLocator

TeamsMeetingIdLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Retornos

TeamsCall

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): TeamsCall

Parâmetros

meetingLocator

TeamsMeetingLinkLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Retornos

TeamsCall

O objeto Call associado à chamada.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Função Desinscreva para o evento callsUpdated.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn 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", TeamsIncomingCallEvent)

Função Cancelar assinatura do evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

TeamsIncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Função de assinatura para evento callsUpdated.

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<TeamsCall>

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", TeamsIncomingCallEvent)

Função de assinatura do evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

TeamsIncomingCallEvent

fn de retorno de chamada que será chamado quando esse callAgent receber uma chamada de entrada.

startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)

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.

Inicie uma chamada 1:N.

function startCall(participants: (PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartTeamsGroupCallOptions): TeamsCall

Parâmetros

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Retornos

TeamsCall

O objeto TeamsCall associado à chamada.

startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)

Inicie a chamada 1:1.

function startCall(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: StartTeamsCallOptions): TeamsCall

Parâmetros

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Retornos

TeamsCall

O objeto TeamsCall associado à chamada.

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