CallAgent interface

Balíček:

@azure/communication-calling

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

Extends

CallAgentCommon

Vlastnosti

calls	Získejte hovory.
displayName	Získejte zobrazované jméno místního účastníka pro všechny nové hovory.

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 groupId.
join(GroupChatCallLocator, JoinCallOptions)	Připojte se ke skupinovému chatu. Pokud se chcete připojit ke skupinovému chatu, předejte threadId.
join(MeetingLocator, JoinCallOptions)	Připojte se ke schůzce v 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 v místnosti. Pokud se chcete připojit k volání do místnosti, předejte roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Připojte se ke schůzce v 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 v 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 voláníAktualizované události
off("connectionStateChanged", ConnectionStateChangedEvent)	Funkce odhlášení pro událost connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Funkce Unsubscribe pro událost incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Přihlásit se k odběru funkce pro voláníAktualizované události.
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í účastníkům.
startCall(CommunicationIdentifier[], StartCallOptions)	Zahajte volání účastníkům.

Zděděné metody

dispose()	Odstranění tohoto agenta volání
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Načte inicializovaný a zapamatovaný objekt Funkce s rozšířeným rozhraním API. Všechny dostupné funkce rozšířeného agenta volání v tomto balíčku najdete v objektu Funkce.* .
handlePushNotification(IncomingCallPushNotificationData)	Zpracovává nabízené oznámení.

Podrobnosti vlastnosti

calls

Získejte hovory.

calls: readonly Call[]

Hodnota vlastnosti

readonly Call[]

displayName

Získejte zobrazované jméno místního účastníka pro všechny nové hovory.

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

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 Call přidružený k 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 chatu, předejte threadId.

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

Parametry

groupChatCallLocator

GroupChatCallLocator

Informace o hovoru GroupChat.

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

Call

Objekt Call přidružený k 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 v 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 Call přidružený k volání.

join(RoomCallLocator, JoinCallOptions)

Připojte se k hovoru v místnosti. Pokud se chcete připojit k volání do místnosti, předejte roomId.

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 Call přidružený k volání.

join(TeamsMeetingIdLocator, JoinCallOptions)

Připojte se ke schůzce v 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 Call přidružený k volání.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Připojte se ke schůzce v 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 Call přidružený k volání.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Funkce Odhlášení odběru pro voláníAktualizované události

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<Call>

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

off("connectionStateChanged", ConnectionStateChangedEvent)

Funkce odhlášení pro událost connectionStateChanged.

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

Parametry

event

"connectionStateChanged"

název události.

listener

ConnectionStateChangedEvent

zpětné volání fn, která bude volána, když se změní hodnota této vlastnosti.

off("incomingCall", IncomingCallEvent)

Funkce Unsubscribe pro událost incomingCall.

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

Parametry

event

"incomingCall"

název události.

listener

IncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<Call>)

Přihlásit se k odběru funkce pro voláníAktualizované události.

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<Call>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.

on("connectionStateChanged", ConnectionStateChangedEvent)

Funkce Subscribe pro událost connectionStateChanged

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

Parametry

event

"connectionStateChanged"

název události.

listener

ConnectionStateChangedEvent

zpětné volání fn, která bude volána, když se změní hodnota 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

zpětné volání fn, která bude volána, když tento agent callAgent přijme příchozí hovor.

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

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

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

Parametry

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Zahájit možnosti volání.

Návraty

Call

Objekt Call přidružený k zahájené volání.

startCall(CommunicationIdentifier[], StartCallOptions)

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

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

Parametry

participants

CommunicationIdentifier[]

options

StartCallOptions

Zahájit možnosti volání.

Návraty

Call

Objekt Call přidružený k zahájené volání.

Podrobnosti zděděných metod

dispose()

Odstranění 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 zapamatovaný objekt Funkce s rozšířeným rozhraním API. Všechny dostupné funkce rozšířeného agenta volání v tomto balíčku najdete v objektu Funkce.* .

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

Parametry

factory

CallAgentFeatureFactory<TFeature>

Továrna pro konstruktor funkce 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

Data nabízených oznámení

Návraty

Promise<void>

Zděděno zCallAgentCommon.handlePushNotification