CallAgent interface

Пакет:

@azure/communication-calling

CallAgent используется для обработки вызовов.

Extends

CallAgentCommon

Свойства

calls	Получение вызовов.
displayName	Получите отображаемое имя локального участника для всех новых вызовов.

Унаследованные свойства

connectionState	Получите состояние подключения.
kind	Получите тип объекта агента вызова.

Методы

join(GroupCallLocator, JoinCallOptions)	Присоединение к групповому вызову. Чтобы присоединиться к групповому вызову, передайте идентификатор groupId.
join(GroupChatCallLocator, JoinCallOptions)	Присоединяйтесь к вызову группового чата. Чтобы присоединиться к групповому вызову чата, передайте threadId.
join(MeetingLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание или координаты собрания.
join(RoomCallLocator, JoinCallOptions)	Присоединение к звонку по комнатам. Чтобы присоединиться к телефону, передайте идентификатор roomId.
join(TeamsMeetingIdLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте идентификатор собрания и секретный код.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание.
off("callsUpdated", CollectionUpdatedEvent<Call>)	Отмена подписки функции для события callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Отмена подписки функции для события connectionStateChanged.
off("incomingCall", IncomingCallEvent)	Отмена подписки для входящего событияCall.
on("callsUpdated", CollectionUpdatedEvent<Call>)	Функция подписки для события callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Функция подписки для события connectionStateChanged.
on("incomingCall", IncomingCallEvent)	Функция подписки для входящего событияCall.
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Инициируйте вызов участникам, предоставленным.
startCall(CommunicationIdentifier[], StartCallOptions)	Инициируйте вызов участникам, предоставленным.

Наследуемые методы

dispose()	Удаление этого агента вызова
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций агента вызова в этом пакете.
handlePushNotification(IncomingCallPushNotificationData)	Обрабатывает push-уведомление.

Сведения о свойстве

calls

Получение вызовов.

calls: readonly Call[]

Значение свойства

readonly Call[]

displayName

Получите отображаемое имя локального участника для всех новых вызовов.

displayName?: string

Значение свойства

string

Сведения об унаследованном свойстве

connectionState

Получите состояние подключения.

connectionState: ConnectionState

Значение свойства

ConnectionState

наследуется отCallAgentCommon.connectionState

kind

Получите тип объекта агента вызова.

kind: CallAgentKind

Значение свойства

CallAgentKind

наследуется отCallAgentCommon.kind

Сведения о методе

join(GroupCallLocator, JoinCallOptions)

Присоединение к групповому вызову. Чтобы присоединиться к групповому вызову, передайте идентификатор groupId.

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

Параметры

groupLocator

GroupCallLocator

Сведения о групповом вызове.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

join(GroupChatCallLocator, JoinCallOptions)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Присоединяйтесь к вызову группового чата. Чтобы присоединиться к групповому вызову чата, передайте threadId.

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

Параметры

groupChatCallLocator

GroupChatCallLocator

Сведения о вызове GroupChat.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

join(MeetingLocator, JoinCallOptions)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание или координаты собрания.

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

Параметры

meetingLocator

MeetingLocator

Сведения о собрании.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

join(RoomCallLocator, JoinCallOptions)

Присоединение к звонку по комнатам. Чтобы присоединиться к телефону, передайте идентификатор roomId.

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

Параметры

roomLocator

RoomCallLocator

Сведения о телефонном звонке.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

join(TeamsMeetingIdLocator, JoinCallOptions)

Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте идентификатор собрания и секретный код.

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

Параметры

meetingLocator

TeamsMeetingIdLocator

Сведения о собрании.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

join(TeamsMeetingLinkLocator, JoinCallOptions)

Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание.

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

Параметры

meetingLocator

TeamsMeetingLinkLocator

Сведения о собрании.

options

JoinCallOptions

Параметры запуска вызова.

Возвращаемое значение

Call

Объект Call, связанный с вызовом.

off("callsUpdated", CollectionUpdatedEvent<Call>)

Отмена подписки функции для события callsUpdated.

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

Параметры

event

"callsUpdated"

имя события.

listener

CollectionUpdatedEvent<Call>

обратный вызов fn, который использовался для подписки на это событие.

off("connectionStateChanged", ConnectionStateChangedEvent)

Отмена подписки функции для события connectionStateChanged.

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

Параметры

event

"connectionStateChanged"

имя события.

listener

ConnectionStateChangedEvent

обратный вызов fn, который будет вызываться при изменении значения этого свойства.

off("incomingCall", IncomingCallEvent)

Отмена подписки для входящего событияCall.

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

Параметры

event

"incomingCall"

имя события.

listener

IncomingCallEvent

обратный вызов fn, который использовался для подписки на это событие.

on("callsUpdated", CollectionUpdatedEvent<Call>)

Функция подписки для события callsUpdated.

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

Параметры

event

"callsUpdated"

имя события.

listener

CollectionUpdatedEvent<Call>

обратный вызов fn, который будет вызываться при изменении этой коллекции, он будет передавать массивы добавленных и удаленных элементов.

on("connectionStateChanged", ConnectionStateChangedEvent)

Функция подписки для события connectionStateChanged.

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

Параметры

event

"connectionStateChanged"

имя события.

listener

ConnectionStateChangedEvent

обратный вызов fn, который будет вызываться при изменении значения этого свойства.

on("incomingCall", IncomingCallEvent)

Функция подписки для входящего событияCall.

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

Параметры

event

"incomingCall"

имя события.

listener

IncomingCallEvent

Обратный вызов fn, который будет вызываться, когда этот callAgent получит входящий вызов.

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

Инициируйте вызов участникам, предоставленным.

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

Параметры

participants

(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartCallOptions

Запуск параметров вызова.

Возвращаемое значение

Call

Объект Call, связанный с запущенным вызовом.

startCall(CommunicationIdentifier[], StartCallOptions)

Инициируйте вызов участникам, предоставленным.

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

Параметры

participants

CommunicationIdentifier[]

options

StartCallOptions

Запуск параметров вызова.

Возвращаемое значение

Call

Объект Call, связанный с запущенным вызовом.

Сведения о наследуемом методе

dispose()

Удаление этого агента вызова

function dispose(): Promise<void>

Возвращаемое значение

Promise<void>

наследуется отCallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Извлекает инициализированный и memoized feature object with extended API. Проверьте объект Features.* для всех доступных расширенных функций агента вызова в этом пакете.

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

Параметры

factory

CallAgentFeatureFactory<TFeature>

Фабрика для конструктора функций агента вызова, предоставляющего расширенный API.

Возвращаемое значение

TFeature

унаследовано отCallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Обрабатывает push-уведомление.

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

Параметры

data

IncomingCallPushNotificationData

Данные push-уведомлений

Возвращаемое значение

Promise<void>

унаследовано отCallAgentCommon.handlePushNotification