Поделиться через

@azure/communication-react package

  • Ссылка

Классы

CallError

Ошибка, возникаемая из-за неудачных методов API с отслеживанием состояния.
ChatError

Ошибка, возникаемая из-за неудачных методов StatefulChatClient .

Интерфейсы

ActiveErrorMessage

Активные сообщения об ошибках, отображаемые через панель ошибок.
AdapterError

Ошибка, сообщаемая через события ошибок и сохраненная в состоянии адаптера.
AdapterState

Функциональные возможности для взаимодействия с состоянием составного адаптера.
BaseCompositeProps

Свойства, общие для всех составных элементов, экспортированных из этой библиотеки.
BaseCustomStyles

Базовые текучие стили реквизиты для всех компонентов, экспортированных из этого libray.
CallAdapter

Интерфейс адаптера, предназначенный для удостоверения связи Azure, который расширяет CommonCallAdapter.
CallAdapterCallManagement

Функции для управления текущим вызовом или запуска нового вызова
CallAdapterCallOperations

Функциональные возможности для управления текущим вызовом.
CallAdapterDeviceManagement

Функциональные возможности для управления устройствами в вызове.
CallAdapterSubscribers

Вызов составных событий, на которые можно подписаться.
CallAgentProviderProps

Аргументы для инициализации CallAgentProvider.
CallAgentState

Версия только для состояния, за исключением вызовов <xref:%40azure%2Fcommunication-calling%23CallAgent> , перемещена в дочерний объект CallClientState и не включена в этот список. Причина для того, чтобы состояние CallAgent было прокси-сервером, заключается в предоставлении доступа к displayName. Мы не удаляем callAgent.displayName и не помещаем его в CallClientState, так как было бы неоднозначно, что displayName фактически зависит от создания и существования CallAgent, чтобы быть доступным.
CallAndChatLocator

Аргументы для использования в createAzureCommunicationCallWithChatAdapter для присоединения звонка к связанному потоку чата.
CallClientProviderProps

Аргументы для инициализации CallClientProvider.
CallClientState

Контейнер для всех данных состояния, передаваемых через StatefulCallClient. Состояния calls, callsEnded, incomingCalls и incomingCallsEnded будут автоматически предоставлены при создании callAgent. DeviceManager будет изначально пустым, пока не будет заполнен раздел DeviceManagerState. Состояние userId предоставляется для удобства разработчика и полностью контролируется и настраивается разработчиком.
CallCompositeProps

Реквизит для CallComposite.
CallCompositeStrings

Строки, используемые callComposite напрямую.

Эти строки являются дополнением к строкам, используемым компонентами из библиотеки компонентов.
CallProviderProps

Аргументы для инициализации CallProvider.
CallState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient автоматически получит состояние Call и добавит его в состояние, предоставляемое StatefulCallClient.
CallWithChatAdapter

CallWithChatComposite Интерфейс адаптера.
CallWithChatAdapterManagement

Функции для управления текущим вызовом с помощью чата.
CallWithChatAdapterState

Состояние CallWithChat — это сочетание клиентов чата с отслеживанием состояния и вызовов с отслеживанием состояния с определенным состоянием, характерным только для CallWithChat Composite.
CallWithChatAdapterSubscriptions

События вызова и чата, на которые можно подписаться в CallWithChatAdapter.
CallWithChatAdapterUiState

Состояние пользовательского интерфейса, относящегося к CallWithChatComposite.
CallWithChatClientState

Состояние серверных служб, которые управляет CallWithChatComposite.
CallWithChatCompositeProps

Реквизиты, необходимые для CallWithChatComposite
CallWithChatCompositeStrings

Строки, используемые callWithChatComposite напрямую.

Эти строки являются дополнением к строкам, используемым компонентами из библиотеки компонентов.
CallWithChatControlOptions

CallWithChatComposite Элементы управления вызовами для отображения или скрытия кнопок на панели управления вызовами.
CallingHandlers

Объект , содержащий все обработчики, необходимые для вызова компонентов.

Вызов связанных компонентов из этого пакета может выбрать соответствующие обработчики из этого объекта. См. <xref:useHandlers> и usePropsFor.
CallingTheme

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

Стили для меню CameraButton .
CameraButtonProps

Реквизит для компонента CameraButton .
CameraButtonStrings

Строки CameraButton, которые можно переопределить.
CameraButtonStyles

Стили для CameraButton
ChatAdapterSubscribers

Составные события чата, на которые можно подписаться.
ChatAdapterThreadManagement

Функциональные возможности для управления текущим потоком чата.
ChatCompositeProps

Реквизиты для ChatComposite.
ChatCompositeStrings

Строки, используемые chatComposite напрямую.

Эти строки являются дополнением к строкам, используемым компонентами из библиотеки компонентов.
ChatMessage

Сообщение чата.
CommonCallAdapter

CallComposite Интерфейс адаптера.
CommonCallingHandlers

Объект , содержащий все обработчики, необходимые для вызова компонентов.

Вызов связанных компонентов из этого пакета может выбрать соответствующие обработчики из этого объекта. См. <xref:useHandlers> и usePropsFor.
ComponentLocale

Сведения о языковом стандарте для всех компонентов, экспортированных из этой библиотеки.
ComponentStrings

Строки, используемые всеми компонентами, экспортируемыми из этой библиотеки.
CompositeLocale

Сведения о языковом стандарте для всех составных элементов, экспортированных из этой библиотеки.
CompositeStrings

Строки, используемые непосредственно в составных компонентах.

Эти строки используются непосредственно составными компонентами, а не содержащимися компонентами.
ContentSystemMessage

Системное сообщение с содержимым для арбитров.
ControlBarButtonProps

Реквизиты для ControlBarButton.
ControlBarButtonStrings

Строки controlBarButton , которые можно переопределить.
ControlBarProps

Реквизиты для ControlBar.
CreateVideoStreamViewResult

Объект возвращается после создания локального или удаленного VideoStream. Содержит вспомогательные функции для управления отрисовками потока.
CustomMessage

Пользовательский тип сообщения.

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

Стили для меню DevicesButton .
DevicesButtonProps

Реквизит для DevicesButton.
DevicesButtonStrings

Строки элемента DevicesButton , которые можно переопределить.
DevicesButtonStyles

Стили для пунктов меню кнопки Устройства.
DiagnosticsCallFeatureState

Только прокси-сервер состояния для <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable

Функции для правильного удаления составного элемента.
EndCallButtonProps

