TeamsCallAgent interface

Balíček:

@azure/communication-calling

TeamsCallAgent se používá ke zpracování volání v Teams.

Extends

CallAgentCommon

Vlastnosti

calls

Získejte hovory.

Zděděné vlastnosti

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

Metody

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, ID schůzky nebo souřadnice schůzky.
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<TeamsCall>)	Funkce Odhlášení odběru pro voláníAktualizované události
off("connectionStateChanged", ConnectionStateChangedEvent)	Funkce odhlášení pro událost connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Funkce Unsubscribe pro událost incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	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", TeamsIncomingCallEvent)	Funkce Subscribe pro událost incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Zahájit hovor 1:N.
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Zahájit hovor 1:1.

Zděděné metody

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

Podrobnosti vlastnosti

calls

Získejte hovory.

calls: ReadonlyArray<TeamsCall>

Hodnota vlastnosti

ReadonlyArray<TeamsCall>

Podrobnosti zděděných vlastností

connectionState

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

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(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, ID schůzky nebo souřadnice schůzky.

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

Parametry

meetingLocator

MeetingLocator

Informace o schůzce.

options

JoinCallOptions

Možnosti zahájení hovoru v Teams

Návraty

TeamsCall

Objekt TeamsCall přidružený k 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): TeamsCall

Parametry

meetingLocator

TeamsMeetingIdLocator

Informace o schůzce.

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

TeamsCall

Objekt Call přidružený k 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): TeamsCall

Parametry

meetingLocator

TeamsMeetingLinkLocator

Informace o schůzce.

options

JoinCallOptions

Možnosti zahájení hovoru.

Návraty

TeamsCall

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

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<TeamsCall>

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

off("connectionStateChanged", ConnectionStateChangedEvent)

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

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

Funkce Unsubscribe pro událost incomingCall.

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

Parametry

event

"incomingCall"

název události.

listener

TeamsIncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Parametry

event

"callsUpdated"

název události.

listener

CollectionUpdatedEvent<TeamsCall>

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)

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

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

Funkce Subscribe pro událost incomingCall.

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

Parametry

event

"incomingCall"

název události.

listener

TeamsIncomingCallEvent

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

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

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

Zahájit hovor 1:N.

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

Parametry

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Návraty

TeamsCall

Objekt TeamsCall přidružený k volání.

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

Zahájit hovor 1:1.

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

Parametry

participant

MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Návraty

TeamsCall

Objekt TeamsCall přidružený k 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 Feature s rozšířeným rozhraním API. Zkontrolujte funkce objektu.* Projděte si všechny dostupné funkce rozšířeného agenta volání v tomto balíčku.

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(PushNotificationData)

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: PushNotificationData): Promise<void>

Parametry

data

PushNotificationData

Data nabízených oznámení

Návraty

Promise<void>

Zděděno zCallAgentCommon.handlePushNotification