TeamsCallAgent interface

Csomag:

@azure/communication-calling

A TeamsCallAgent a Teams-hívások kezelésére szolgál.

Extends

CallAgentCommon

Tulajdonságok

calls

Kérje le a hívásokat.

Örökölt tulajdonságok

connectionState	Kérje le a kapcsolat állapotát.
kind	A hívásügynök objektumának lekérése.

Metódusok

join(MeetingLocator, JoinCallOptions)	Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adja meg az értekezlet hivatkozását, az értekezlet azonosítóját vagy az értekezlet koordinátáit.
join(TeamsMeetingIdLocator, JoinCallOptions)	Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adjon meg egy értekezlet-azonosítót és egy pin-kódot.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adjon meg egy értekezlethivatkozást.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Leiratkozás függvény a callsUpdated eseményhez.
off("connectionStateChanged", ConnectionStateChangedEvent)	Leiratkozás függvény a connectionStateChanged eseményhez.
off("incomingCall", TeamsIncomingCallEvent)	Leiratkozás függvény a incomingCall eseményhez.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Feliratkozás függvény a callsUpdated eseményhez.
on("connectionStateChanged", ConnectionStateChangedEvent)	Előfizetés függvény a connectionStateChanged eseményhez.
on("incomingCall", TeamsIncomingCallEvent)	Subscribe függvény a incomingCall eseményhez.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	1:N-hívás indítása.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	1:1-ás hívás indítása.

Örökölt metódusok

dispose()	A hívásügynök megsemmisítése
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Egy inicializált és emlékeztető funkcióobjektum lekérése kiterjesztett API-val. Ellenőrizze a csomag összes elérhető kiterjesztett hívásügynök-funkcióját a Szolgáltatások objektumban.*
handlePushNotification(IncomingCallPushNotificationData)	Leküldéses értesítést kezel.

Tulajdonság adatai

calls

Kérje le a hívásokat.

calls: readonly TeamsCall[]

Tulajdonság értéke

readonly TeamsCall[]

Örökölt tulajdonság részletei

connectionState

Kérje le a kapcsolat állapotát.

connectionState: ConnectionState

Tulajdonság értéke

ConnectionState

CallAgentCommon.connectionState

kind

A hívásügynök objektumának lekérése.

kind: CallAgentKind

Tulajdonság értéke

CallAgentKind

CallAgentCommon.kind

Metódus adatai

join(MeetingLocator, JoinCallOptions)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adja meg az értekezlet hivatkozását, az értekezlet azonosítóját vagy az értekezlet koordinátáit.

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

Paraméterek

meetingLocator

MeetingLocator

Értekezlet adatai.

options

JoinCallOptions

A Teams hívásindítási lehetőségei.

Válaszok

TeamsCall

A híváshoz társított TeamsCall objektum.

join(TeamsMeetingIdLocator, JoinCallOptions)

Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adjon meg egy értekezlet-azonosítót és egy pin-kódot.

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

Paraméterek

meetingLocator

TeamsMeetingIdLocator

Értekezlet adatai.

options

JoinCallOptions

Hívásindítási beállítások.

Válaszok

TeamsCall

A híváshoz társított Hívás objektum.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adjon meg egy értekezlethivatkozást.

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

Paraméterek

meetingLocator

TeamsMeetingLinkLocator

Értekezlet adatai.

options

JoinCallOptions

Hívásindítási beállítások.

Válaszok

TeamsCall

A híváshoz társított Hívás objektum.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Leiratkozás függvény a callsUpdated eseményhez.

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

Paraméterek

event

"callsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<TeamsCall>

az eseményre való feliratkozáshoz használt allback fn.

off("connectionStateChanged", ConnectionStateChangedEvent)

Leiratkozás függvény a connectionStateChanged eseményhez.

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

Paraméterek

event

"connectionStateChanged"

esemény neve.

listener

ConnectionStateChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

off("incomingCall", TeamsIncomingCallEvent)

Leiratkozás függvény a incomingCall eseményhez.

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

Paraméterek

event

"incomingCall"

esemény neve.

listener

TeamsIncomingCallEvent

az eseményre való feliratkozáshoz használt visszahívási fn.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Feliratkozás függvény a callsUpdated eseményhez.

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

Paraméterek

event

"callsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<TeamsCall>

a gyűjtemény módosításakor meghívandó visszahívási fn a hozzáadott és eltávolított elemek tömbjeinek lesz átadva.

on("connectionStateChanged", ConnectionStateChangedEvent)

Előfizetés függvény a connectionStateChanged eseményhez.

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

Paraméterek

event

"connectionStateChanged"

esemény neve.

listener

ConnectionStateChangedEvent

visszahívási fn, amely akkor lesz meghívva, amikor ennek a tulajdonságnak az értéke megváltozik.

on("incomingCall", TeamsIncomingCallEvent)

Subscribe függvény a incomingCall eseményhez.

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

Paraméterek

event

"incomingCall"

esemény neve.

listener

TeamsIncomingCallEvent

visszahívási fn, amely akkor lesz meghívva, amikor a callAgent bejövő hívást fogad.

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

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

1:N-hívás indítása.

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

Paraméterek

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Válaszok

TeamsCall

A híváshoz társított TeamsCall objektum.

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

1:1-ás hívás indítása.

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

Paraméterek

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Válaszok

TeamsCall

A híváshoz társított TeamsCall objektum.

Örökölt metódus részletei

dispose()

A hívásügynök megsemmisítése

function dispose(): Promise<void>

Válaszok

Promise<void>

CallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

Egy inicializált és emlékeztető funkcióobjektum lekérése kiterjesztett API-val. Ellenőrizze a csomag összes elérhető kiterjesztett hívásügynök-funkcióját a Szolgáltatások objektumban.*

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

Paraméterek

factory

CallAgentFeatureFactory<TFeature>

A hívásügynök szolgáltatás konstruktorának gyára, amely kiterjesztett API-t biztosít.

Válaszok

TFeature

CallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Megjegyzés

Ez a API bétaverziója; fejlesztői előzetes verzióként szolgál, és a kapott visszajelzések alapján változhat. Ne használja ezt az API-t éles környezetben.

Leküldéses értesítést kezel.

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

Paraméterek

data

IncomingCallPushNotificationData

Leküldéses értesítési adatok

Válaszok

Promise<void>

CallAgentCommon.handlePushNotification