CallAgent interface

Balíček:

@azure/communication-calling

CallAgent se používá ke zpracování volání.

Extends

CallAgentCommon

Vlastnosti

calls	Volat.
displayName	Získejte zobrazované jméno místního účastníka pro všechna nová volání.

Zděděné vlastnosti

connectionState	Získejte stav připojení.
kind	Získejte typ objektu agenta volání.

Metody

join(GroupCallLocator, JoinCallOptions)	Připojte se ke skupinovému hovoru. Pokud se chcete připojit ke skupinovému hovoru, předejte ID skupiny.
join(GroupChatCallLocator, JoinCallOptions)	Připojte se ke skupinovému chatu. Pokud se chcete připojit ke skupinovému hovoru chatu, předejte id vlákna.
join(MeetingLocator, JoinCallOptions)	Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte odkaz na schůzku nebo souřadnice schůzky.
join(RoomCallLocator, JoinCallOptions)	Připojte se k hovoru do místností. Pokud se chcete připojit k hovoru v místnosti, předejte id místnosti.
join(TeamsMeetingIdLocator, JoinCallOptions)	Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte ID schůzky a heslo.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte odkaz na schůzku.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Funkce odhlášení odběru pro událost callsUpdated
off("connectionStateChanged", ConnectionStateChangedEvent)	Funkce odhlášení odběru pro událost connectionStateChanged
off("incomingCall", IncomingCallEvent)	Funkce Odhlásit odběr události incomingCall
on("callsUpdated", CollectionUpdatedEvent<Call>)	Funkce Přihlásit se k odběru události callsUpdated
on("connectionStateChanged", ConnectionStateChangedEvent)	Funkce Subscribe pro událost connectionStateChanged
on("incomingCall", IncomingCallEvent)	Funkce Subscribe pro událost incomingCall
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Zahajte volání poskytnutým účastníkům.
startCall(CommunicationIdentifier[], StartCallOptions)	Zahajte volání poskytnutým účastníkům.

Zděděné metody

dispose()	Vyřazení tohoto agenta volání
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* U všech dostupných funkcí agenta rozšířeného volání v tomto balíčku.
handlePushNotification(IncomingCallPushNotificationData)	Zpracovává nabízené oznámení.

Podrobnosti vlastnosti

calls

Volat.

calls: readonly Call[]

Hodnota vlastnosti

readonly Call[]

displayName

Získejte zobrazované jméno místního účastníka pro všechna nová volání.

displayName?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

connectionState

Získejte stav připojení.

connectionState: ConnectionState

Hodnota vlastnosti

ConnectionState

zděděno zCallAgentCommon.connectionState

kind

Získejte typ objektu agenta volání.

kind: CallAgentKind

Hodnota vlastnosti

CallAgentKind

zděděno zCallAgentCommon.kind

Podrobnosti metody

join(GroupCallLocator, JoinCallOptions)

Připojte se ke skupinovému hovoru. Pokud se chcete připojit ke skupinovému hovoru, předejte ID skupiny.

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

Parametry

groupLocator

GroupCallLocator

Informace o skupinovém hovoru

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

join(GroupChatCallLocator, JoinCallOptions)

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Připojte se ke skupinovému chatu. Pokud se chcete připojit ke skupinovému hovoru chatu, předejte id vlákna.

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

Parametry

groupChatCallLocator

GroupChatCallLocator

Informace o hovorech groupchatu.

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

join(MeetingLocator, JoinCallOptions)

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte odkaz na schůzku nebo souřadnice schůzky.

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

Parametry

meetingLocator

MeetingLocator

Informace o schůzce

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

join(RoomCallLocator, JoinCallOptions)

Připojte se k hovoru do místností. Pokud se chcete připojit k hovoru v místnosti, předejte id místnosti.

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

Parametry

roomLocator

RoomCallLocator

Informace o volání do místnosti.

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

join(TeamsMeetingIdLocator, JoinCallOptions)

Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte ID schůzky a heslo.

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

Parametry

meetingLocator

TeamsMeetingIdLocator

Informace o schůzce

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Připojte se ke schůzce Teams. Pokud se chcete připojit ke schůzce Teams, předejte odkaz na schůzku.

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

Parametry

meetingLocator

TeamsMeetingLinkLocator

Informace o schůzce

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke volání.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Funkce odhlášení odběru pro událost callsUpdated

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<Call>

callback fn, který byl použit k přihlášení k odběru této události.

off("connectionStateChanged", ConnectionStateChangedEvent)

Funkce odhlášení odběru pro událost connectionStateChanged

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

Parametry

event

"connectionStateChanged"

název události.

listener

ConnectionStateChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

off("incomingCall", IncomingCallEvent)

Funkce Odhlásit odběr události incomingCall

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

Parametry

event

"incomingCall"

název události.

listener

IncomingCallEvent

callback fn, který byl použit k přihlášení k odběru této události.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Funkce Přihlásit se k odběru události callsUpdated

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<Call>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.

on("connectionStateChanged", ConnectionStateChangedEvent)

Funkce Subscribe pro událost connectionStateChanged

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

Parametry

event

"connectionStateChanged"

název události.

listener

ConnectionStateChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("incomingCall", IncomingCallEvent)

Funkce Subscribe pro událost incomingCall

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

Parametry

event

"incomingCall"

název události.

listener

IncomingCallEvent

callback fn, který bude volán, když tento callAgent přijme příchozí hovor.

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

Zahajte volání poskytnutým účastníkům.

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

Parametry

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke spuštěné volání.

startCall(CommunicationIdentifier[], StartCallOptions)

Zahajte volání poskytnutým účastníkům.

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

Parametry

participants

CommunicationIdentifier[]

options

StartCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Volání přidružený ke spuštěné volání.

Podrobnosti zděděných metod

dispose()

Vyřazení tohoto agenta volání

function dispose(): Promise<void>

Návraty

Promise<void>

zděděno zCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* U všech dostupných funkcí agenta rozšířeného volání v tomto balíčku.

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

Parametry

factory

CallAgentFeatureFactory<TFeature>

Továrna pro konstruktor funkcí agenta volání, který poskytuje rozšířené rozhraní API.

Návraty

TFeature

zděděno zCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Zpracovává nabízené oznámení.

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

Parametry

data

IncomingCallPushNotificationData

Nabízená data oznámení

Návraty

Promise<void>

zděděný zCallAgentCommon.handlePushNotification