TeamsCallAgent interface

Paket:

@azure/communication-calling

Der TeamsCallAgent wird verwendet, um Teams-Aufrufe zu verarbeiten.

Extends

CallAgentCommon

Eigenschaften

calls

Rufen Sie die Aufrufe ab.

Geerbte Eigenschaften

connectionState	Rufen Sie den Verbindungsstatus ab.
kind	Rufen Sie die Art des Aufruf-Agent-Objekts ab.

Methoden

join(MeetingLocator, JoinCallOptions)	Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie einen Besprechungslink, eine Besprechungs-ID oder Besprechungskoordinaten.
join(TeamsMeetingIdLocator, JoinCallOptions)	Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie eine Besprechungs-ID und eine Kennung.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie einen Besprechungslink.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Unsubscribe-Funktion für callsUpdated-Ereignis.
off("connectionStateChanged", ConnectionStateChangedEvent)	Unsubscribe-Funktion für das connectionStateChanged-Ereignis.
off("incomingCall", TeamsIncomingCallEvent)	Unsubscribe-Funktion für incomingCall-Ereignis.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Subscribe-Funktion für callsUpdated-Ereignis.
on("connectionStateChanged", ConnectionStateChangedEvent)	Subscribe-Funktion für das connectionStateChanged-Ereignis.
on("incomingCall", TeamsIncomingCallEvent)	Subscribe-Funktion für incomingCall-Ereignis.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Starten Sie einen 1:N-Anruf.
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Starten Sie den Anruf 1:1.

Geerbte Methoden

dispose()	Entsorgen dieses Anruf-Agents
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Ruft ein initialisiertes und gespeichertes Featureobjekt mit erweiterter API ab. Überprüfen Sie das Objekt Features.* auf alle verfügbaren Features des erweiterten Aufruf-Agents in diesem Paket.
handlePushNotification(PushNotificationData)	Verarbeitet eine Pushbenachrichtigung.

Details zur Eigenschaft

calls

Rufen Sie die Aufrufe ab.

calls: ReadonlyArray<TeamsCall>

Eigenschaftswert

ReadonlyArray<TeamsCall>

Geerbte Eigenschaftsdetails

connectionState

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Rufen Sie den Verbindungsstatus ab.

connectionState: ConnectionState

Eigenschaftswert

ConnectionState

Geerbt vonCallAgentCommon.connectionState

kind

Rufen Sie die Art des Aufruf-Agent-Objekts ab.

kind: CallAgentKind

Eigenschaftswert

CallAgentKind

Geerbt vonCallAgentCommon.kind

Details zur Methode

join(MeetingLocator, JoinCallOptions)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie einen Besprechungslink, eine Besprechungs-ID oder Besprechungskoordinaten.

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

Parameter

meetingLocator

MeetingLocator

Besprechungsinformationen.

options

JoinCallOptions

Startoptionen für Teams-Aufrufe.

Gibt zurück

TeamsCall

Das dem Aufruf zugeordnete TeamsCall-Objekt.

join(TeamsMeetingIdLocator, JoinCallOptions)

Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie eine Besprechungs-ID und eine Kennung.

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

Parameter

meetingLocator

TeamsMeetingIdLocator

Besprechungsinformationen.

options

JoinCallOptions

Startoptionen aufrufen.

Gibt zurück

TeamsCall

Das Call-Objekt, das dem Aufruf zugeordnet ist.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Teilnehmen an einer Teams-Besprechung Um an einer Teams-Besprechung teilzunehmen, übergeben Sie einen Besprechungslink.

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

Parameter

meetingLocator

TeamsMeetingLinkLocator

Besprechungsinformationen.

options

JoinCallOptions

Startoptionen aufrufen.

Gibt zurück

TeamsCall

Das Call-Objekt, das dem Aufruf zugeordnet ist.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Unsubscribe-Funktion für callsUpdated-Ereignis.

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

Parameter

event

"callsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn, das zum Abonnieren dieses Ereignisses verwendet wurde.

off("connectionStateChanged", ConnectionStateChangedEvent)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Unsubscribe-Funktion für das connectionStateChanged-Ereignis.

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

Parameter

event

"connectionStateChanged"

Ereignisname.

listener

ConnectionStateChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

off("incomingCall", TeamsIncomingCallEvent)

Unsubscribe-Funktion für incomingCall-Ereignis.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

TeamsIncomingCallEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Subscribe-Funktion für callsUpdated-Ereignis.

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

Parameter

event

"callsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<TeamsCall>

Rückruf fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

on("connectionStateChanged", ConnectionStateChangedEvent)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Subscribe-Funktion für das connectionStateChanged-Ereignis.

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

Parameter

event

"connectionStateChanged"

Ereignisname.

listener

ConnectionStateChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("incomingCall", TeamsIncomingCallEvent)

Subscribe-Funktion für incomingCall-Ereignis.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

TeamsIncomingCallEvent

rückruf fn, der aufgerufen wird, wenn dieser callAgent einen eingehenden Anruf empfängt.

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

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Starten Sie einen 1:N-Anruf.

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

Parameter

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Gibt zurück

TeamsCall

Das dem Aufruf zugeordnete TeamsCall-Objekt.

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

Starten Sie den Anruf 1:1.

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

Parameter

participant

MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Gibt zurück

TeamsCall

Das dem Aufruf zugeordnete TeamsCall-Objekt.

Details zur geerbten Methode

dispose()

Entsorgen dieses Anruf-Agents

function dispose(): Promise<void>

Gibt zurück

Promise<void>

Geerbt vonCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft ein initialisiertes und gespeichertes Featureobjekt mit erweiterter API ab. Überprüfen Sie das Objekt Features.* auf alle verfügbaren Features des erweiterten Aufruf-Agents in diesem Paket.

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

Parameter

factory

CallAgentFeatureFactory<TFeature>

Die Factory für den Aufruf-Agent-Featurekonstruktor, der eine erweiterte API bereitstellt.

Gibt zurück

TFeature

Geerbt vonCallAgentCommon.feature

handlePushNotification(PushNotificationData)

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Verarbeitet eine Pushbenachrichtigung.

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

Parameter

data

PushNotificationData

Pushbenachrichtigungsdaten

Gibt zurück

Promise<void>

Geerbt vonCallAgentCommon.handlePushNotification