Реквизит для EndCallButton.
EndCallButtonStrings

Строки EndCallButton , которые можно переопределить.
ErrorBarProps

Свойства для элемента ErrorBar.

В дополнение к следующему, ErrorBar перенаправит все <xref:%40fluentui%2Freact%23IMessageBarProps> в базовый <xref:%40fluentui%2Freact%23MessageBar>.
ErrorBarStrings

Все строки, которые могут отображаться в пользовательском интерфейсе на панели ошибок.
FluentThemeProviderProps

Реквизит для FluentThemeProvider.
GridLayoutProps

Реквизиты для GridLayout.
GridLayoutStyles

GridLayout Стили компонентов.
HorizontalGalleryStyles

<xref:HorizontalGallery> Стили компонентов.
IncomingCallState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient автоматически обнаружит входящие вызовы и добавит их состояние в состояние, предоставляемое StatefulCallClient.
JumpToNewMessageButtonProps

Аргументы для <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState

Только прокси-сервер состояния для <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon

Общие свойства всех типов сообщений.
MessageStatusIndicatorProps

Свойства для MessageStatusIndicator.
MessageStatusIndicatorStrings

Строки MessageStatusIndicator , которые можно переопределить.
MessageThreadStrings

Строки MessageThread , которые можно переопределить.
MessageThreadStyles

Стили Fluent для MessageThread.
MicrophoneButtonContextualMenuStyles

Стили для меню MicrophoneButton .
MicrophoneButtonProps

Реквизит для MicrophoneButton.
MicrophoneButtonStrings

Строки элемента MicrophoneButton , которые можно переопределить.
MicrophoneButtonStyles

Стили для MicrophoneButton
NetworkDiagnosticsState

Только прокси-сервер состояния для <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice

Устройство, например камера, микрофон или динамик, во всплывающем элементе DevicesButton .
ParticipantAddedSystemMessage

Системное сообщение, уведомляющее о добавлении участника в поток чата.
ParticipantItemProps

Реквизиты для Элемента участника.
ParticipantItemStrings

Строки Объекта Участника , которые можно переопределить.
ParticipantItemStyles

Стили Fluent для Элемента Участника.
ParticipantListItemStyles

Стили для элемента УчастникаList.
ParticipantListStyles

Стили для списка участников.
ParticipantRemovedSystemMessage

Системное сообщение, уведомляющее о том, что участник был удален из потока чата.
ParticipantsButtonContextualMenuStyles

Стили для меню ParticipantsButton .
ParticipantsButtonProps

Реквизит для элемента ParticipantsButton.
ParticipantsButtonStrings

Строки элемента ParticipantsButton , которые можно переопределить.
ParticipantsButtonStyles

Свойства стилей для элемента ParticipantsButton.
RecordingCallFeature

Версия только состояния <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient будет автоматически прослушивать состояние записи вызова и соответствующим образом обновлять состояние, предоставляемое StatefulCallClient .
RemoteParticipantState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient автоматически извлекает RemoteParticipants и добавляет их состояние в состояние, предоставляемое StatefulCallClient.
RemoteVideoStreamState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps

Реквизит для ScreenShareButton.
ScreenShareButtonStrings

Строки ScreenShareButton , которые можно переопределить.
SendBoxProps

Реквизиты для SendBox.
SendBoxStrings

Строки SendBox , которые можно переопределить.
SendBoxStylesProps

Стили Fluent для <xref:Sendbox>.
StatefulCallClient

Определяет методы, позволяющие использовать CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> с отслеживанием состояния. Интерфейс предоставляет доступ к прокси-состоянию, а также позволяет зарегистрировать обработчик для событий изменения состояния. Определение состояния см. в разделе CallClientState.

События изменения состояния управляются следующими:

  • Возвращаемые данные из <xref:%40azure%2Fcommunication-calling%23DeviceManager> API.
  • Возвращаемые данные из <xref:%40azure%2Fcommunication-calling%23CallAgent> API.
  • Прослушиватели автоматически подключаются к различным объектам azure communication-calling:
    • CallAgent "incomingCall"
    • CallAgent "callsUpdated"
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Вызов stateChanged
    • Вызов "idChanged"
    • Вызов isMutedChanged
    • Вызов isScreenSharingOnChanged
    • Вызов remoteParticipantsUpdated
    • Вызов localVideoStreamsUpdated
    • IncomingCall 'callEnded'
    • RemoteParticipant "stateChanged"
    • RemoteParticipant "isMutedChanged"
    • RemoteParticipant "displayNameChanged"
    • RemoteParticipant isSpeakingChanged
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

