TeamsCallAgent interface

Пакет:

@azure/communication-calling

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

Extends

CallAgentCommon

Свойства

calls

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

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

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

Методы

join(MeetingLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание или идентификатор собрания или координаты собрания.
join(TeamsMeetingIdLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте идентификатор собрания и секретный код.
join(TeamsMeetingLinkLocator, JoinCallOptions)	Присоединение к собранию Teams. Чтобы присоединиться к собранию Teams, передайте ссылку на собрание.
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Отмена подписки функции для события callsUpdated.
off("connectionStateChanged", ConnectionStateChangedEvent)	Отмена подписки функции для события connectionStateChanged.
off("incomingCall", TeamsIncomingCallEvent)	Отмена подписки для входящего событияCall.
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	Функция подписки для события callsUpdated.
on("connectionStateChanged", ConnectionStateChangedEvent)	Функция подписки для события connectionStateChanged.
on("incomingCall", TeamsIncomingCallEvent)	Функция подписки для входящего событияCall.
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	Запустите вызов 1:N.
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	Начните вызов 1:1.

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

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

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

calls

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

calls: readonly TeamsCall[]

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

readonly TeamsCall[]

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

connectionState

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

connectionState: ConnectionState

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

ConnectionState

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

kind

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

kind: CallAgentKind

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

CallAgentKind

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

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

join(MeetingLocator, JoinCallOptions)

Примечание

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

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

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

Параметры

meetingLocator

MeetingLocator

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

options

JoinCallOptions

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

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

TeamsCall

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

join(TeamsMeetingIdLocator, JoinCallOptions)

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

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

Параметры

meetingLocator

TeamsMeetingIdLocator

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

options

JoinCallOptions

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

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

TeamsCall

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

join(TeamsMeetingLinkLocator, JoinCallOptions)

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

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

Параметры

meetingLocator

TeamsMeetingLinkLocator

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

options

JoinCallOptions

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

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

TeamsCall

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

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Параметры

event

"callsUpdated"

имя события.

listener

CollectionUpdatedEvent<TeamsCall>

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

off("connectionStateChanged", ConnectionStateChangedEvent)

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

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

Параметры

event

"connectionStateChanged"

имя события.

listener

ConnectionStateChangedEvent

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

off("incomingCall", TeamsIncomingCallEvent)

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

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

Параметры

event

"incomingCall"

имя события.

listener

TeamsIncomingCallEvent

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

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

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

Параметры

event

"callsUpdated"

имя события.

listener

CollectionUpdatedEvent<TeamsCall>

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

on("connectionStateChanged", ConnectionStateChangedEvent)

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

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

Параметры

event

"connectionStateChanged"

имя события.

listener

ConnectionStateChangedEvent

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

on("incomingCall", TeamsIncomingCallEvent)

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

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

Параметры

event

"incomingCall"

имя события.

listener

TeamsIncomingCallEvent

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

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

Примечание

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

Запустите вызов 1:N.

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

Параметры

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

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

TeamsCall

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

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

Начните вызов 1:1.

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

Параметры

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

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

TeamsCall

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

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

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