CallAgent interface

Paket:

@azure/communication-calling

Der CallAgent wird zum Verarbeiten von Aufrufen verwendet.

Extends

CallAgentCommon

Eigenschaften

calls	Rufen Sie die Anrufe ab.
displayName	Rufen Sie den Anzeigenamen des lokalen Teilnehmers für alle neuen Anrufe ab.

Geerbte Eigenschaften

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

Methoden

join(GroupCallLocator, JoinCallOptions)	Treten Sie einem Gruppenanruf bei. Um einem Gruppenanruf beizutreten, übergeben Sie eine groupId.
join(GroupChatCallLocator, JoinCallOptions)	Treten Sie einem Gruppenchatanruf bei. Um einem Gruppenchatanruf beizutreten, übergeben Sie eine threadId.
join(MeetingLocator, JoinCallOptions)	Nehmen Sie an einer Teams-Besprechung teil. Um an einer Teams-Besprechung teilzunehmen, übergeben Sie einen Besprechungslink oder eine Besprechungskoordinate.
join(RoomCallLocator, JoinCallOptions)	Nehmen Sie an einem Chatroom teil. Um einem Chatroomanruf beizutreten, übergeben Sie eine roomId.
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<Call>)	Unsubscribe-Funktion für callsUpdated-Ereignis.
off("connectionStateChanged", ConnectionStateChangedEvent)	Unsubscribe-Funktion für connectionStateChanged-Ereignis.
off("incomingCall", IncomingCallEvent)	Abmeldefunktion für incomingCall-Ereignis.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Subscribe function for callsUpdated event.
on("connectionStateChanged", ConnectionStateChangedEvent)	Subscribe-Funktion für das ConnectionStateChanged-Ereignis.
on("incomingCall", IncomingCallEvent)	Subscribe function for incomingCall event.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Initiieren Sie einen Anruf an die bereitgestellten Teilnehmer.
startCall(CommunicationIdentifier[], StartCallOptions)	Initiieren Sie einen Anruf an die bereitgestellten Teilnehmer.

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

Eigenschaftswert

readonly Call[]

displayName

Rufen Sie den Anzeigenamen des lokalen Teilnehmers für alle neuen Anrufe ab.

displayName?: string

Eigenschaftswert

string

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(GroupCallLocator, JoinCallOptions)

Treten Sie einem Gruppenanruf bei. Um einem Gruppenanruf beizutreten, übergeben Sie eine groupId.

function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call

Parameter

groupLocator

GroupCallLocator

Gruppenanrufinformationen.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

Das Call-Objekt, das dem Aufruf zugeordnet ist.

join(GroupChatCallLocator, 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.

Treten Sie einem Gruppenchatanruf bei. Um einem Gruppenchatanruf beizutreten, übergeben Sie eine threadId.

function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call

Parameter

groupChatCallLocator

GroupChatCallLocator

GroupChat-Anrufinformationen.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

Das Call-Objekt, das dem Aufruf zugeordnet ist.

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 Besprechungskoordinate.

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

Parameter

meetingLocator

MeetingLocator

Besprechungsinformationen.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

Das Call-Objekt, das dem Aufruf zugeordnet ist.

join(RoomCallLocator, JoinCallOptions)

Nehmen Sie an einem Chatroom teil. Um einem Chatroomanruf beizutreten, übergeben Sie eine roomId.

function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call

Parameter

roomLocator

RoomCallLocator

Anrufinformationen für Chatrooms.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

Das Call-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): Call

Parameter

meetingLocator

TeamsMeetingIdLocator

Besprechungsinformationen.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

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

Parameter

meetingLocator

TeamsMeetingLinkLocator

Besprechungsinformationen.

options

JoinCallOptions

Anrufstartoptionen.

Gibt zurück

Call

Das Call-Objekt, das dem Aufruf zugeordnet ist.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Unsubscribe-Funktion für callsUpdated-Ereignis.

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

Parameter

event

"callsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<Call>

callback 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", IncomingCallEvent)

Abmeldefunktion für incomingCall-Ereignis.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

IncomingCallEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Subscribe function for callsUpdated event.

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

Parameter

event

"callsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<Call>

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

Subscribe function for incomingCall event.

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

Parameter

event

"incomingCall"

Ereignisname.

listener

IncomingCallEvent

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

startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Initiieren Sie einen Anruf an die bereitgestellten Teilnehmer.

function startCall(participants: (PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call

Parameter

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Anrufoptionen starten.

Gibt zurück

Call

Das Call-Objekt, das dem gestarteten Aufruf zugeordnet ist.

startCall(CommunicationIdentifier[], StartCallOptions)

Initiieren Sie einen Anruf an die bereitgestellten Teilnehmer.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call

Parameter

participants

CommunicationIdentifier[]

options

StartCallOptions

Anrufoptionen starten.

Gibt zurück

Call

Das Call-Objekt, das dem gestarteten 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