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

@azure/communication-react package

  • Ссылка

Классы

CallError

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

Ошибка, возникаемая из методов StatefulChatClient.

Интерфейсы

ActiveErrorMessage

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

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

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

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

Базовые стили флюентных стилей для всех компонентов, экспортированных из этой либраи.
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

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

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

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

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

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

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

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

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

CallWithChat State — это сочетание клиентов чата с отслеживанием состояния и вызовов с определенным состоянием, характерным только для Составного CallWithChat.
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

Системное сообщение с содержимым arbitary.
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

Все строки, которые могут отображаться в пользовательском интерфейсе в ErrorBar.
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

Стили для меню микрофона.
MicrophoneButtonProps

Реквизиты для МикрофонButton.
MicrophoneButtonStrings

Строки МикрофонButton, которые можно переопределить.
MicrophoneButtonStyles

Стили для МикрофонButton
NetworkDiagnosticsState

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

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

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

Реквизиты для ParticipantItem.
ParticipantItemStrings

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

Стили Fluent для ParticipantItem.
ParticipantListItemStyles

Стили для ParticipantListParticipantItem.
ParticipantListStyles

Стили для УчастникаList.
ParticipantRemovedSystemMessage

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

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

Реквизиты для УчастниковButton.
ParticipantsButtonStrings

Строки УчастниковButton, которые можно переопределить.
ParticipantsButtonStyles

Стили реквизитов для УчастниковButton.
RecordingCallFeature

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

Состояние только версии <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient автоматически извлекает удаленныеparticipants и добавляет их состояние в состояние, предоставляемое 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.

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

  • Возвращенные данные из API <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
  • Возвращенные данные из API <xref:%40azure%2Fcommunication-calling%23CallAgent>.
  • Прослушиватели автоматически подключаются к различным объектам связи Azure:
    • CallAgent "incomingCall"
    • CallAgent "callUpdated"
    • DeviceManager "videoDevicesUpdated"
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Вызов stateChanged
    • Вызов "idChanged"
    • Вызов isMutedChanged
    • Вызов isScreenSharingOnChanged
    • Вызов remoteParticipantsUpdated
    • Вызов localVideoStreamsUpdated
    • ВходящийCall "callEnded"
    • RemoteParticipant "stateChanged"
    • RemoteParticipant isMutedChanged
    • RemoteParticipant "displayNameChanged"
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant "videoStreamsUpdated"
    • RemoteVideoStream 'isAvailableChanged'
    • ТранскрибированиеCallFeature '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

стили компонентов VideoGallery.
VideoStreamOptions

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

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

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

Стили Fluent для VideoTile.

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

AdapterErrors

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

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

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

Сравните, если реквизиты из 2 компонентов 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: имя имеет битовое значение. Переименуйте меня.
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

Возвращать свойства intersect из 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 будут пустыми, пока соответствующие api getcameras <xref:%40azure%2Fcommunication-calling%23DeviceManager>, getMicrophones, getSpeakers и askDevicePermission API вызываются и завершены.
DevicesButtonSelector

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

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

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

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

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

Все ошибки, которые можно просмотреть в errorBar.
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

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

Реквизиты для ParticipantList.
ParticipantListSelector

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

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

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

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

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

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

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

Обратный вызов для ChatAdapterSubscribers событие "Участники удалено".
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 в компонентах реагирования этой библиотеки.
GridLayout(GridLayoutProps)

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

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

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

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

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

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

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

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

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

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

По умолчанию каждый участник отображается с ParticipantItem. См. <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)

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

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

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

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

Возвращенный объект замечен, чтобы избежать rerenders при использовании в качестве реквизитов для компонентов 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)

Создает 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 (280px x 336px, с rem по умолчанию в 16 пикселей)
  • desktop: 30rem x 22rem (480px x 352px, с 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.5rem и 20rem (280px и 320px, с 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 в компонентах реагирования этой библиотеки.

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)

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

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

Пользователям потребуется предоставить по крайней мере сообщения чата и идентификатор пользователя для отрисовки компонента 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)

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

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

function ParticipantItem(props: ParticipantItemProps): Element

Параметры

props
ParticipantItemProps

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

Element

ParticipantList(ParticipantListProps)

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

По умолчанию каждый участник отображается с ParticipantItem. См. <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)

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

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

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 по умолчанию.

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

Возвращенный объект замечен, чтобы избежать rerenders при использовании в качестве реквизитов для компонентов 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)

Создает 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