TeamsCallAgent interface

Pakiet:

@azure/communication-calling

Aplikacja TeamsCallAgent służy do obsługi wywołań usługi Teams.

Rozszerzenie

CallAgentCommon

Właściwości

calls

Pobierz wywołania.

Właściwości dziedziczone

connectionState	Pobierz stan połączenia.
kind	Pobierz obiekt agenta wywołania.

Metody

join(MeetingLocator, JoinCallOptions)	Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż link do spotkania lub identyfikator spotkania lub współrzędne spotkania.
join(TeamsMeetingIdLocator, JoinCallOptions)	Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż identyfikator spotkania i kod dostępu.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż link do spotkania.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Anuluj subskrypcję funkcji dla wywołańAktualizuj zdarzenie.
off("connectionStateChanged", ConnectionStateChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Anuluj subskrypcję funkcji dla zdarzenia incomingCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Subskrybuj funkcję dla wywołańAktualizuj zdarzenie.
on("connectionStateChanged", ConnectionStateChangedEvent)	Funkcja subskrybuj dla zdarzenia connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Subskrybuj funkcję dla zdarzenia incomingCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Rozpocznij połączenie 1:N.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Uruchom połączenie 1:1.

Metody dziedziczone

dispose()	Usuwanie tego agenta wywołań
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Pobiera zainicjowany i zapamiętany obiekt funkcji z rozszerzonym interfejsem API. Sprawdź funkcje obiektu.* dla wszystkich dostępnych funkcji agenta połączeń rozszerzonych w tym pakiecie.
handlePushNotification(IncomingCallPushNotificationData)	Obsługuje powiadomienie wypychane.

Szczegóły właściwości

calls

Pobierz wywołania.

calls: readonly TeamsCall[]

Wartość właściwości

readonly TeamsCall[]

Szczegóły właściwości dziedziczonej

connectionState

Pobierz stan połączenia.

connectionState: ConnectionState

Wartość właściwości

ConnectionState

dziedziczone zCallAgentCommon.connectionState

kind

Pobierz obiekt agenta wywołania.

kind: CallAgentKind

Wartość właściwości

CallAgentKind

dziedziczone zCallAgentCommon.kind

Szczegóły metody

join(MeetingLocator, JoinCallOptions)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż link do spotkania lub identyfikator spotkania lub współrzędne spotkania.

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

Parametry

meetingLocator

MeetingLocator

Informacje o spotkaniu.

options

JoinCallOptions

Opcje uruchamiania wywołania aplikacji Teams.

Zwraca

TeamsCall

Obiekt TeamsCall skojarzony z wywołaniem.

join(TeamsMeetingIdLocator, JoinCallOptions)

Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż identyfikator spotkania i kod dostępu.

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

Parametry

meetingLocator

TeamsMeetingIdLocator

Informacje o spotkaniu.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

TeamsCall

Obiekt Call skojarzony z wywołaniem.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż link do spotkania.

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

Parametry

meetingLocator

TeamsMeetingLinkLocator

Informacje o spotkaniu.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

TeamsCall

Obiekt Call skojarzony z wywołaniem.

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Anuluj subskrypcję funkcji dla wywołańAktualizuj zdarzenie.

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

Parametry

event

"callsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<TeamsCall>

allback fn, który został użyty do subskrybowania tego zdarzenia.

off("connectionStateChanged", ConnectionStateChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia connectionStateChanged.

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

Parametry

event

"connectionStateChanged"

nazwa zdarzenia.

listener

ConnectionStateChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

off("incomingCall", TeamsIncomingCallEvent)

Anuluj subskrypcję funkcji dla zdarzenia incomingCall.

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

Parametry

event

"incomingCall"

nazwa zdarzenia.

listener

TeamsIncomingCallEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

Subskrybuj funkcję dla wywołańAktualizuj zdarzenie.

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

Parametry

event

"callsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<TeamsCall>

wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.

on("connectionStateChanged", ConnectionStateChangedEvent)

Funkcja subskrybuj dla zdarzenia connectionStateChanged.

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

Parametry

event

"connectionStateChanged"

nazwa zdarzenia.

listener

ConnectionStateChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

on("incomingCall", TeamsIncomingCallEvent)

Subskrybuj funkcję dla zdarzenia incomingCall.

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

Parametry

event

"incomingCall"

nazwa zdarzenia.

listener

TeamsIncomingCallEvent

fn wywołania zwrotnego, które będą wywoływane, gdy to wywołanie Agent otrzyma połączenie przychodzące.

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

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Rozpocznij połączenie 1:N.

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

Parametry

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

Zwraca

TeamsCall

Obiekt TeamsCall skojarzony z wywołaniem.

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

Uruchom połączenie 1:1.

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

Parametry

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

Zwraca

TeamsCall

Obiekt TeamsCall skojarzony z wywołaniem.

Szczegóły metody dziedziczonej

dispose()

Usuwanie tego agenta wywołań

function dispose(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Pobiera zainicjowany i zapamiętany obiekt funkcji z rozszerzonym interfejsem API. Sprawdź funkcje obiektu.* dla wszystkich dostępnych funkcji agenta połączeń rozszerzonych w tym pakiecie.

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

Parametry

factory

CallAgentFeatureFactory<TFeature>

Fabryka konstruktora funkcji agenta wywołań, który udostępnia rozszerzony interfejs API.

Zwraca

TFeature

dziedziczone zCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Obsługuje powiadomienie wypychane.

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

Parametry

data

IncomingCallPushNotificationData

Dane powiadomień wypychanych

Zwraca

Promise<void>

dziedziczone zCallAgentCommon.handlePushNotification