CallAgent interface

Csomag:

@azure/communication-calling

A CallAgent a hívások kezelésére szolgál.

Extends

CallAgentCommon

Tulajdonságok

calls	Kérje le a hívásokat.
displayName	Kérje le a helyi résztvevő megjelenítendő nevét az összes új híváshoz.

Ö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(GroupCallLocator, JoinCallOptions)	Csatlakozás csoporthíváshoz. Csoporthíváshoz való csatlakozáshoz adjon meg egy groupId azonosítót.
join(GroupChatCallLocator, JoinCallOptions)	Csatlakozzon csoportos csevegési híváshoz. Csoportos csevegéshez való csatlakozáshoz adjon át egy threadId azonosítót.
join(MeetingLocator, JoinCallOptions)	Bekapcsolódás Teams-értekezletbe. Teams-értekezlethez való csatlakozáshoz adjon meg egy értekezlethivatkozást vagy egy értekezletkoordinátát.
join(RoomCallLocator, JoinCallOptions)	Csatlakozzon egy szobahíváshoz. Egy szobahíváshoz való csatlakozáshoz adja át a roomId azonosítót.
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<Call>)	Leiratkozás függvény a callsUpdated eseményhez.
off("connectionStateChanged", ConnectionStateChangedEvent)	Leiratkozás függvény a connectionStateChanged eseményhez.
off("incomingCall", IncomingCallEvent)	Leiratkozás függvény a incomingCall eseményhez.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Feliratkozás függvény a callsUpdated eseményhez.
on("connectionStateChanged", ConnectionStateChangedEvent)	Előfizetés függvény a connectionStateChanged eseményhez.
on("incomingCall", IncomingCallEvent)	Subscribe függvény a incomingCall eseményhez.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Hívás kezdeményezése a megadott résztvevőkhöz.
startCall(CommunicationIdentifier[], StartCallOptions)	Hívás kezdeményezése a megadott résztvevőkhöz.

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

Tulajdonság értéke

readonly Call[]

displayName

Kérje le a helyi résztvevő megjelenítendő nevét az összes új híváshoz.

displayName?: string

Tulajdonság értéke

string

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

Csatlakozás csoporthíváshoz. Csoporthíváshoz való csatlakozáshoz adjon meg egy groupId azonosítót.

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

Paraméterek

groupLocator

GroupCallLocator

Csoporthívási információk.

options

JoinCallOptions

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

Válaszok

Call

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

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

Csatlakozzon csoportos csevegési híváshoz. Csoportos csevegéshez való csatlakozáshoz adjon át egy threadId azonosítót.

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

Paraméterek

groupChatCallLocator

GroupChatCallLocator

GroupChat-hívás adatai.

options

JoinCallOptions

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

Válaszok

Call

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

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 adjon meg egy értekezlethivatkozást vagy egy értekezletkoordinátát.

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

Paraméterek

meetingLocator

MeetingLocator

Értekezlet adatai.

options

JoinCallOptions

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

Válaszok

Call

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

join(RoomCallLocator, JoinCallOptions)

Csatlakozzon egy szobahíváshoz. Egy szobahíváshoz való csatlakozáshoz adja át a roomId azonosítót.

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

Paraméterek

roomLocator

RoomCallLocator

Szobahívási információk.

options

JoinCallOptions

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

Válaszok

Call

A híváshoz társított Hívás 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): Call

Paraméterek

meetingLocator

TeamsMeetingIdLocator

Értekezlet adatai.

options

JoinCallOptions

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

Válaszok

Call

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

Paraméterek

meetingLocator

TeamsMeetingLinkLocator

Értekezlet adatai.

options

JoinCallOptions

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

Válaszok

Call

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

off("callsUpdated", CollectionUpdatedEvent<Call>)

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

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

Paraméterek

event

"callsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<Call>

az eseményre való feliratkozáshoz használt visszahívási 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", IncomingCallEvent)

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

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

Paraméterek

event

"incomingCall"

esemény neve.

listener

IncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<Call>)

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

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

Paraméterek

event

"callsUpdated"

esemény neve.

listener

CollectionUpdatedEvent<Call>

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

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

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

Paraméterek

event

"incomingCall"

esemény neve.

listener

IncomingCallEvent

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

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

Hívás kezdeményezése a megadott résztvevőkhöz.

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

Paraméterek

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Indítsa el a hívási beállításokat.

Válaszok

Call

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

startCall(CommunicationIdentifier[], StartCallOptions)

Hívás kezdeményezése a megadott résztvevőkhöz.

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

Paraméterek

participants

CommunicationIdentifier[]

options

StartCallOptions

Indítsa el a hívási beállításokat.

Válaszok

Call

Az elindított híváshoz társított Hívás 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