TeamsCallAgent interface

Paket:

@azure/communication-calling

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

Extends

CallAgentCommon

Eigenschaften

calls

Rufen Sie die Anrufe ab.

Geerbte Eigenschaften

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

Methoden

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

Geerbte Methoden

dispose()	Verwerfen dieses Anruf-Agents
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Ruft ein initialisiertes und memoisiertes Featureobjekt mit erweiterter API ab. Überprüfen Sie die Objektfeatures.* auf alle verfügbaren erweiterten Anruf-Agent-Features in diesem Paket.
handlePushNotification(IncomingCallPushNotificationData)	Behandelt eine Pushbenachrichtigung.

Details zur Eigenschaft

calls

Rufen Sie die Anrufe ab.

calls: readonly TeamsCall[]

Eigenschaftswert

readonly TeamsCall[]

Geerbte Eigenschaftsdetails

connectionState

Rufen Sie den Verbindungsstatus ab.

connectionState: ConnectionState

Eigenschaftswert

ConnectionState

geerbt vonCallAgentCommon.connectionState

kind

Ruft die Art des Call-Agent-Objekts ab.

kind: CallAgentKind

Eigenschaftswert

CallAgentKind

vonCallAgentCommon.kind geerbt

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.

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

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

Parameter

meetingLocator

MeetingLocator

Besprechungsinformationen.

options

JoinCallOptions

Startoptionen für Teams-Anrufe.

Gibt zurück

TeamsCall

Das TeamsCall-Objekt, das dem Aufruf zugeordnet ist.

join(TeamsMeetingIdLocator, JoinCallOptions)

Nehmen Sie an einer Teams-Besprechung teil. 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

Anrufstartoptionen.

Gibt zurück

TeamsCall

Das Call-Objekt, das dem Aufruf zugeordnet ist.

join(TeamsMeetingLinkLocator, JoinCallOptions)

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

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

Parameter

meetingLocator

TeamsMeetingLinkLocator

Besprechungsinformationen.

options

JoinCallOptions

Anrufstartoptionen.

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, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("connectionStateChanged", ConnectionStateChangedEvent)

Unsubscribe-Funktion für connectionStateChanged-Ereignis.

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

Parameter

event

"connectionStateChanged"

Ereignisname.

listener

ConnectionStateChangedEvent

callback fn that will be called when value of this property will change.

off("incomingCall", TeamsIncomingCallEvent)

Abmeldefunktion für incomingCall-Ereignis.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

TeamsIncomingCallEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Subscribe function for callsUpdated event.

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

Parameter

event

"callsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<TeamsCall>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

on("connectionStateChanged", ConnectionStateChangedEvent)

Subscribe-Funktion für das ConnectionStateChanged-Ereignis.

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

Parameter

event

"connectionStateChanged"

Ereignisname.

listener

ConnectionStateChangedEvent

callback fn that will be called when value of this property will change.

on("incomingCall", TeamsIncomingCallEvent)

Subscribe function for incomingCall event.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

TeamsIncomingCallEvent

callback fn that will be called when this callAgent will receive an incoming call.

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 TeamsCall-Objekt, das dem Aufruf zugeordnet ist.

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

Starten Sie den Anruf von 1:1.

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

Parameter

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Gibt zurück

TeamsCall

Das TeamsCall-Objekt, das dem Aufruf zugeordnet ist.

Details zur geerbten Methode

dispose()

Verwerfen 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 memoisiertes Featureobjekt mit erweiterter API ab. Überprüfen Sie die Objektfeatures.* auf alle verfügbaren erweiterten Anruf-Agent-Features in diesem Paket.

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

Parameter

factory

CallAgentFeatureFactory<TFeature>

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

Gibt zurück

TFeature

VonCallAgentCommon.feature geerbt

handlePushNotification(IncomingCallPushNotificationData)

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.

Behandelt eine Pushbenachrichtigung.

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

Parameter

data

IncomingCallPushNotificationData

Pushbenachrichtigungsdaten

Gibt zurück

Promise<void>

geerbt vonCallAgentCommon.handlePushNotification