CallAgent interface

Pakiet:

@azure/communication-calling

CallAgent służy do obsługi wywołań.

Rozszerzenie

CallAgentCommon

Właściwości

calls	Pobierz wywołania.
displayName	Pobierz nazwę wyświetlaną uczestnika lokalnego dla wszystkich nowych połączeń.

Właściwości dziedziczone

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

Metody

join(GroupCallLocator, JoinCallOptions)	Dołącz do połączenia grupowego. Aby dołączyć do wywołania grupy, przekaż identyfikator groupId.
join(GroupChatCallLocator, JoinCallOptions)	Dołącz do rozmowy grupowej. Aby dołączyć do połączenia czatu grupy, przekaż identyfikator threadId.
join(MeetingLocator, JoinCallOptions)	Dołącz do spotkania usługi Teams. Aby dołączyć do spotkania usługi Teams, przekaż link do spotkania lub współrzędne spotkania.
join(RoomCallLocator, JoinCallOptions)	Dołącz do połączenia z pokojem. Aby dołączyć do połączenia z pokojem, przekaż roomId.
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<Call>)	Anuluj subskrypcję funkcji dla wywołańAktualizuj zdarzenie.
off("connectionStateChanged", ConnectionStateChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Anuluj subskrypcję funkcji dla zdarzenia incomingCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Subskrybuj funkcję dla wywołańAktualizuj zdarzenie.
on("connectionStateChanged", ConnectionStateChangedEvent)	Funkcja subskrybuj dla zdarzenia connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Subskrybuj funkcję dla zdarzenia incomingCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Zainicjuj połączenie z podanymi uczestnikami.
startCall(CommunicationIdentifier[], StartCallOptions)	Zainicjuj połączenie z podanymi uczestnikami.

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

Wartość właściwości

readonly Call[]

displayName

Pobierz nazwę wyświetlaną uczestnika lokalnego dla wszystkich nowych połączeń.

displayName?: string

Wartość właściwości

string

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

Dołącz do połączenia grupowego. Aby dołączyć do wywołania grupy, przekaż identyfikator groupId.

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

Parametry

groupLocator

GroupCallLocator

Informacje o wywołaniu grupy.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

Obiekt Call skojarzony z wywołaniem.

join(GroupChatCallLocator, 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 rozmowy grupowej. Aby dołączyć do połączenia czatu grupy, przekaż identyfikator threadId.

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

Parametry

groupChatCallLocator

GroupChatCallLocator

Informacje o wywołaniu GroupChat.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

Obiekt Call skojarzony z wywołaniem.

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 współrzędne spotkania.

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

Parametry

meetingLocator

MeetingLocator

Informacje o spotkaniu.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

Obiekt Call skojarzony z wywołaniem.

join(RoomCallLocator, JoinCallOptions)

Dołącz do połączenia z pokojem. Aby dołączyć do połączenia z pokojem, przekaż roomId.

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

Parametry

roomLocator

RoomCallLocator

Informacje o rozmowie telefonicznej w pokoju.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

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

Parametry

meetingLocator

TeamsMeetingIdLocator

Informacje o spotkaniu.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

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

Parametry

meetingLocator

TeamsMeetingLinkLocator

Informacje o spotkaniu.

options

JoinCallOptions

Wywołaj opcje uruchamiania.

Zwraca

Call

Obiekt Call skojarzony z wywołaniem.

off("callsUpdated", CollectionUpdatedEvent<Call>)

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

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

Parametry

event

"callsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<Call>

fn wywołania zwrotnego, 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", IncomingCallEvent)

Anuluj subskrypcję funkcji dla zdarzenia incomingCall.

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

Parametry

event

"incomingCall"

nazwa zdarzenia.

listener

IncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<Call>)

Subskrybuj funkcję dla wywołańAktualizuj zdarzenie.

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

Parametry

event

"callsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<Call>

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

Subskrybuj funkcję dla zdarzenia incomingCall.

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

Parametry

event

"incomingCall"

nazwa zdarzenia.

listener

IncomingCallEvent

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

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

Zainicjuj połączenie z podanymi uczestnikami.

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

Parametry

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Opcje uruchamiania połączenia.

Zwraca

Call

Obiekt Wywołaj skojarzony z uruchomionym wywołaniem.

startCall(CommunicationIdentifier[], StartCallOptions)

Zainicjuj połączenie z podanymi uczestnikami.

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

Parametry

participants

CommunicationIdentifier[]

options

StartCallOptions

Opcje uruchamiania połączenia.

Zwraca

Call

Obiekt Wywołaj skojarzony z uruchomionym 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