TeamsCallAgent interface

Pacchetto:

@azure/communication-calling

TeamsCallAgent viene usato per gestire le chiamate di Teams.

Extends

CallAgentCommon

Proprietà

calls

Ottenere le chiamate.

Proprietà ereditate

connectionState	Ottenere lo stato della connessione.
kind	Ottiene il tipo di oggetto dell'agente di chiamata.

Metodi

join(MeetingLocator, JoinCallOptions)	Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione o un ID riunione o coordinate di riunione.
join(TeamsMeetingIdLocator, JoinCallOptions)	Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un ID riunione e un passcode.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Annulla la sottoscrizione della funzione per gli eventi callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Funzione Unsubscribe per l'evento connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Annulla la sottoscrizione della funzione per l'evento incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Funzione Subscribe per gli eventi callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Funzione Subscribe per l'evento connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Funzione Subscribe per l'evento incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Avviare una chiamata 1:N.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Avviare la chiamata 1:1.

Metodi ereditati

dispose()	Eliminare l'agente di chiamata
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità dell'agente di chiamata estese disponibili in questo pacchetto.
handlePushNotification(IncomingCallPushNotificationData)	Gestisce una notifica push.

Dettagli proprietà

calls

Ottenere le chiamate.

calls: readonly TeamsCall[]

Valore della proprietà

readonly TeamsCall[]

Dettagli proprietà ereditate

connectionState

Ottenere lo stato della connessione.

connectionState: ConnectionState

Valore della proprietà

ConnectionState

Ereditato daCallAgentCommon.connectionState

kind

Ottiene il tipo di oggetto dell'agente di chiamata.

kind: CallAgentKind

Valore della proprietà

CallAgentKind

ereditato daCallAgentCommon.kind

Dettagli metodo

join(MeetingLocator, JoinCallOptions)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione o un ID riunione o coordinate di riunione.

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

Parametri

meetingLocator

MeetingLocator

Informazioni sulla riunione.

options

JoinCallOptions

Opzioni di avvio delle chiamate di Teams.

Restituisce

TeamsCall

Oggetto TeamsCall associato alla chiamata.

join(TeamsMeetingIdLocator, JoinCallOptions)

Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un ID riunione e un passcode.

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

Parametri

meetingLocator

TeamsMeetingIdLocator

Informazioni sulla riunione.

options

JoinCallOptions

Chiamare le opzioni di avvio.

Restituisce

TeamsCall

Oggetto Call associato alla chiamata.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Partecipare a una riunione di Teams. Per partecipare a una riunione di Teams, passare un collegamento alla riunione.

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

Parametri

meetingLocator

TeamsMeetingLinkLocator

Informazioni sulla riunione.

options

JoinCallOptions

Chiamare le opzioni di avvio.

Restituisce

TeamsCall

Oggetto Call associato alla chiamata.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Annulla la sottoscrizione della funzione per gli eventi callsUpdated.

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

Parametri

event

"callsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn usato per sottoscrivere questo evento.

off("connectionStateChanged", ConnectionStateChangedEvent)

Funzione Unsubscribe per l'evento connectionStateChanged.

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

Parametri

event

"connectionStateChanged"

nome dell'evento.

listener

ConnectionStateChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

off("incomingCall", TeamsIncomingCallEvent)

Annulla la sottoscrizione della funzione per l'evento incomingCall.

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

Parametri

event

"incomingCall"

nome dell'evento.

listener

TeamsIncomingCallEvent

callback fn usato per sottoscrivere questo evento.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Funzione Subscribe per gli eventi callsUpdated.

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

Parametri

event

"callsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<TeamsCall>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.

on("connectionStateChanged", ConnectionStateChangedEvent)

Funzione Subscribe per l'evento connectionStateChanged.

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

Parametri

event

"connectionStateChanged"

nome dell'evento.

listener

ConnectionStateChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("incomingCall", TeamsIncomingCallEvent)

Funzione Subscribe per l'evento incomingCall.

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

Parametri

event

"incomingCall"

nome dell'evento.

listener

TeamsIncomingCallEvent

callback fn che verrà chiamato quando questo callAgent riceverà una chiamata in arrivo.

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

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Avviare una chiamata 1:N.

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

Parametri

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Restituisce

TeamsCall

Oggetto TeamsCall associato alla chiamata.

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

Avviare la chiamata 1:1.

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

Parametri

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Restituisce

TeamsCall

Oggetto TeamsCall associato alla chiamata.

Dettagli dei metodi ereditati

dispose()

Eliminare l'agente di chiamata

function dispose(): Promise<void>

Restituisce

Promise<void>

ereditato daCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Recupera un oggetto Feature inizializzato e memoizzato con l'API estesa. Controllare l'oggetto Features.* per tutte le funzionalità dell'agente di chiamata estese disponibili in questo pacchetto.

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

Parametri

factory

CallAgentFeatureFactory<TFeature>

Factory per il costruttore di funzionalità dell'agente di chiamata che fornisce un'API estesa.

Restituisce

TFeature

Ereditato daCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Nota

La versione di API è beta e viene fornita come anteprima per gli sviluppatori e potrebbe essere modificata in base al feedback ricevuto. Non usare questa API in un ambiente di produzione.

Gestisce una notifica push.

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

Parametri

data

IncomingCallPushNotificationData

Eseguire il push dei dati delle notifiche

Restituisce

Promise<void>

Ereditato daCallAgentCommon.handlePushNotification