CallAgent interface

Pakket:

@azure/communication-calling

De CallAgent wordt gebruikt om aanroepen te verwerken.

Uitbreiding

CallAgentCommon

Eigenschappen

calls	Haal de oproepen.
displayName	Haal de weergavenaam op van de lokale deelnemer voor alle nieuwe oproepen.

Overgenomen eigenschappen

connectionState	Haal de verbindingsstatus op.
kind	Haal het type aanroepagentobject op.

Methoden

join(GroupCallLocator, JoinCallOptions)	Neem deel aan een groepsgesprek. Als u wilt deelnemen aan een groepsgesprek, geeft u een groupId door.
join(GroupChatCallLocator, JoinCallOptions)	Neem deel aan een groepschatgesprek. Als u wilt deelnemen aan een groepschatgesprek, geeft u een threadId door.
join(MeetingLocator, JoinCallOptions)	Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een koppeling of vergaderingcoördinaten door.
join(RoomCallLocator, JoinCallOptions)	Neem deel aan een chatgesprek. Als u wilt deelnemen aan een oproep in een vergaderruimte, geeft u een roomId door.
join(TeamsMeetingIdLocator, JoinCallOptions)	Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een vergaderings-id en wachtwoordcode door.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een koppeling naar een vergadering door.
off("callsUpdated", CollectionUpdatedEvent<Call>)	De functie afmelden voor de gebeurtenis callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Afmeldingsfunctie voor connectionStateChanged-gebeurtenis.
off("incomingCall", IncomingCallEvent)	De functie Afmelden voor de incomingCall-gebeurtenis.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Abonneer de functie voor de gebeurtenis callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Abonneer de functie voor de connectionStateChanged-gebeurtenis.
on("incomingCall", IncomingCallEvent)	Abonneer de functie voor de incomingCall-gebeurtenis.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Start een oproep naar de opgegeven deelnemers.
startCall(CommunicationIdentifier[], StartCallOptions)	Start een oproep naar de opgegeven deelnemers.

Overgenomen methoden

dispose()	Deze oproepagent verwijderen
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Hiermee haalt u een geïnitialiseerd en onthouden functieobject op met uitgebreide API. Controleer de objectfuncties.* voor alle beschikbare uitgebreide oproepagentfuncties in dit pakket.
handlePushNotification(IncomingCallPushNotificationData)	Verwerkt een pushmelding.

Eigenschapdetails

calls

Haal de oproepen.

calls: readonly Call[]

Waarde van eigenschap

readonly Call[]

displayName

Haal de weergavenaam op van de lokale deelnemer voor alle nieuwe oproepen.

displayName?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

connectionState

Haal de verbindingsstatus op.

connectionState: ConnectionState

Waarde van eigenschap

ConnectionState

overgenomen vanCallAgentCommon.connectionState

kind

Haal het type aanroepagentobject op.

kind: CallAgentKind

Waarde van eigenschap

CallAgentKind

overgenomen vanCallAgentCommon.kind

Methodedetails

join(GroupCallLocator, JoinCallOptions)

Neem deel aan een groepsgesprek. Als u wilt deelnemen aan een groepsgesprek, geeft u een groupId door.

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

Parameters

groupLocator

GroupCallLocator

Groepsoproepinformatie.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

join(GroupChatCallLocator, JoinCallOptions)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Neem deel aan een groepschatgesprek. Als u wilt deelnemen aan een groepschatgesprek, geeft u een threadId door.

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

Parameters

groupChatCallLocator

GroupChatCallLocator

Groepschat-gespreksgegevens.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

join(MeetingLocator, JoinCallOptions)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een koppeling of vergaderingcoördinaten door.

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

Parameters

meetingLocator

MeetingLocator

Informatie over de vergadering.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

join(RoomCallLocator, JoinCallOptions)

Neem deel aan een chatgesprek. Als u wilt deelnemen aan een oproep in een vergaderruimte, geeft u een roomId door.

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

Parameters

roomLocator

RoomCallLocator

Informatie over kamergesprekken.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

join(TeamsMeetingIdLocator, JoinCallOptions)

Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een vergaderings-id en wachtwoordcode door.

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

Parameters

meetingLocator

TeamsMeetingIdLocator

Informatie over de vergadering.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Neem deel aan een Teams-vergadering. Als u wilt deelnemen aan een Teams-vergadering, geeft u een koppeling naar een vergadering door.

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

Parameters

meetingLocator

TeamsMeetingLinkLocator

Informatie over de vergadering.

options

JoinCallOptions

Startopties voor oproepen.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de aanroep.

off("callsUpdated", CollectionUpdatedEvent<Call>)

De functie afmelden voor de gebeurtenis callsUpdated.

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

Parameters

event

"callsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<Call>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("connectionStateChanged", ConnectionStateChangedEvent)

Afmeldingsfunctie voor connectionStateChanged-gebeurtenis.

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

Parameters

event

"connectionStateChanged"

gebeurtenisnaam.

listener

ConnectionStateChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

off("incomingCall", IncomingCallEvent)

De functie Afmelden voor de incomingCall-gebeurtenis.

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

Parameters

event

"incomingCall"

gebeurtenisnaam.

listener

IncomingCallEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Abonneer de functie voor de gebeurtenis callsUpdated.

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

Parameters

event

"callsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<Call>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.

on("connectionStateChanged", ConnectionStateChangedEvent)

Abonneer de functie voor de connectionStateChanged-gebeurtenis.

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

Parameters

event

"connectionStateChanged"

gebeurtenisnaam.

listener

ConnectionStateChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("incomingCall", IncomingCallEvent)

Abonneer de functie voor de incomingCall-gebeurtenis.

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

Parameters

event

"incomingCall"

gebeurtenisnaam.

listener

IncomingCallEvent

callback fn die wordt aangeroepen wanneer deze callAgent een inkomende oproep ontvangt.

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

Start een oproep naar de opgegeven deelnemers.

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

Parameters

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Oproepopties starten.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de gestarte aanroep.

startCall(CommunicationIdentifier[], StartCallOptions)

Start een oproep naar de opgegeven deelnemers.

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

Parameters

participants

CommunicationIdentifier[]

options

StartCallOptions

Oproepopties starten.

Retouren

Call

Het aanroepobject dat is gekoppeld aan de gestarte aanroep.

Details overgenomen methode

dispose()

Deze oproepagent verwijderen

function dispose(): Promise<void>

Retouren

Promise<void>

overgenomen vanCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Hiermee haalt u een geïnitialiseerd en onthouden functieobject op met uitgebreide API. Controleer de objectfuncties.* voor alle beschikbare uitgebreide oproepagentfuncties in dit pakket.

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

Parameters

factory

CallAgentFeatureFactory<TFeature>

De factory voor de aanroepagentfunctieconstructor die een uitgebreide API biedt.

Retouren

TFeature

overgenomen vanCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Notitie

API is een bètaversie en is beschikbaar als preview-versie voor ontwikkelaars die kan worden aangepast op basis van feedback die we ontvangen. Gebruik deze API niet in een productie-omgeving.

Verwerkt een pushmelding.

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

Parameters

data

IncomingCallPushNotificationData

Pushmeldingsgegevens

Retouren

Promise<void>

overgenomen vanCallAgentCommon.handlePushNotification