Определяет методы, позволяющие использовать {@Link @azure/communication-chat#ChatClient} с централизованным созданным состоянием.

Интерфейс предоставляет доступ к прокси-состоянию, а также позволяет зарегистрировать обработчик для событий изменения состояния.
StatefulDeviceManager

Определяет дополнительные методы, добавленные с отслеживанием состояния поверх <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps

Свойства для StreamMedia.
SystemMessageCommon

Общие свойства всех системных сообщений.
TopicUpdatedSystemMessage

Системное сообщение, уведомляющее о том, что раздел потока чата был обновлен.
TranscriptionCallFeature

Версия только состояния <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient будет автоматически прослушивать состояние транскрибирования вызова и соответствующим образом обновлять состояние, предоставляемое StatefulCallClient .
TypingIndicatorProps

Реквизиты для TypeingIndicator.
TypingIndicatorStrings

Строки TypeingIndicator , которые можно переопределить.
TypingIndicatorStylesProps

Стили Fluent для TypeingIndicator.
VideoGalleryProps

Реквизит для VideoGallery.
VideoGalleryRemoteParticipant

Состояние удаленного участника в VideoGallery.
VideoGalleryStream

Видеопоток участника в VideoGallery.
VideoGalleryStrings

Все строки, которые могут отображаться в пользовательском интерфейсе в VideoGallery.
VideoGalleryStyles

ВидеоГалерея Стили компонентов.
VideoStreamOptions

Параметры для управления отображением видеопотоков.
VideoStreamRendererViewState

Версия только состояния <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Это свойство добавляется в состояние, предоставляемое StatefulCallClientпутем createView и удаляется с помощью disposeView.
VideoTileProps

Реквизит для VideoTile.
VideoTileStylesProps

Стили Fluent для VideoTile.

Псевдонимы типа

AdapterErrors

Адаптеры сохраняют последнюю ошибку для каждой операции в состоянии .

target — это строка, определяемая адаптером для каждой уникальной операции, выполняемой адаптером.
AreEqual

Сравните, если 2 компонента react точно равны, тип результата будет иметь значение true или false
AreParamEqual

Сравните, если свойства двух компонентов react равны, тип результата будет иметь значение true/false
AreTypeEqual

Сравнение, если два типа равны, тип результата будет иметь значение true/false
AvatarPersonaData

Настраиваемые атрибуты данных для отображения аватара пользователя.
AvatarPersonaDataCallback

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

Аргументы для создания Службы коммуникации Azure реализации CallAdapter.

Примечание. displayName Может содержать не более 256 символов.
AzureCommunicationCallWithChatAdapterArgs

Аргументы для createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs

Аргументы для <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs

Аргументы для создания Службы коммуникации Azure реализации ChatAdapter.
CallAdapterCallEndedEvent

Полезные данные для CallEndedListener , содержащие сведения о завершенном вызове.
CallAdapterClientState

Состояние CommonCallAdapter выводится из Службы коммуникации Azure серверной части.
CallAdapterLocator

Указатель, используемый createAzureCommunicationCallAdapter для поиска вызова для присоединения
CallAdapterState

Состояние CommonCallAdapter .
CallAdapterUiState

Состояние CommonCallAdapter для чистого пользовательского интерфейса.
CallCompositeIcons

Значки, которые можно переопределить для CallComposite.
CallCompositeOptions

Необязательные функции CallComposite.
CallCompositePage

Основные экраны пользовательского интерфейса, отображаемые в CallComposite.
CallControlDisplayType

Тип отображения панели управления для CallComposite.
CallControlOptions

Параметры настройки панели управления в интерфейсе звонков.
CallEndedListener

Обратный вызов для события CallAdapterSubscribers "callEnded".
CallErrorBarSelector

Тип селектора для компонента ErrorBar .
CallErrorTarget

Тип строкового литерала для всех допустимых ключей в {@Link CallErrors}.
CallErrors

Ошибки, связанные с вызовами API в пакет SDK для вызовов.

Каждое свойство в объекте хранит последнюю ошибку для определенного метода API ПАКЕТА SDK.

Ошибки из этого объекта можно удалить с помощью <xref:newClearCallErrorsModifier>. Кроме того, ошибки автоматически удаляются, когда:

  • Состояние очищено.
  • Последующие вызовы связанных методов API будут успешными. Дополнительные сведения о том, когда ошибки могут быть автоматически очищены, см. в документации по отдельным клиентским методам с отслеживанием состояния.
CallIdChangedListener

Обратный вызов для события CallAdapterSubscribers "callIdChanged".
CallParticipantListParticipant

Состояние вызова участника, отраженное в компонентах пользовательского интерфейса.
CallWithChatCompositeIcons

Значки, которые можно переопределить для CallWithChatComposite.
CallWithChatCompositeOptions

Необязательные функции CallWithChatComposite.
CallWithChatEvent

События, вызванные CallWithChatAdapter.
CallingBaseSelectorProps

Общие реквизиты, используемые для ссылки на декларативное состояние клиента.
CallingReturnProps

Вспомогательный тип для usePropsFor.
CameraButtonSelector

Тип селектора для компонента CameraButton .
ChatAdapter

ChatComposite Интерфейс адаптера.
ChatAdapterState

Состояние ChatAdapter.
ChatAdapterUiState

Состояние ChatAdapter для чистого пользовательского интерфейса.
ChatBaseSelectorProps

Общие свойства для селекторов для ChatClientState.
ChatClientProviderProps

Аргументы для инициализации ChatClientProvider.
ChatClientState

Централизованное состояние для <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState

Состояние ChatAdapter, выведенное из Службы коммуникации Azure серверной части.
ChatCompositeIcons

Значки, которые можно переопределить для ChatComposite.
ChatCompositeOptions

Необязательные функции ChatComposite.
ChatErrorBarSelector

Тип селектора для компонента ErrorBar .
ChatErrorTarget

Тип строкового литерала для всех допустимых ключей в ChatErrors.
ChatErrors

Ошибки, связанные с вызовами API к пакету SDK для чата.

Каждое свойство в объекте хранит последнюю ошибку для определенного метода API ПАКЕТА SDK.
ChatHandlers

Объект , содержащий все обработчики, необходимые для компонентов чата.

Компоненты, связанные с чатом, из этого пакета могут выбирать соответствующие обработчики из этого объекта. См. <xref:useHandlers> и usePropsFor.
ChatMessageWithStatus

Расширение для , в котором хранятся <xref:%40azure%2Fcommunication-chat%23ChatMessage> только метаданные на стороне клиента для сообщений чата.

TODO: имя bitrotted. Переименуйте меня.
ChatParticipantListSelector

Тип селектора для компонента ParticipantList .
ChatReturnProps

Вспомогательный тип для usePropsFor.
ChatThreadClientProviderProps

Аргументы для инициализации ChatThreadClientProvider.
ChatThreadClientState

Централизованное состояние для <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties

Свойства потока чата.

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

Централизованное состояние для <xref:%40azure%2Fcommunication-calling%23CallClient> или <xref:%40azure%2Fcommunication-chat%23ChatClient>.

См. также: CallClientState, ChatClientState.
Common

Возвращаемый тип пересечения из 2 типов
CommonProperties

Возврат свойств пересечения 2 типов
CommunicationParticipant

Состояние участника чата или вызова, отраженное в пользовательском интерфейсе.
ComponentIcons

Значки, используемые React компонентами, экспортируемыми из этой библиотеки.
ComponentProps

Вспомогательный тип для usePropsFor.
CompositeIcons

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

Дополнительные сведения о целевых типах см. в разделах ChatCompositeIcons, CallCompositeIcons и CallWithChatCompositeIcons .
ControlBarButtonStyles

Стили для всех реализаций ControlBarButton .
ControlBarLayout

Представление макетов для ControlBar.
CreateViewResult

Возвращает результат из createView.
CustomAvatarOptions

Параметры, которые можно внедрить в функцию onRender для настройки компонента аватара (Persona).
DeviceManagerState

Этот тип предназначен для инкапсуляции всего состояния внутри <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Для необязательных параметров они могут быть недоступны, пока пользователь не предоставит разрешение. Состояния камер, микрофонов, динамиков и deviceAccess будут пустыми, пока не будут вызваны и завершены соответствующие <xref:%40azure%2Fcommunication-calling%23DeviceManager>API getCameras, getMicrophones, getSpeakers и askDevicePermission.
DevicesButtonSelector

Тип селектора для компонента DevicesButton .
DiagnosticChangedEventListner

Обратный вызов для события CallAdapterSubscribers diagnosticChanged.
DisplayNameChangedListener

Обратный вызов для события CallAdapterSubscribers "displayNameChanged".
EmptySelector

Тип для тривиальных селекторов, которые не возвращают данные.

Используется в качестве возвращаемого значения по умолчанию, если метод usePropsFor вызывается для компонента, который не требует данных.
ErrorType

Все ошибки, которые могут отображаться на панели ошибок.
GetCallingSelector

Конкретный тип селектора, применимый к данному компоненту.
GetChatSelector

Конкретный тип селектора, применимый к данному компоненту.
IsLocalScreenSharingActiveChangedListener

Обратный вызов для события CallAdapterSubscribers isLocalScreenSharingActiveChanged.
IsMutedChangedListener

Обратный вызов для события CallAdapterSubscribers isMuted.
IsSpeakingChangedListener

Обратный вызов для события CallAdapterSubscribers isSpeakingChanged.
LoadingState

Указывает, загружается ли поток.
LocalizationProviderProps

Реквизиты для LocalizationProvider.
MediaDiagnosticChangedEvent

Полезные данные для DiagnosticChangedEventListner , где произошло изменение в диагностике мультимедиа.
Message

Различаемое объединение всех сообщений.

Поле messageType специализируется на вариантах объединения.
MessageAttachedStatus

Укажите, должно ли отображаться сообщение чата, объединенное с сообщением до и после него.

Полезно для объединения нескольких сообщений от одного отправителя в один пузырек сообщений.
MessageContentType

Поддерживаемые типы содержимого сообщений чата.
MessageProps

Свойства для отрисовки одного сообщения.

См. раздел MessageRenderer.
MessageReadListener

Обратный вызов для события ChatAdapterSubscribers messageRead.
MessageReceivedListener

Обратный вызов для события ChatAdapterSubscribers messageReceived.
MessageRenderer

Компонент для отрисовки одного сообщения.
MessageSentListener

Обратный вызов для события ChatAdapterSubscribers messageSent.
MessageStatus

Состояние отправленного сообщения на стороне клиента.

Включает переходные состояния, возникающие до подтверждения доставки сообщений из серверной части.
MessageThreadProps

Реквизиты для MessageThread.
MessageThreadSelector

Тип селектора для компонента MessageThread .
MicrophoneButtonSelector

Тип селектора для компонента MicrophoneButton .
NetworkDiagnosticChangedEvent

Полезные данные для DiagnosticChangedEventListner , в которых произошло изменение в диагностике сети.
OnRenderAvatarCallback

Настраиваемый отрисованный обратный вызов, позволяющий пользователям настраивать отрисовку компонента Persona.
ParticipantListParticipant

Участники, отображаемые в списке участников.
ParticipantListProps

Реквизит для Списка участников.
ParticipantListSelector

Тип селектора для компонента ParticipantList .
ParticipantMenuItemsCallback

Обратный вызов для предоставления настраиваемых пунктов меню для каждого участника в Списке участников.
ParticipantState

Состояние подключения участника вызова.
ParticipantsAddedListener

Обратный вызов для события ChatAdapterSubscribers "participantsAdded".
ParticipantsButtonSelector

Тип селектора для компонента ParticipantsButton .
ParticipantsJoinedListener

Обратный вызов для события CallAdapterSubscribers "participantsJoined".
ParticipantsLeftListener

Обратный вызов для события CallAdapterSubscribers "participantsLeft".
ParticipantsRemovedListener

Обратный вызов для события ChatAdapterSubscribers "participantsRemoved".
ReadReceiptsBySenderId

Массив пар "ключ-значение", в котором хранятся отображаемое имя каждого отправителя и последнее прочитанное сообщение.
ScreenShareButtonSelector

Тип селектора для компонента ScreenShareButton .
Selector

Оптимизированный селектор, который уточняет обновления ClientState до свойств для React компонентов в этой библиотеке.
SendBoxSelector

Тип селектора для компонента SendBox .
StatefulCallClientArgs

Аргументы для создания StatefulCallClient.
StatefulCallClientOptions

Параметры для создания StatefulCallClient.
StatefulChatClientArgs

Аргументы для создания StatefulChatClient.
StatefulChatClientOptions

Параметры для создания StatefulChatClient.
SystemMessage

Различаемое объединение всех системных сообщений.

Поле systemMessageType специализируется на вариантах объединения.
TopicChangedListener

Обратный вызов для события ChatAdapterSubscribers "topicChanged".
TypingIndicatorSelector

Тип селектора для компонента TypeingIndicator .
UpdateMessageCallback

Функция обратного вызова выполняется при обновлении сообщения.
VideoGalleryLayout
VideoGalleryLocalParticipant

Состояние локального участника в VideoGallery.
VideoGalleryParticipant

Состояние участника в VideoGallery.
VideoGallerySelector

Тип селектора для компонента VideoGallery .
ViewScalingMode

Режим масштабирования Объекта VideoGalleryStream.

Функции

CallAgentProvider(CallAgentProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-calling%23CallAgent>объект .

Вызывающие компоненты из этого пакета должны быть заключены в CallAgentProvider.
CallClientProvider(CallClientProviderProps)

Объект <xref:React.Context> , в котором хранится StatefulCallClient.

Вызывающие компоненты из этого пакета должны быть заключены в CallClientProvider.
CallComposite(CallCompositeProps)

Настраиваемый пользовательский интерфейс для взаимодействия с вызовами.
CallProvider(CallProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-calling%23Call>объект .

Вызывающие компоненты из этого пакета должны быть заключены в CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite объединяет ключевые компоненты, чтобы обеспечить полный вызов с чатом из коробки.
CameraButton(CameraButtonProps)

Кнопка для включения и выключения камеры.

Можно использовать с ControlBar.
ChatClientProvider(ChatClientProviderProps)

Объект <xref:React.Context> , в котором хранится StatefulChatClient.

Компоненты чата из этого пакета должны быть заключены в chatClientProvider.
ChatComposite(ChatCompositeProps)

Настраиваемый пользовательский интерфейс для взаимодействия с чатом.
ChatThreadClientProvider(ChatThreadClientProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>объект .

Компоненты чата из этого пакета должны быть заключены в chatThreadClientProvider.
ControlBar(ControlBarProps)

Контейнер для различных кнопок для элементов управления вызовами.

Используйте с различными кнопками управления вызовами в этой библиотеке, например CameraButton или собственными экземплярами ControlBarButton напрямую.
ControlBarButton(ControlBarButtonProps)

Кнопка по умолчанию для controlBar.

Используйте этот компонент, чтобы создавать настраиваемые кнопки, стили которых совпадают с стилем других кнопок, предоставляемых библиотекой пользовательского интерфейса.
DevicesButton(DevicesButtonProps)

Кнопка для открытия меню, которое управляет параметрами устройства.

Можно использовать с ControlBar.
EndCallButton(EndCallButtonProps)

Кнопка для завершения текущего вызова.

Можно использовать с ControlBar.
ErrorBar(ErrorBarProps)

Компонент для отображения сообщений об ошибках в пользовательском интерфейсе. Все отображаемые строки принимаются в качестве строк , чтобы их можно было локализовать. Активные ошибки выбираются параметром activeErrorMessages.

Этот компонент внутренне отслеживает отклоненные пользователем.

  • Ошибки с связанной меткой времени. Ошибка снова отображается в пользовательском интерфейсе, если она возникает после закрытия.
  • Ошибки без метки времени. Ошибка закрывается до тех пор, пока не исчезнет из реквизита. Если ошибка повторяется, она отображается в пользовательском интерфейсе.

Использует <xref:%40fluentui%2Freact%23MessageBar> элемент пользовательского интерфейса.
FluentThemeProvider(FluentThemeProviderProps)

Поставщик для применения темы Fluent к компонентам react этой библиотеки.
GridLayout(GridLayoutProps)

Компонент для размещения плиток участников аудио- и видео в вызове.
LocalizationProvider(LocalizationProviderProps)

Поставщик для предоставления локализованных строк для компонентов react этой библиотеки.
MessageStatusIndicator(MessageStatusIndicatorProps)

Компонент для отображения состояния отправленного сообщения.

Добавляет значок и подсказку, соответствующие состоянию сообщения.
MessageThread(MessageThreadProps)

MessageThread позволяет легко создать компонент для отрисовки сообщений чата, обработки поведения прокрутки новых или старых сообщений и настройки значков & элементов управления в потоке чата.
MicrophoneButton(MicrophoneButtonProps)

Кнопка для включения и выключения микрофона.

Можно использовать с ControlBar.
ParticipantItem(ParticipantItemProps)

Компонент для отрисовки вызывающего участника или участника чата.

Отображает аватар участника, displayName и состояние, а также необязательные значки и контекстное меню.
ParticipantList(ParticipantListProps)

Компонент для отрисовки всех участников звонков или чата.

По умолчанию каждый участник отображается с помощью Элемента участника. См. <xref:ParticipantListProps.onRenderParticipant> сведения о переопределении.
ParticipantsButton(ParticipantsButtonProps)

Кнопка для отображения меню с участниками вызова или чата.

Можно использовать с ControlBar.

Эта кнопка содержит пункты раскрывающегося меню, определенные с помощью свойства menuProps. По умолчанию в нем может отображаться количество удаленных участников с полным списком в виде подменю и параметр отключения звука для всех участников, а также кнопка копирования в буфер обмена для копирования URL-адреса приглашения на вызов. Его menuProps можно полностью переопределять, и его свойство имеет тип IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)

Кнопка для запуска или остановки демонстрации экрана.

Можно использовать с ControlBar.
SendBox(SendBoxProps)

Компонент для ввода и отправки сообщений.

Поддерживает отправку уведомления о вводе, когда пользователь начинает вводить текст. Поддерживает необязательное сообщение под текстовым полем ввода.
StreamMedia(StreamMediaProps)

Компонент служебной программы для преобразования HTMLElement с видеопотоком в элемент JSX.

Используйте для преобразования элемента HTMLElement, возвращаемого API-интерфейсом без головного вызова, в компонент, который можно отрисовывать в виде VideoTile.
TypingIndicator(TypingIndicatorProps)

Компонент для уведомления локального пользователя о вводе одного или нескольких участников потока чата.
VideoGallery(VideoGalleryProps)

VideoGallery представляет макет плиток видео для определенного вызова. Он отображает VideoTile для локального пользователя, а также для каждого удаленного участника, присоединившегося к вызову.
VideoTile(VideoTileProps)

Компонент для отрисовки видеопотока для одного участника вызова.

Используйте с GridLayout в VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Создайте CallAdapter с помощью Службы коммуникации Azure.

Это реализация CallAdapter по умолчанию, предоставляемая этой библиотекой.

Примечание. displayName Может содержать не более 256 символов.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Создайте CallAdapter с помощью предоставленного StatefulCallClient.

Полезно, если требуется сохранить ссылку на StatefulCallClient. Рассмотрите возможность использования createAzureCommunicationCallAdapter для более простого API.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Создайте Объект CallWithChatAdapter, поддерживаемый службами коммуникации Azure, для подключения к CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Создайте CallWithChatAdapter , используя предоставленные StatefulChatClient и StatefulCallClient.

Полезно, если требуется сохранить ссылку на StatefulChatClient и StatefulCallClient. Рассмотрите возможность использования createAzureCommunicationCallWithChatAdapter для более простого API.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Создайте ChatAdapter на Службы коммуникации Azure.

Это реализация ChatAdapter по умолчанию, предоставляемая этой библиотекой.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Создайте ChatAdapter с помощью предоставленного StatefulChatClient.

Полезно, если вы хотите сохранить ссылку на StatefulChatClient. Рассмотрите возможность использования createAzureCommunicationChatAdapter для более простого API.
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Создайте реализацию по умолчанию CallingHandlers для вызова teams.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Создайте реализацию ChatHandlers по умолчанию.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

Возвращенный объект запоминается, чтобы избежать перерисовки при использовании в качестве реквизита для компонентов React.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Создает StatefulCallClient StatefulCallClient путем прокси-сервера CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> с proxyCallClient <xref:ProxyCallClient> , который затем разрешает доступ к состоянию декларативным способом.

Важно использовать <xref:%40azure%2Fcommunication-calling%23DeviceManager> и и <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (и т. д.), полученные из StatefulCallClient, чтобы изменения их состояния были правильно прокси-серверы.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Создает объект с отслеживанием состояния ChatClient StatefulChatClient , используя прокси-сервер ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> с ProxyChatClient <xref:ProxyChatClient> , который затем разрешает доступ к состоянию декларативным способом.
fromFlatCommunicationIdentifier(string)

Обратная операция toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)

Получение селектора для указанного компонента.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
getChatSelector<Component>(Component)

Получение селектора для указанного компонента.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
toFlatCommunicationIdentifier(CommunicationIdentifier)

Строковое представление объекта <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Это строковое представление CommunicationIdentifier гарантированно будет стабильным для уникального пользователя Communication. Таким образом, выражение

  • Его можно использовать для сохранения удостоверения пользователя во внешних базах данных.
  • Его можно использовать в качестве ключей в карте для хранения данных для пользователя.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания CallAdapter.

Аналогично createAzureCommunicationCallAdapter, но выполняет асинхронное создание адаптера внутри организации.

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

Обратите внимание, что необходимо запомнить аргументы, чтобы избежать повторного создания адаптера при каждой отрисовке. Типичные примеры использования см. в сборнике историй.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания CallWithChatAdapter.

Аналогично createAzureCommunicationCallWithChatAdapter, но внутренне выполняет асинхронное создание адаптера.

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

Обратите внимание, что необходимо запомнить аргументы, чтобы избежать повторного создания адаптера при каждой отрисовке. Типичные примеры использования см. в сборнике историй.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания ChatAdapter.

Аналогично createAzureCommunicationChatAdapter, но внутренне выполняет асинхронное создание адаптера.

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

Обратите внимание, что необходимо запомнить аргументы, чтобы избежать повторного создания адаптера при каждой отрисовке. Типичные примеры использования см. в сборнике историй.
useCall()

Перехватчик для получения <xref:%40azure%2Fcommunication-calling%23Call> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

Для использования этого перехватчика необходимо использовать CallProvider с объектом Call.
useCallAgent()

Перехватчик для получения <xref:%40azure%2Fcommunication-calling%23CallAgent> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
useCallClient()

Перехватчик для получения StatefulCallClient от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
useChatClient()

Перехватчик для получения StatefulChatClient от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
useChatThreadClient()

Перехватчик для получения <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
useDeviceManager()

Перехватчик для получения StatefulDeviceManager от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
usePropsFor<Component>(Component, "chat" | "calling")

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

Чтобы вызвать этот перехватчик, компонент должен быть заключен в оболочку с помощью следующих поставщиков:

  1. Для компонентов чата: ChatClientProvider и ChatThreadClientProvider.

  2. Для вызовов компонентов: CallClientProvider, CallAgentProvider и CallAgentProvider.

Наиболее простое использование компонентов выглядит следующим образом:

Пример

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

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

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.
useTheme()

React перехватчика для доступа к теме

Сведения о функции

CallAgentProvider(CallAgentProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-calling%23CallAgent>объект .

Вызывающие компоненты из этого пакета должны быть заключены в CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Параметры

props
CallAgentProviderProps

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

Element

CallClientProvider(CallClientProviderProps)

Объект <xref:React.Context> , в котором хранится StatefulCallClient.

Вызывающие компоненты из этого пакета должны быть заключены в CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Параметры

props
CallClientProviderProps

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

Element

CallComposite(CallCompositeProps)

Настраиваемый пользовательский интерфейс для взаимодействия с вызовами.

function CallComposite(props: CallCompositeProps): Element

Параметры

props
CallCompositeProps

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

Element

Комментарии

Для вызова составной минимальной ширины и высоты используются следующие значения:

  • mobile: 17,5rem x 21rem (280 пикселей x 336 пикселей, с rem по умолчанию на 16 пикселей)
  • desktop: 30rem x 22rem (480 пикселей x 352 пикселей, с rem по умолчанию в 16 пикселей)

CallProvider(CallProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-calling%23Call>объект .

Вызывающие компоненты из этого пакета должны быть заключены в CallProvider.

function CallProvider(props: CallProviderProps): Element

Параметры

props
CallProviderProps

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

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite объединяет ключевые компоненты, чтобы обеспечить полный вызов с чатом из коробки.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Параметры

props
CallWithChatCompositeProps

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

Element

CameraButton(CameraButtonProps)

Кнопка для включения и выключения камеры.

Можно использовать с ControlBar.

function CameraButton(props: CameraButtonProps): Element

Параметры

props
CameraButtonProps

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

Element

ChatClientProvider(ChatClientProviderProps)

Объект <xref:React.Context> , в котором хранится StatefulChatClient.

Компоненты чата из этого пакета должны быть заключены в chatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Параметры

props
ChatClientProviderProps

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

Element

ChatComposite(ChatCompositeProps)

Настраиваемый пользовательский интерфейс для взаимодействия с чатом.

function ChatComposite(props: ChatCompositeProps): Element

Параметры

props
ChatCompositeProps

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

Element

Комментарии

Ширина и высота составной минимальной ширины чата соответственно 17,5 rem и 20rem (280 пикселей и 320 пикселей, с rem по умолчанию в 16 пикселей).

ChatThreadClientProvider(ChatThreadClientProviderProps)

Объект , <xref:React.Context> в котором хранится <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>объект .

Компоненты чата из этого пакета должны быть заключены в chatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Параметры

props
ChatThreadClientProviderProps

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

Element

ControlBar(ControlBarProps)

Контейнер для различных кнопок для элементов управления вызовами.

Используйте с различными кнопками управления вызовами в этой библиотеке, например CameraButton или собственными экземплярами ControlBarButton напрямую.

function ControlBar(props: ControlBarProps): Element

Параметры

props
ControlBarProps

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

Element

ControlBarButton(ControlBarButtonProps)

Кнопка по умолчанию для controlBar.

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

function ControlBarButton(props: ControlBarButtonProps): Element

Параметры

props
ControlBarButtonProps

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

Element

DevicesButton(DevicesButtonProps)

Кнопка для открытия меню, которое управляет параметрами устройства.

Можно использовать с ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Параметры

props
DevicesButtonProps

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

Element

EndCallButton(EndCallButtonProps)

Кнопка для завершения текущего вызова.

Можно использовать с ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Параметры

props
EndCallButtonProps

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

Element

ErrorBar(ErrorBarProps)

Компонент для отображения сообщений об ошибках в пользовательском интерфейсе. Все отображаемые строки принимаются в качестве строк , чтобы их можно было локализовать. Активные ошибки выбираются параметром activeErrorMessages.

Этот компонент внутренне отслеживает отклоненные пользователем.

  • Ошибки с связанной меткой времени. Ошибка снова отображается в пользовательском интерфейсе, если она возникает после закрытия.
  • Ошибки без метки времени. Ошибка закрывается до тех пор, пока не исчезнет из реквизита. Если ошибка повторяется, она отображается в пользовательском интерфейсе.

Использует <xref:%40fluentui%2Freact%23MessageBar> элемент пользовательского интерфейса.

function ErrorBar(props: ErrorBarProps): Element

Параметры

props
ErrorBarProps

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

Element

FluentThemeProvider(FluentThemeProviderProps)

Поставщик для применения темы Fluent к компонентам react этой библиотеки.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Параметры

props
FluentThemeProviderProps

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

Element

Комментарии

Компоненты в этой библиотеке состоят в основном из пользовательского интерфейса Fluent, элементов управления, а также из элементов управления Fluent React Northstar. Этот поставщик обрабатывает применение любой темы, предоставленной как к базовым элементам управления пользовательского интерфейса Fluent, так и к элементам управления Fluent React Northstar.

GridLayout(GridLayoutProps)

Компонент для размещения плиток участников аудио- и видео в вызове.

function GridLayout(props: GridLayoutProps): Element

Параметры

props
GridLayoutProps

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

Element

LocalizationProvider(LocalizationProviderProps)

Поставщик для предоставления локализованных строк для компонентов react этой библиотеки.

function LocalizationProvider(props: LocalizationProviderProps): Element

Параметры

props
LocalizationProviderProps

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

Element

Комментарии

Компоненты будут предоставляться локализованные строки на английском языке (США) по умолчанию, если этот поставщик не используется.

MessageStatusIndicator(MessageStatusIndicatorProps)

Компонент для отображения состояния отправленного сообщения.

Добавляет значок и подсказку, соответствующие состоянию сообщения.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Параметры

props
MessageStatusIndicatorProps

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

Element

MessageThread(MessageThreadProps)

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

function MessageThread(props: MessageThreadProps): Element

Параметры

props
MessageThreadProps

типа MessageThreadProps

Пользователям потребуется предоставить по крайней мере сообщения чата и userId для отрисовки MessageThread компонента. Пользователи также могут настраивать MessageThread , передавая собственный аватар, MessageStatusIndicator значок, JumpToNewMessageButtonи LoadPreviousMessagesButton поведение этих элементов управления.

MessageThread внутренне использует Chat компонент & Chat.Message из @fluentui/react-northstar. Вы можете получить сведения об этих двух компонентах.

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

Element

MicrophoneButton(MicrophoneButtonProps)

Кнопка для включения и выключения микрофона.

Можно использовать с ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Параметры

props
MicrophoneButtonProps

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

Element

ParticipantItem(ParticipantItemProps)

Компонент для отрисовки вызывающего участника или участника чата.

Отображает аватар участника, displayName и состояние, а также необязательные значки и контекстное меню.

function ParticipantItem(props: ParticipantItemProps): Element

Параметры

props
ParticipantItemProps

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

Element

ParticipantList(ParticipantListProps)

Компонент для отрисовки всех участников звонков или чата.

По умолчанию каждый участник отображается с помощью Элемента участника. См. <xref:ParticipantListProps.onRenderParticipant> сведения о переопределении.

function ParticipantList(props: ParticipantListProps): Element

Параметры

props
ParticipantListProps

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

Element

ParticipantsButton(ParticipantsButtonProps)

Кнопка для отображения меню с участниками вызова или чата.

Можно использовать с ControlBar.

Эта кнопка содержит пункты раскрывающегося меню, определенные с помощью свойства menuProps. По умолчанию в нем может отображаться количество удаленных участников с полным списком в виде подменю и параметр отключения звука для всех участников, а также кнопка копирования в буфер обмена для копирования URL-адреса приглашения на вызов. Его menuProps можно полностью переопределять, и его свойство имеет тип IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Параметры

props
ParticipantsButtonProps

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

Element

ScreenShareButton(ScreenShareButtonProps)

Кнопка для запуска или остановки демонстрации экрана.

Можно использовать с ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Параметры

props
ScreenShareButtonProps

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

Element

SendBox(SendBoxProps)

Компонент для ввода и отправки сообщений.

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

function SendBox(props: SendBoxProps): Element

Параметры

props
SendBoxProps

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

Element

StreamMedia(StreamMediaProps)

Компонент служебной программы для преобразования HTMLElement с видеопотоком в элемент JSX.

Используйте для преобразования элемента HTMLElement, возвращаемого API-интерфейсом без головного вызова, в компонент, который можно отрисовывать в виде VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Параметры

props
StreamMediaProps

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

Element

TypingIndicator(TypingIndicatorProps)

Компонент для уведомления локального пользователя о вводе одного или нескольких участников потока чата.

function TypingIndicator(props: TypingIndicatorProps): Element

Параметры

props
TypingIndicatorProps

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

Element

VideoGallery(VideoGalleryProps)

VideoGallery представляет макет плиток видео для определенного вызова. Он отображает VideoTile для локального пользователя, а также для каждого удаленного участника, присоединившегося к вызову.

function VideoGallery(props: VideoGalleryProps): Element

Параметры

props
VideoGalleryProps

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

Element

VideoTile(VideoTileProps)

Компонент для отрисовки видеопотока для одного участника вызова.

Используйте с GridLayout в VideoGallery.

function VideoTile(props: VideoTileProps): Element

Параметры

props
VideoTileProps

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

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Создайте CallAdapter с помощью Службы коммуникации Azure.

Это реализация CallAdapter по умолчанию, предоставляемая этой библиотекой.

Примечание. displayName Может содержать не более 256 символов.

function createAzureCommunicationCallAdapter(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>

Параметры

__namedParameters
AzureCommunicationCallAdapterArgs

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

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Создайте CallAdapter с помощью предоставленного StatefulCallClient.

Полезно, если требуется сохранить ссылку на StatefulCallClient. Рассмотрите возможность использования createAzureCommunicationCallAdapter для более простого API.

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator): Promise<CallAdapter>

Параметры

callClient
StatefulCallClient
callAgent
CallAgent
locator
CallAdapterLocator

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

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Создайте Объект CallWithChatAdapter, поддерживаемый службами коммуникации Azure, для подключения к CallWithChatComposite.

function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>

Параметры

__namedParameters
AzureCommunicationCallWithChatAdapterArgs

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

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Создайте CallWithChatAdapter , используя предоставленные StatefulChatClient и StatefulCallClient.

Полезно, если требуется сохранить ссылку на StatefulChatClient и StatefulCallClient. Рассмотрите возможность использования createAzureCommunicationCallWithChatAdapter для более простого API.

function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>

Параметры

__namedParameters
AzureCommunicationCallWithChatAdapterFromClientArgs

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

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Создайте ChatAdapter на Службы коммуникации Azure.

Это реализация ChatAdapter по умолчанию, предоставляемая этой библиотекой.

function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>

Параметры

__namedParameters
AzureCommunicationChatAdapterArgs

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

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Создайте ChatAdapter с помощью предоставленного StatefulChatClient.

Полезно, если вы хотите сохранить ссылку на StatefulChatClient. Рассмотрите возможность использования createAzureCommunicationChatAdapter для более простого API.

function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>

Параметры

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

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

Promise<ChatAdapter>

createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Создайте реализацию по умолчанию CallingHandlers для вызова teams.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call): CallingHandlers

Параметры

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

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

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Создайте реализацию ChatHandlers по умолчанию.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

Возвращенный объект запоминается, чтобы избежать перерисовки при использовании в качестве реквизита для компонентов React.

function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers

Параметры

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

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

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Создает StatefulCallClient StatefulCallClient путем прокси-сервера CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> с proxyCallClient <xref:ProxyCallClient> , который затем разрешает доступ к состоянию декларативным способом.

Важно использовать <xref:%40azure%2Fcommunication-calling%23DeviceManager> и и <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (и т. д.), полученные из StatefulCallClient, чтобы изменения их состояния были правильно прокси-серверы.

function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient

Параметры

args
StatefulCallClientArgs

StatefulCallClientArgs

options
StatefulCallClientOptions

StatefulCallClientOptions

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

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Создает объект с отслеживанием состояния ChatClient StatefulChatClient , используя прокси-сервер ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> с ProxyChatClient <xref:ProxyChatClient> , который затем разрешает доступ к состоянию декларативным способом.

function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient

Параметры

args
StatefulChatClientArgs
options
StatefulChatClientOptions

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

StatefulChatClient

fromFlatCommunicationIdentifier(string)

Обратная операция toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Параметры

id

string

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

CommunicationIdentifier

getCallingSelector<Component>(Component)

Получение селектора для указанного компонента.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function getCallingSelector<Component>(component: Component): GetCallingSelector<Component>

Параметры

component

Component

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

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Получение селектора для указанного компонента.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function getChatSelector<Component>(component: Component): GetChatSelector<Component>

Параметры

component

Component

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

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Строковое представление объекта <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Это строковое представление CommunicationIdentifier гарантированно будет стабильным для уникального пользователя Communication. Таким образом, выражение

  • Его можно использовать для сохранения удостоверения пользователя во внешних базах данных.
  • Его можно использовать в качестве ключей в карте для хранения данных для пользователя.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Параметры

identifier
CommunicationIdentifier

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

string

useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания CallAdapter.

Аналогично createAzureCommunicationCallAdapter, но выполняет асинхронное создание адаптера внутри организации.

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

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

function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter

Параметры

args

Partial<AzureCommunicationCallAdapterArgs>

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

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

undefined | CallAdapter

useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания CallWithChatAdapter.

Аналогично createAzureCommunicationCallWithChatAdapter, но внутренне выполняет асинхронное создание адаптера.

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

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

function useAzureCommunicationCallWithChatAdapter(args: Partial<AzureCommunicationCallWithChatAdapterArgs>, afterCreate?: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, beforeDispose?: (adapter: CallWithChatAdapter) => Promise<void>): undefined | CallWithChatAdapter

Параметры

args

Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

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

undefined | CallWithChatAdapter

useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

Пользовательский обработчик React для упрощения создания ChatAdapter.

Аналогично createAzureCommunicationChatAdapter, но внутренне выполняет асинхронное создание адаптера.

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

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

function useAzureCommunicationChatAdapter(args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: (adapter: ChatAdapter) => Promise<ChatAdapter>, beforeDispose?: (adapter: ChatAdapter) => Promise<void>): undefined | ChatAdapter

Параметры

args

Partial<AzureCommunicationChatAdapterArgs>

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

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

undefined | ChatAdapter

useCall()

Перехватчик для получения <xref:%40azure%2Fcommunication-calling%23Call> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

Для использования этого перехватчика необходимо использовать CallProvider с объектом Call.

function useCall(): undefined | Call

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

undefined | Call

useCallAgent()

Перехватчик для получения <xref:%40azure%2Fcommunication-calling%23CallAgent> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useCallAgent(): undefined | CallAgent

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

undefined | CallAgent

useCallClient()

Перехватчик для получения StatefulCallClient от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useCallClient(): StatefulCallClient

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

StatefulCallClient

useChatClient()

Перехватчик для получения StatefulChatClient от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useChatClient(): StatefulChatClient

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

StatefulChatClient

useChatThreadClient()

Перехватчик для получения <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useChatThreadClient(): ChatThreadClient

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

ChatThreadClient

useDeviceManager()

Перехватчик для получения StatefulDeviceManager от поставщика.

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useDeviceManager(): undefined | StatefulDeviceManager

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

undefined | StatefulDeviceManager

usePropsFor<Component>(Component, "chat" | "calling")

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

Чтобы вызвать этот перехватчик, компонент должен быть заключен в оболочку с помощью следующих поставщиков:

  1. Для компонентов чата: ChatClientProvider и ChatThreadClientProvider.

  2. Для вызовов компонентов: CallClientProvider, CallAgentProvider и CallAgentProvider.

Наиболее простое использование компонентов выглядит следующим образом:

Пример

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }

function usePropsFor<Component>(component: Component, type?: "chat" | "calling"): ComponentProps<Component>

Параметры

component

Component

type

"chat" | "calling"

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

ComponentProps<Component>

useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

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

Полезно при реализации пользовательского компонента, который использует поставщики, экспортированные из этой библиотеки.

function useSelector<ParamT>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), type?: "chat" | "calling"): (ParamT extends Selector ? ReturnType<ParamT> : undefined)

Параметры

selector

ParamT

selectorProps

(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)

type

"chat" | "calling"

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

(ParamT extends Selector ? ReturnType<ParamT> : undefined)

useTheme()

React перехватчика для доступа к теме

function useTheme(): Theme

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

Theme