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

Métodos

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 ID de reunião ou coordenadas de reunião.
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<TeamsCall>)	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", TeamsIncomingCallEvent)	Função de cancelamento de inscrição para o evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Função de inscrição para chamadasEvento atualizado.
on("connectionStateChanged", ConnectionStateChangedEvent)	Função Subscribe para o evento connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Função Subscribe para o 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()	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 TeamsCall[]

Valor de Propriedade

readonly TeamsCall[]

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(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 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

As equipes chamam as opções de início.

Devoluções

TeamsCall

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

Parâmetros

meetingLocator

TeamsMeetingIdLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

TeamsCall

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

Parâmetros

meetingLocator

TeamsMeetingLinkLocator

Informações da reunião.

options

JoinCallOptions

Opções de início de chamada.

Devoluções

TeamsCall

O objeto Call associado à chamada.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<TeamsCall>

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

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

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

TeamsIncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Parâmetros

event

"callsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<TeamsCall>

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

Função Subscribe para o evento incomingCall.

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

Parâmetros

event

"incomingCall"

nome do evento.

listener

TeamsIncomingCallEvent

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

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

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.

Inicie uma chamada 1:N.

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

Parâmetros

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Devoluções

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

Devoluções

TeamsCall

O objeto TeamsCall associado à chamada.

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