@azure/communication-react package

リファレンス

クラス

CallError	失敗したステートフル API メソッドからスローされたエラー。
ChatError	失敗した StatefulChatClient メソッドからスローされたエラー。

インターフェイス

AcceptedTransfer	転送フィーチャの状態
ActiveErrorMessage	ErrorBarを介して表示されるアクティブなエラーメッセージ。
ActiveNotification	NotificationStack を介して表示されるアクティブな通知。
AdapterError	エラーイベントによって報告され、アダプターの状態で格納されます。
AdapterNotification	アダプター状態に格納されている呼び出しクライアント状態からの通知。
AdapterState	複合アダプターの状態とのインターフェイスの機能。
AttachmentMetadata	チャットメッセージの添付ファイルを表すデータモデルで、添付ファイルを一意に識別するための ID、ファイル名を表す名前、および添付ファイルをダウンロードするための URL が含まれています。
BaseCompositeProps	このライブラリからエクスポートされるすべての複合に共通のプロパティ。
BaseCustomStyles	この libray からエクスポートされるすべてのコンポーネントの基本的な fluent スタイルのプロパティ。
BreakoutRoomsState	ブレイクアウトルームの状態
CallAdapter	CommonCallAdapter 拡張する Azure Communication ID に固有のアダプターインターフェイス。
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によってプロキシされるすべての状態データのコンテナー。 callAgent が作成された場合、呼び出し、callsEnded、incomingCalls、および incomingCallsEnded の状態が自動的に提供されます。 DeviceManagerState が表示されるまで、deviceManager は最初は空になります。 userId 状態は、開発者にとって便利な機能として提供され、開発者によって完全に制御および設定されます。
CallCompositeLoaderProps	アプリケーションで使用できる OutboundCallComposite の props。 2つのオプションバッグが含まれています。 adapterOptions: のオプション useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs \| AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) callCompositeOptions: CallComposite CallCompositeOptions のオプション
CallCompositeProps	CallCompositeのプロパティ。
CallCompositeStrings	CallComposite によって使用される文字列直接。この文字列は、コンポーネントライブラリのコンポーネントで使用される文字列に加えて使用されます。
CallFeatureStreamState	<xref:%40azure%2Fcommunication-calling%23CallFeatureStream>の状態のみバージョン。通話機能ストリームの状態を表します。
CallInfoState	<xref:CallInfo> と<xref:TeamsCallInfo>
CallNotification
CallProviderProps	CallProviderを初期化する引数。
CallState	<xref:%40azure%2Fcommunication-calling%23Call>の状態のみバージョン。 StatefulCallClient は、呼び出しの状態を自動的に取得し、StatefulCallClientによって公開されている状態に追加します。
CallSurveyImprovementSuggestions	コールサーベイの改善提案部分を表します
CallWithChatAdapter	CallWithChatComposite アダプターインターフェイスをします。
CallWithChatAdapterManagement	チャットを使用して現在の通話を管理するための機能。
CallWithChatAdapterState	CallWithChat State は、ステートフルチャットクライアントとステートフル通話クライアントと、CallWithChat 複合のみに固有の状態の組み合わせです。
CallWithChatAdapterSubscriptions	CallWithChatAdapterでサブスクライブできる通話イベントとチャットイベント。
CallWithChatAdapterUiState	CallWithChatCompositeに関連する UI 状態。
CallWithChatClientState	CallWithChatComposite を駆動するバックエンドサービスからの状態。
CallWithChatCompositeLoaderProps	アプリケーションで使用できる CallWithChatComposite の props。 2つのオプションバッグが含まれています。 adapterOptions: AzureCommunicationCallAdapterOptions のオプション callCompositeOptions: CallWithChatComposite CallWithChatCompositeOptions のオプション
CallWithChatCompositeProps	CallWithChatComposite に必要なプロパティ
CallWithChatCompositeStrings	CallWithChatComposite によって使用される文字列直接。この文字列は、コンポーネントライブラリのコンポーネントで使用される文字列に加えて使用されます。
CallWithChatControlOptions	チャットエクスペリエンスでの通話のコントロールバーのカスタマイズオプション。
CallingHandlers	コンポーネントの呼び出しに必要なすべてのハンドラーを含むオブジェクト。このパッケージから関連コンポーネントを呼び出すと、このオブジェクトから関連するハンドラーを選択できます。 usePropsFor の <xref:useHandlers> とを参照してください。
CallingTheme	このライブラリ内の関連コンポーネントを呼び出すことによって使用されるカスタム Fluent テーマパレット。
CameraButtonContextualMenuStyles	CameraButton メニューのスタイル。
CameraButtonProps	CameraButton コンポーネントのプロパティ。
CameraButtonStrings	オーバーライドできる CameraButton の文字列。
CameraButtonStyles	CameraButton のスタイル
CapabilitiesFeatureState	状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>
CapabilityChangedNotificationStrings	機能変更通知の文字列
CaptionLanguageStrings	キャプションの言語文字列キャプション設定モーダル
CaptionsBannerProps	CaptionsBanner コンポーネントプロパティ。
CaptionsBannerStrings	キャプションバナーの文字列
CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps	CaptionsSettingsModal コンポーネントプロパティ。
CaptionsSettingsModalStrings	キャプションの文字列モーダルの設定
ChatAdapterSubscribers	サブスクライブできるチャット複合イベント。
ChatAdapterThreadManagement	現在のチャットスレッドを管理するための機能。
ChatCompositeLoaderProps	アプリケーションで使用できる ChatComposite の props。 ChatComposite ChatCompositeOptions のオプションが含まれます。
ChatCompositeProps	ChatCompositeの Props 。
ChatCompositeStrings	ChatComposite によって使用される文字列直接。この文字列は、コンポーネントライブラリのコンポーネントで使用される文字列に加えて使用されます。
ChatMessage	チャットメッセージ。
CommonCallAdapter	CallComposite アダプターインターフェイスをします。
CommonCallingHandlers	コンポーネントの呼び出しに必要なすべてのハンドラーを含むオブジェクト。このパッケージから関連コンポーネントを呼び出すと、このオブジェクトから関連するハンドラーを選択できます。 usePropsFor の <xref:useHandlers> とを参照してください。
ComponentLocale	このライブラリからエクスポートされるすべてのコンポーネントのロケール情報。
ComponentStrings	このライブラリからエクスポートされたすべてのコンポーネントで使用される文字列。
CompositeLocale	このライブラリからエクスポートされるすべての複合のロケール情報。
CompositeStrings	複合で直接使用される文字列。これらの文字列は、含まれているコンポーネントではなく、複合で直接使用されます。
ConferencePhoneInfo	会議の電話情報に関する情報
ContentSystemMessage	アービタリコンテンツを含むシステムメッセージ。
ControlBarButtonProps	ControlBarButtonの Props です。
ControlBarButtonStrings	オーバーライドできる ControlBarButton の文字列。
ControlBarProps	ControlBarのプロパティ。
CreateVideoStreamViewResult	ローカルまたはリモート VideoStream の作成後に返されるオブジェクト。これには、ストリームのレンダリングを操作するためのヘルパー関数が含まれています。
CustomCallControlButtonCallbackArgs	CustomCallControlButtonCallback の引数。
CustomCallControlButtonProps	CustomCallControlButtonCallback からの応答。 ControlBarButton または <xref:DrawerMenuItem> をレンダリングするために必要な基本プロパティが含まれています。
CustomCallControlButtonStrings	CustomCallControlButtons の文字列
CustomMessage	カスタムメッセージの種類。カスタムメッセージは既定ではレンダリングされませんが、アプリケーションはカスタムレンダラーを提供できます。
DevicesButtonContextualMenuStyles	DevicesButton メニューのスタイル。
DevicesButtonProps	DevicesButtonの Props。
DevicesButtonStrings	オーバーライドできる DevicesButton の文字列。
DevicesButtonStyles	[デバイス] ボタンのメニュー項目のスタイル。
DiagnosticsCallFeatureState	<xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>の状態のみのプロキシ。
DialpadProps	Dialpad コンポーネントのプロップ。
DialpadStrings	上書きできる Dialpad の文字列。
DialpadStyles	ダイヤルパッドコンポーネントのスタイル。
Disposable	複合を正しく破棄するための機能。
DtmfDialPadOptions	CallComposite の dtmfDialer のレンダリング動作を決定するオプション
EndCallButtonProps	EndCallButtonの Props です。
EndCallButtonStrings	オーバーライドできる EndCallButton の文字列。
ErrorBarProps	ErrorBarのプロパティ。次に加えて、ErrorBar は、すべての <xref:%40fluentui%2Freact%23IMessageBarProps> を基になる <xref:%40fluentui%2Freact%23MessageBar>に転送します。
ErrorBarStrings	ErrorBarの UI に表示されるすべての文字列。
FluentThemeProviderProps	FluentThemeProviderの Props。
GridLayoutProps	GridLayoutのプロパティ。
GridLayoutStyles	GridLayout コンポーネントスタイル。
HoldButtonProps
HoldButtonStrings	保留ボタンのラベルの文字列
HorizontalGalleryStyles	コンポーネントスタイルを <xref:HorizontalGallery> します。
ImageOverlayProps	ImageOverlay のプロップ。
ImageOverlayStrings	オーバーライドできる ImageOverlay の文字列。
IncomingCallNotificationProps	着信通知コンポーネントのプロパティ。
IncomingCallNotificationStrings	着信通知コンポーネントの文字列。
IncomingCallNotificationStyles	着信通知コンポーネントのスタイル。
IncomingCallStackCall	アクティブな着信コールを表します。
IncomingCallStackProps	IncomingCallManager コンポーネントの props です。
IncomingCallState	<xref:%40azure%2Fcommunication-calling%23IncomingCall>の状態のみバージョン。 StatefulCallClient は、着信呼び出しを自動的に検出し、StatefulCallClient によって公開されている状態状態に追加します。
InlineImage	UI に反映されている InlineImage の状態。
InlineImageOptions	インラインイメージシナリオでインラインイメージを表示するオプション。
JoinCallOptions	通話参加時のマイクとカメラの状態設定オプション true = 通話参加時にデバイスをオンにする false = 通話参加時にデバイスの電源を切る 'keep'/undefined = デバイスの通話前の状態を保持する
JumpToNewMessageButtonProps	<xref:MessageThreadProps.onRenderJumpToNewMessageButton>の引数です。
LocalVideoCameraCycleButtonProps
LocalVideoStreamState	<xref:%40azure%2Fcommunication-calling%23LocalVideoStream>の状態のみバージョン。
LocalVideoStreamVideoEffectsState	LocalVideoStream の <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>のみのバージョンを示します。
LocalVideoTileOptions	通話コンポジットのローカルビデオタイルのオプション。
MediaAccessState	メディアアクセスの状態
MediaDiagnosticsState	<xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>の状態のみのプロキシ。
MeetingConferencePhoneInfoModalStrings	電話情報モーダルの文字列
MessageCommon	すべてのメッセージの種類の共通プロパティ。
MessageStatusIndicatorProps	MessageStatusIndicatorの Props。
MessageStatusIndicatorStrings	オーバーライドできる MessageStatusIndicator の文字列。
MessageThreadStrings	オーバーライドできる MessageThread の文字列。
MessageThreadStyles	MessageThreadの Fluent スタイル。
MicrophoneButtonContextualMenuStyles	MicrophoneButton メニューのスタイル。
MicrophoneButtonProps	MicrophoneButtonのプロパティ。
MicrophoneButtonStrings	オーバーライドできる MicrophoneButton の文字列。
MicrophoneButtonStyles	MicrophoneButton のスタイル
NetworkDiagnosticsState	<xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>の状態のみのプロキシ。
NotificationOptions	コンポジット内の通知を制御するためのオプション。
NotificationProps	通知の小道具。
NotificationStackProps	NotificationStack の小道具。
NotificationStackStrings	UI の NotificationStack に表示される可能性のあるすべての文字列。
NotificationStrings	通知の UI に表示される可能性のあるすべての文字列。
NotificationStyles	通知コンポーネントのスタイル。
OptimalVideoCountFeatureState	最適なビデオ数機能 <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>のステートのみのバージョン。
OptionsDevice	DevicesButton ポップアップ内のデバイス (カメラ、マイク、スピーカーなど)。
OutboundCallCompositeLoaderProps	アプリケーションで使用できる OutboundCallComposite の props。 2つのオプションバッグが含まれています。 adapterOptions: のオプション useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs \| AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) callCompositeOptions: CallComposite CallCompositeOptions のオプション
PPTLiveCallFeatureState	<xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>の状態のみバージョン。 StatefulCallClient は、通話でpptLiveを自動的にリッスンし、それに応じてStatefulCallClient によって公開された状態を更新します。
ParticipantAddedSystemMessage	参加者がチャットスレッドに追加されたことを通知するシステムメッセージ。
ParticipantItemProps	ParticipantItemの Props。
ParticipantItemStrings	オーバーライドできる ParticipantItem の文字列。
ParticipantItemStyles	ParticipantItemの Fluent スタイル。
ParticipantListItemStyles	ParticipantList ParticipantItemのスタイル。
ParticipantListStyles	ParticipantListのスタイル。
ParticipantRemovedSystemMessage	参加者がチャットスレッドから削除されたことを通知するシステムメッセージ。
ParticipantsButtonContextualMenuStyles	ParticipantsButton メニューのスタイル。
ParticipantsButtonProps	ParticipantsButtonの Props です。
ParticipantsButtonStrings	オーバーライドできる ParticipantsButton の文字列。
ParticipantsButtonStyles	ParticipantsButtonのスタイルプロパティ。
RaiseHandButtonProps	RaiseHandButton のプロップ。
RaiseHandButtonStrings	オーバーライドできる RaiseHandButton の文字列。
RaiseHandCallFeature	<xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>の状態のみバージョン。 StatefulCallClient は、通話で挙がったハンドを自動的にリッスンし、それに応じて StatefulCallClient によって公開される状態を更新します。
ReactionButtonProps	ReactionButton のプロップ。
ReactionButtonStrings	オーバーライドできる ReactionButton の文字列。
ReactionResources	アニメーションスプライト画像と関連メタデータのインターフェース
RealTimeTextCallFeatureState
RealTimeTextInfo
RealTimeTextModalProps	RealTimeTextModal コンポーネントの小道具。
RealTimeTextModalStrings	realTimeText モーダルの文字列
RealTimeTextProps	RealTimeText の 1 行の小道具。
RealTimeTextStrings	RTTの文字列
RecordingCallFeature	<xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>の状態のみバージョン。 StatefulCallClient は、呼び出しの記録状態を自動的にリッスンし、それに応じて StatefulCallClient によって公開されている状態を更新します。
RemoteParticipantState	<xref:%40azure%2Fcommunication-calling%23RemoteParticipant>の状態のみバージョン。 StatefulCallClient は、RemoteParticipants を自動的に取得し、StatefulCallClientによって公開されている状態に状態を追加します。
RemoteVideoStreamState	<xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>の状態のみバージョン。
RemoteVideoTileMenuOptions	VideoGallery のリモートビデオタイルのメニューオプション。
ScreenShareButtonProps	ScreenShareButtonの Props です。
ScreenShareButtonStrings	オーバーライドできる ScreenShareButton の文字列。
SendBoxProps	SendBoxの Props。
SendBoxStrings	オーバーライド可能 SendBox の文字列。
SendBoxStylesProps	<xref:Sendbox>の Fluent スタイル。
SpokenLanguageStrings	モーダルを設定するキャプションの音声言語文字列
SpotlightCallFeatureState	状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>
SpotlightPromptStrings	スポットライトに関連するプロンプトで使用される文字列
SpotlightState	スポットライトの状態と順序
StartCaptionsAdapterOptions	adapter.startCaptions に渡されるオプション
StartCaptionsButtonProps
StartCaptionsButtonStrings	保留ボタンのラベルの文字列
StartRealTimeTextButtonProps	StartRealTimeTextButton コンポーネントの props
StartRealTimeTextButtonStrings	保留ボタンのラベルの文字列
StatefulCallClient	CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> をステートフルに使用できるようにするメソッドを定義します。インターフェイスは、プロキシされた状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。状態定義については、CallClientState 参照してください。状態変更イベントは、次の方法で実行されます。 <xref:%40azure%2Fcommunication-calling%23DeviceManager> API から返されたデータ。 <xref:%40azure%2Fcommunication-calling%23CallAgent> API から返されたデータ。リスナーは、さまざまな Azure 通信呼び出し元オブジェクトに自動的にアタッチされます。 CallAgent '着信コール' CallAgent 'callsUpdated' デバイスマネージャ 'videoDevicesUpdated' DeviceManager 'audioDevicesUpdated デバイスマネージャー 'selectedMicrophoneChanged' DeviceManager 'selectedSpeakerChanged' 'stateChanged' を呼び出す 'idChanged' を呼び出す 'isMutedChanged' を呼び出す 'isScreenSharingOnChanged' を呼び出す 'remoteParticipantsUpdated' を呼び出す 'localVideoStreamsUpdated' を呼び出す着信コール 'callEnded' RemoteParticipant '状態が変更されました' RemoteParticipant 'isMutedChanged' RemoteParticipant 'displayNameChanged' RemoteParticipant 'isSpeakingChanged' RemoteParticipant 'videoStreamsUpdated' RemoteVideoStream 'isAvailableChanged' TranscriptionCallFeature 'isTranscriptionActiveChanged' RecordingCallFeature 'isRecordingActiveChanged' LocalRecordingCallFeature 'isLocalRecordingActiveChanged' RaiseHandCallFeature 'raisedHandEvent' RaiseHandCallFeature 'loweredHandEvent' PPTLiveCallFeature 'isAciveChanged' ReactionCallFeature 'reaction'
StatefulChatClient	{@Link @azure/communication-chat#ChatClient}を一元的に生成された状態で使用できるようにするメソッドを定義します。インターフェイスは、プロキシされた状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。
StatefulDeviceManager	<xref:%40azure%2Fcommunication-calling%23DeviceManager>の上にステートフルによって追加される追加のメソッドを定義します。
StopCaptionsAdapterOptions	adapter.stopCaptions に渡されるオプション
StreamMediaProps	StreamMediaの Props。
SurveyIssues	各通話問題に対応するテキスト
SurveyIssuesHeadingStrings	各通話問題カテゴリに対応するテキスト
SystemMessageCommon	すべてのシステムメッセージの共通プロパティ。
TeamsCallAdapter	CommonCallAdapter を拡張する Teams ID に固有のアダプターインターフェイス。
TeamsCallingHandlers	コンポーネントの呼び出しに必要なすべてのチームコールハンドラを含むオブジェクト。このパッケージから関連コンポーネントを呼び出すと、このオブジェクトから関連するハンドラーを選択できます。 usePropsFor の <xref:useHandlers> とを参照してください。
TeamsIncomingCallState	状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall>
TogetherModeCallFeatureState	<xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>の状態のみバージョン。 StatefulCallClient です。 Together Mode 機能の状態を表します。
TogetherModeSeatingPositionState	<xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>の状態のみバージョン。 Together Modeの参加者の着座位置を表します。
TogetherModeStreamOptions	Together Mode ストリームビューの結果を表すインターフェイス。
TogetherModeStreamViewResult	Together Mode ストリームビューの結果を表すインターフェイス。
TogetherModeStreamsState	Together モードのストリームを表します。
TopicUpdatedSystemMessage	チャットスレッドトピックが更新されたことを通知するシステムメッセージ。
TranscriptionCallFeature	<xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>の状態のみバージョン。 StatefulCallClient は、呼び出しの文字起こし状態を自動的にリッスンし、それに応じて StatefulCallClient によって公開されている状態を更新します。
TransferFeature	転送フィーチャの状態
TypingIndicatorProps	TypingIndicatorの Props。
TypingIndicatorStrings	オーバーライドできる TypingIndicator の文字列。
TypingIndicatorStylesProps	TypingIndicatorの Fluent スタイル。
VerticalGalleryControlBarStyles	VerticalGallery コンポーネント内のコントロールバーのスタイル
VerticalGalleryStrings	垂直ギャラリーのローカリゼーション用の文字列。
VerticalGalleryStyles	VerticalGallery コンポーネントのスタイル
VideoBackgroundBlurEffect	ぼかしビデオの背景効果の属性が含まれています
VideoBackgroundImage	URL、名前などの背景画像の属性が含まれています。
VideoBackgroundNoEffect	ビデオの背景効果を削除するための属性が含まれています
VideoBackgroundReplacementEffect	選択した置換ビデオ背景効果の属性が含まれます
VideoGalleryLocalParticipant	VideoGallery内のローカル参加者の状態。
VideoGalleryProps	VideoGallery用の小道具。
VideoGalleryRemoteParticipant	VideoGalleryのリモート参加者の状態。
VideoGalleryStream	VideoGalleryの参加者のビデオストリーム。
VideoGalleryStrings	VideoGalleryの UI に表示されるすべての文字列。
VideoGalleryStyles	VideoGallery コンポーネントスタイルをします。
VideoGalleryTogetherModeSeatingInfo	Together Modeの座席情報を表すインターフェース。
VideoGalleryTogetherModeStreams	Together モードでストリームを表すインターフェイス。
VideoStreamOptions	ビデオストリームのレンダリング方法を制御するオプション。
VideoStreamRendererViewState	<xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>の状態のみバージョン。このプロパティは、createView をして StatefulCallClient 公開された状態に追加され、disposeView によって削除。
VideoTileContextualMenuProps	VideoGallery でリモート VideoTile コンポーネントのコンテキストメニューを表示するためのプロパティ。
VideoTileDrawerMenuProps	リモート VideoTile のロングタッチでドロワーメニューを表示するためのプロパティ VideoGalleryのロングタッチ。
VideoTileProps	VideoTileの Props。
VideoTileStrings	オーバーライドできる VideoTile の文字列。
VideoTileStylesProps	VideoTileの Fluent スタイル。
VideoTilesOptions	VideoGallery のすべてのビデオタイルに適用されるオプション

型エイリアス

AdapterErrors	アダプターは、各操作の最新のエラーを状態に格納します。 `target` は、アダプターによって実行される一意の操作ごとにアダプター定義の文字列です。
AdapterNotifications	アダプターは、各ターゲットの最新の通知を格納します。
AreEqual	2 つの反応成分が完全に等しいかどうかを比較します。結果の種類は true/false になります
AreParamEqual	2つの反応成分のプロップが等しいかどうかを比較すると、結果の型は true/false になります
AreTypeEqual	2 つの型が等しいかどうかを比較すると、結果の型は true/false になります
AvatarPersonaData	ユーザーのアバターを表示するためのカスタムデータ属性。
AvatarPersonaDataCallback	ユーザーのアバターを作成するためのカスタムデータを提供するために使用されるコールバック関数。
AzureCommunicationCallAdapterArgs	CallAdapterの Azure Communication Services 実装を作成するための引数。注: `displayName` は最大 256 文字です。
AzureCommunicationCallAdapterOptions	作成するオプションのパラメーター useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs \| AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
AzureCommunicationCallWithChatAdapterArgs	createAzureCommunicationCallWithChatAdapter の引数
AzureCommunicationCallWithChatAdapterFromClientArgs	<xref:createAzureCommunicationCallWithChatAdapterFromClient> の引数
AzureCommunicationChatAdapterArgs	ChatAdapterの Azure Communication Services 実装を作成するための引数。
AzureCommunicationOutboundCallAdapterArgs	CallAdapterの Azure Communication Services 実装を作成するための引数。これらの引数は、発信通話シナリオを作成するために使用されます。注: `displayName` は最大 256 文字です。
CallAdapterCallEndedEvent	終了した呼び出しの詳細含む CallEndedListener のペイロード。
CallAdapterClientState	CommonCallAdapter 状態は、Azure Communication Services バックエンドから推論されます。
CallAdapterLocator	createAzureCommunicationCallAdapter によって使用されるロケーター参加する呼び出しを検索する
CallAdapterState	CommonCallAdapter 状態をします。
CallAdapterUiState	純粋な UI 目的で CommonCallAdapter 状態をします。
CallCompositeIcons	CallCompositeでオーバーライドできるアイコン。
CallCompositeOptions	CallCompositeのオプション機能。
CallCompositePage	CallCompositeに表示される主要な UI 画面。
CallControlDisplayType	CallCompositeのコントロールバーの表示の種類。
CallControlOptions	呼び出しエクスペリエンスのコントロールバーのカスタマイズオプション。
CallEndedListener	CallAdapterSubscribers 'callEnded' イベントのコールバック。
CallErrorBarSelector	ErrorBar コンポーネントセレクターの種類。
CallErrorTarget	{@Link CallErrors} で許容されるすべてのキーの文字列リテラル型。
CallErrors	呼び出し元 SDK への API 呼び出しからのエラー。オブジェクト内の各プロパティには、特定の SDK API メソッドに関する最新のエラーが格納されます。このオブジェクトのエラーは、<xref:newClearCallErrorsModifier>を使用してクリアできます。さらに、エラーは次の場合に自動的にクリアされます。状態がクリアされます。関連する API メソッドの後続の呼び出しは成功します。エラーが自動的にクリアされるタイミングの詳細については、個々のステートフルクライアントメソッドのドキュメントを参照してください。
CallFeatureStreamName	通話機能ストリームの名前を表します
CallIdChangedListener	CallAdapterSubscribers 'callIdChanged' イベントのコールバック。
CallNotifications
CallParticipantListParticipant	UI コンポーネントに反映された参加者の状態を呼び出します。
CallWithChatCompositeIcons	CallWithChatComposite オーバーライドできるアイコン。
CallWithChatCompositeOptions	CallWithChatCompositeのオプション機能。
CallWithChatEvent	CallWithChatAdapterによって発生したイベント。
CallingBaseSelectorProps	宣言型クライアントの状態の呼び出しを参照するために使用される一般的なプロパティ。
CallingHandlersOptions	ビデオエフェクトの背景の依存関係を含めるための設定オプション。
CallingReturnProps	usePropsForのヘルパー型。
CallingSounds	さまざまな呼び出しイベントに使用するサウンドのセットを表すための型
CameraButtonSelector	CameraButton コンポーネントのセレクターの種類。
CancelEditCallback	コールバック関数は、メッセージの編集がキャンセルされたときに実行されます。
CapabilitiesChangedListener	CallAdapterSubscribers 'capabilitiesChanged' イベントのコールバック。
CaptionSettingsSelector	キャプション言語と音声言語を変更するためのコンポーネントのセレクタータイプ
CaptionsBannerSelector	CaptionsBanner コンポーネントのセレクタタイプ。
CaptionsInformation	キャプションの各行に必要な情報
CaptionsOptions	キャプションを開始するオプションバッグ
CaptionsReceivedListener	CallAdapterSubscribers 'captionsReceived' イベントのコールバック。
ChatAdapter	ChatComposite アダプターインターフェイスをします。
ChatAdapterOptions	ChatAdapter を構成するためのオプション。
ChatAdapterState	ChatAdapter 状態をします。
ChatAdapterUiState	純粋な UI 目的で ChatAdapter 状態をします。
ChatAttachmentType	アタッチメントのタイプを表します
ChatBaseSelectorProps	ChatClientStateのセレクターの一般的なプロパティ。
ChatClientProviderProps	ChatClientProviderを初期化する引数。
ChatClientState	<xref:%40azure%2Fcommunication-chat%23ChatClient>の一元化された状態。
ChatCompositeClientState	ChatAdapter 状態は、Azure Communication Services バックエンドから推論されます。
ChatCompositeIcons	ChatComposite オーバーライドできるアイコン。
ChatCompositeOptions	ChatCompositeのオプション機能。
ChatErrorBarSelector	ErrorBar コンポーネントセレクターの種類。
ChatErrorTarget	ChatErrors内のすべての許容キーの文字列リテラル型。
ChatErrors	チャット SDK への API 呼び出しからのエラー。オブジェクト内の各プロパティには、特定の SDK API メソッドに関する最新のエラーが格納されます。
ChatHandlers	チャットコンポーネントに必要なすべてのハンドラーを含むオブジェクト。このパッケージのチャット関連コンポーネントは、このオブジェクトから関連するハンドラーを選択できます。 usePropsFor の <xref:useHandlers> とを参照してください。
ChatInitializedListener	'chatInitialized' イベントのコールバック <xref:CallWithChatAdapterSubscribers> 。
ChatMessageWithStatus	チャットメッセージのクライアント側のみのメタデータを格納する <xref:%40azure%2Fcommunication-chat%23ChatMessage> の拡張機能。 TODO: 名前がビットロットされています。名前を変更します。
ChatParticipantListSelector	ParticipantList コンポーネントのセレクターの種類。
ChatProfile	ユーザーまたはボットのプロファイル。
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 つの型の交差する型を返します
CommonCallAdapterOptions	useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs \| AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) または TeamsCallAdapter を作成するための一般的な省略可能なパラメーター
CommonCallControlOptions	呼び出しエクスペリエンスのコントロールバーのカスタマイズオプション。
CommonProperties	2 種類の交差プロパティを返す
CommunicationParticipant	UI に反映されたチャットまたは通話参加者の状態。
ComponentIcons	このライブラリからエクスポートされた React コンポーネントによって使用されるアイコン。
ComponentProps	usePropsForのヘルパー型。
ComponentSlotStyle	ComponentSlotStyle は @fluentui/react-northstar 型です。このパッケージから離れるにつれて、相互運用性のためにfluentのより一般的なIRawStyleタイプを使用しました。
CompositeIcons	このライブラリによってエクスポートされた複合のいずれかでオーバーライドできるアイコン。詳細なターゲット型については、「ChatCompositeIcons 、CallCompositeIcons、および CallWithChatCompositeIcons を参照してください。
ControlBarButtonStyles	すべての ControlBarButton 実装のスタイル。
ControlBarLayout	ControlBarのレイアウトを表示します。
CreateDefaultCallingHandlers	createDefaultCallingHandlers のタイプ。
CreateViewResult	createView から結果返します。
CustomAvatarOptions	アバター (`onRender`) コンポーネントをカスタマイズするために `Persona` 関数に挿入できるオプション。
CustomCallControlButtonCallback	カスタムの ControlBarButton と Control <xref:DrawerMenuItem> をレンダリングするための props を返すコールバック。応答は、カスタムボタンを配置する場所を示します。パフォーマンスに関するヒント: このコールバックは、コールバックまたはその引数が変更されたときにのみ呼び出されます。
CustomCallControlButtonPlacement	<xref:CommonCallControlBar>に挿入されるカスタムボタンの配置。 'primary': ボタンを中央のコントロールバーの右端、EndCallButton の前 (rtl モードの左端) に配置します。 'overflow': オーバーフローメニューの最後にボタンを配置します。 'secondary':ボタンをサイドコントロールバーの左端(rtlモードでは右)に配置します。同じ配置が割り当てられた複数のボタンが順番に追加されます。たとえば、2 つのボタンが 'secondary' に配置されている場合、それらは両方とも指定された順序で左端 (rtl モードの右端) に表示されます。「プライマリ」配置のみが、コールコンポジットで従来のコール制御が有効になっている場合に機能します
DeclarativeCallAgent	`DeclarativeCallAgent` extends とプロキシ <xref:%40azure%2Fcommunication-calling%23CallAgent>
DeclarativeTeamsCallAgent	`DeclarativeTeamsCallAgent` extends とプロキシ <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>
DeepNoiseSuppressionEffectDependency	ディープノイズ抑制のために注入される依存関係タイプ
DeviceManagerState	この型は、<xref:%40azure%2Fcommunication-calling%23DeviceManager>内のすべての状態をカプセル化するためのものです。省略可能なパラメーターの場合、ユーザーがアクセス許可を付与するまで使用できない場合があります。対応する <xref:%40azure%2Fcommunication-calling%23DeviceManager>'s getCameras、getMicrophones、getSpeakers、askDevicePermission API が呼び出されて完了するまで、カメラ、マイク、スピーカー、deviceAccess の状態は空になります。
DevicesButtonSelector	DevicesButton コンポーネントのセレクターの種類。
DiagnosticChangedEventListner	CallAdapterSubscribers 'diagnosticChanged' イベントのコールバック。
DialpadMode	ダイヤルパッドコンポーネントのモード。
DisplayNameChangedListener	CallAdapterSubscribers 'displayNameChanged' イベントのコールバック。
DtmfTone	PSTN 通話の DTMF トーン。
EmptySelector	データを返さない簡易セレクターの型。データを必要としないコンポーネント usePropsFor が呼び出された場合は、既定の戻り値として使用されます。
ErrorType	ErrorBarに表示できるすべてのエラー。
GetCallingSelector	特定のコンポーネントに適用できるセレクターの特定の種類。
GetChatSelector	特定のコンポーネントに適用できるセレクターの特定の種類。
HoldButtonSelector	HoldButton コンポーネントのセレクタタイプ。
IncomingCallManagement	これには、すべてのアクティブな `incomingCalls`を返す読み取り専用の配列が含まれています。アクティブな着信コールとは、応答されていない、拒否されていない、または切断されていないコールです。
IncomingCallStackSelector	アクティブな着信コールと削除された着信コールを取得するセレクタ。
IsCaptionLanguageChangedListener	CallAdapterSubscribers 'isCaptionLanguageChanged' イベントのコールバック。
IsCaptionsActiveChangedListener	CallAdapterSubscribers 'isCaptionsActiveChanged' イベントのコールバック。
IsLocalScreenSharingActiveChangedListener	'isLocalScreenSharingActiveChanged' イベント CallAdapterSubscribers のコールバック。
IsMutedChangedListener	CallAdapterSubscribers 'isMuted' イベントのコールバック。
IsSpeakingChangedListener	CallAdapterSubscribers 'isSpeakingChanged' イベントのコールバック。
IsSpokenLanguageChangedListener	CallAdapterSubscribers 'isSpokenLanguageChanged' イベントのコールバック。
LoadingState	ストリームが読み込まれているかどうか。
LocalScreenShareView
LocalVideoTileSize	ローカルビデオタイルのさまざまなモード
LocalizationProviderProps	LocalizationProviderの Props。
LongPressTrigger	ロングプレスハンドラーをティガーする方法のモード。
MediaAccess	オーディオ/ビデオメディアアクセスの状態
MediaDiagnosticChangedEvent	DiagnosticChangedEventListner のペイロード。メディア診断に変更があります。
Message	すべてのメッセージの判別共用体。 `messageType` フィールドは、和集合バリアントに特化しています。
MessageAttachedStatus	チャットメッセージをメッセージの前後にマージして表示するかどうかを指定します。 `true`場合、メッセージはその前のメッセージとグループ化されて表示されます。 'top' と 'bottom' は、メッセージがグループの開始または終了であることを示すために使用されます。
MessageContentType	サポートされている種類のチャットメッセージコンテンツ。
MessageDeletedListener	ChatAdapterSubscribers 'messageDeleted' イベントのコールバック。
MessageEditedListener	ChatAdapterSubscribers 'messageEdited' イベントのコールバック。
MessageProps	1 つのメッセージをレンダリングするためのプロパティ。 MessageRenderer 参照してください。
MessageReadListener	ChatAdapterSubscribers 'messageRead' イベントのコールバック。
MessageReceivedListener	ChatAdapterSubscribers 'messageReceived' イベントのコールバック。
MessageRenderer	1 つのメッセージをレンダリングするコンポーネント。
MessageSentListener	ChatAdapterSubscribers 'messageSent' イベントのコールバック。
MessageStatus	送信されたメッセージのクライアント側の状態。メッセージ配信がバックエンドから確認される前に発生する遷移状態が含まれます。
MessageThreadProps	MessageThreadの Props です。
MessageThreadSelector	MessageThread コンポーネントセレクターの種類。
MicrophoneButtonSelector	MicrophoneButton コンポーネントセレクターの種類。
NetworkDiagnosticChangedEvent	ネットワーク診断に変更がある DiagnosticChangedEventListner のペイロード。
NotificationStackSelector	通知コンポーネントのセレクタタイプ。
NotificationTarget
NotificationType	NotificationStack に表示できるすべての通知。
OnFetchChatProfileCallback	ユーザーまたはボットのプロファイルを作成するためのカスタムデータを提供するために使用されるコールバック関数。
OnFetchProfileCallback	ユーザーまたはボットのプロファイルを作成するためのカスタムデータを提供するために使用されるコールバック関数。
OnRenderAvatarCallback	ユーザーが Persona コンポーネントのレンダリングをカスタマイズできるようにする、カスタムレンダリングされたコールバック。
OverflowGalleryPosition	VideoGalleryのオーバーフローギャラリーのさまざまなモードと位置
ParticipantListParticipant	ParticipantListに表示される参加者。
ParticipantListProps	ParticipantListの Props。
ParticipantListSelector	ParticipantList コンポーネントのセレクターの種類。
ParticipantMenuItemsCallback	ParticipantList内の各参加者にカスタムメニュー項目を提供するためのコールバック。
ParticipantState	通話参加者の接続状態。
ParticipantsAddedListener	ChatAdapterSubscribers 'participantsAdded' イベントのコールバック。
ParticipantsButtonSelector	ParticipantsButton コンポーネントのセレクターの種類。
ParticipantsJoinedListener	CallAdapterSubscribers 'participantsJoined' イベントのコールバック。
ParticipantsLeftListener	CallAdapterSubscribers 'participantsLeft' イベントのコールバック。
ParticipantsRemovedListener	ChatAdapterSubscribers 'participantsRemoved' イベントのコールバック。
Profile	ユーザーまたはボットのプロファイル。
RaiseHandButtonSelector	RaiseHandButton コンポーネントのセレクターの種類。
RaisedHand	手を上げた状態と順番
RaisedHandState	手を上げた状態と順番
Reaction	レンダリングする反応タイプを持つ反応状態
ReactionButtonReaction	リアクションボタンのリアクションタイプ
ReactionSprite	アニメーション、スプライト、画像、および関連するメタデータのタイプ
ReactionState	UI ヘルパーの小道具が receivedOn の <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> のみのバージョンを示します。 UI がそれに応じて反応をレンダリングすることを決定するのに役立つタイムスタンプ付きの反応状態。
ReadReceiptsBySenderId	各送信者の表示名と最後の読み取りメッセージを格納するキー値ペアの配列
RealTimeTextInformation	リアルタイムテキストの各行に必要な情報
RealTimeTextReceivedListener	CallAdapterSubscribers 'realTimeTextReceived' イベントのコールバック。
ResourceDetails	キャッシュするリソースをダウンロードするために必要な詳細。
ResourceFetchResult	ステートフルクライアントからダウンロードされたリソースの結果
ScreenShareButtonSelector	ScreenShareButton コンポーネントセレクターの種類。
Selector	ClientState の更新を、このライブラリの React コンポーネントのプロパティに絞り込む最適化されたセレクター。
SendBoxSelector	SendBox コンポーネントセレクターの種類。
SoundEffect	呼び出しイベントに使用するカスタムサウンドを表すためのタイプ
Spotlight	スポットライトの状態と順序
SpotlightChangedListener	CallAdapterSubscribers 'spotlightChanged' イベントのコールバック。
StartCallIdentifier	CallAdapter を使用して通話を開始するための識別子の種類
StartCaptionsButtonSelector	StartCaptionsButton コンポーネントのセレクタタイプ。
StatefulCallClientArgs	StatefulCallClient を構築するための引数。
StatefulCallClientOptions	StatefulCallClient を構築するためのオプション。
StatefulChatClientArgs	StatefulChatClientを構築するための引数。
StatefulChatClientOptions	StatefulChatClientを構築するためのオプション。
SupportedCaptionLanguage
SupportedSpokenLanguage
SystemMessage	すべてのシステムメッセージの判別共用体。 `systemMessageType` フィールドは、和集合バリアントに特化しています。
TeamsAdapterOptions	TeamsCallAdapter を作成するための省略可能なパラメーター
TeamsCallAdapterArgs	TeamsCallAdapter の Azure Communication Services 実装を作成するための引数。
TeamsCallAdapterArgsCommon	TeamsCallAdapter の Azure Communication Services 実装を作成するための args の共通部分。
TeamsIncomingCallManagement	<xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall>インターフェースをプロキシします。
TogetherModeParticipantSeatingState	Together Modeの参加者の着座位置を表します。
TopicChangedListener	ChatAdapterSubscribers 'topicChanged' イベントのコールバック。
TransferAcceptedListener	CallAdapterSubscribers 'transferRequested' イベントのコールバック。
TypingIndicatorSelector	TypingIndicator コンポーネントのセレクターの種類。
UpdateMessageCallback	コールバック関数は、メッセージが更新されたときに実行されます。
VideoBackgroundEffect	選択したビデオ背景効果の属性が含まれます
VideoBackgroundEffectsDependency	ビデオの背景効果に挿入される依存関係の種類
VideoGalleryLayout
VideoGalleryParticipant	VideoGalleryの参加者の状態。
VideoGallerySelector	VideoGallery コンポーネントセレクターの種類。
VideoGalleryTogetherModeParticipantPosition	Together Modeでの参加者の位置を表すインターフェース。
ViewScalingMode	VideoGalleryStreamのスケーリングモード。

関数

CallAgentProvider(CallAgentProviderProps)	<xref:React.Context>を格納する <xref:%40azure%2Fcommunication-calling%23CallAgent>。このパッケージから呼び出すコンポーネントは、CallAgentProviderでラップする必要があります。
CallClientProvider(CallClientProviderProps)	<xref:React.Context>を格納する。このパッケージからコンポーネントを呼び出すには、CallClientProviderでラップする必要があります。
CallComposite(CallCompositeProps)	呼び出しエクスペリエンス用のカスタマイズ可能な UI 複合。
CallProvider(CallProviderProps)	<xref:React.Context>を格納する <xref:%40azure%2Fcommunication-calling%23Call>。このパッケージからの呼び出し元コンポーネントは、CallProviderでラップする必要があります。
CallWithChatComposite(CallWithChatCompositeProps)	CallWithChatComposite は主要なコンポーネントをまとめ、すぐにチャットエクスペリエンスを提供する完全な通話を提供します。
CameraButton(CameraButtonProps)	カメラのオン/オフを切り替えるボタン。 ControlBarで使用できます。
CaptionsBanner(CaptionsBannerProps)	ユーザーアイコン、displayName、およびキャプションテキストを含むCaptionsBannerを表示するためのコンポーネント。
CaptionsSettingsModal(CaptionsSettingsModalProps)	音声言語を設定するためのコンポーネント
ChatClientProvider(ChatClientProviderProps)	<xref:React.Context>を格納する。このパッケージのチャットコンポーネントは、ChatClientProviderでラップする必要があります。
ChatComposite(ChatCompositeProps)	チャットエクスペリエンス用のカスタマイズ可能な UI 複合。
ChatThreadClientProvider(ChatThreadClientProviderProps)	<xref:React.Context>を格納する <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>。このパッケージのチャットコンポーネントは、ChatThreadClientProviderでラップする必要があります。
ControlBar(ControlBarProps)	呼び出しコントロールのさまざまなボタンのコンテナー。このライブラリ内のさまざまな呼び出しコントロールボタン (CameraButton、または ControlBarButton の独自のインスタンスなど) を直接使用。
ControlBarButton(ControlBarButtonProps)	ControlBarの既定のボタンスタイル。このコンポーネントを使用して、UI ライブラリによって提供される他のボタンと同じスタイルのカスタムボタンを作成します。
DevicesButton(DevicesButtonProps)	デバイスオプションを制御するメニューを開くボタン。 ControlBarで使用できます。
Dialpad(DialpadProps)	ユーザーがダイヤルパッドをクリック/キーボードを使用して電話番号を入力できるようにするコンポーネント安定したビルドでは空のコンポーネントを返します
EndCallButton(EndCallButtonProps)	進行中の通話を終了するボタン。 ControlBarで使用できます。
ErrorBar(ErrorBarProps)	UI にエラーメッセージを表示するコンポーネント。表示できるすべての文字列は、ローカライズできるように文字列として受け入れられます。アクティブエラーは、activeErrorMessages 選択されます。このコンポーネントは、ユーザーが無視した部分を内部的に追跡します。関連付けられたタイムスタンプを持つエラー: 無視された後に発生した場合、エラーは UI に再度表示されます。タイムスタンプのないエラー: エラーは、プロパティから消えるまで無視されます。エラーが繰り返し発生すると、UI に表示されます。 UI 要素 <xref:%40fluentui%2Freact%23MessageBar> 使用します。
FluentThemeProvider(FluentThemeProviderProps)	このライブラリの React コンポーネント全体に Fluent テーマを適用するプロバイダー。
GridLayout(GridLayoutProps)	通話でオーディオ/ビデオ参加者のタイルをレイアウトするコンポーネント。
HoldButton(HoldButtonProps)	進行中の通話を保留または再開するためのボタン。 ControlBar と一緒に使用できます
ImageOverlay(ImageOverlayProps)	選択した画像のフルスクリーンモーダルをレンダリングするコンポーネント。
IncomingCallNotification(IncomingCallNotificationProps)	エンドユーザーへの着信呼び出しを表すために使用される通知コンポーネント。ユーザーは着信コールを受け入れるか拒否できます。
IncomingCallStack(IncomingCallStackProps)	複数の着信通話を管理するためのラッパー
LocalizationProvider(LocalizationProviderProps)	このライブラリの React コンポーネントにローカライズされた文字列を提供するプロバイダー。
MessageStatusIndicator(MessageStatusIndicatorProps)	送信されたメッセージの状態を表示するコンポーネント。メッセージの状態に対応するアイコンとヒントを追加します。
MessageThread(MessageThreadProps)	`MessageThread` を使用すると、チャットメッセージをレンダリングしたり、新旧のメッセージのスクロール動作を処理したり、チャットスレッド内のコントロール & アイコンをカスタマイズしたりするためのコンポーネントを簡単に作成できます。
MicrophoneButton(MicrophoneButtonProps)	マイクのオン/オフを切り替えるボタン。 ControlBarで使用できます。
Notification(NotificationProps)	UI に通知メッセージを表示するコンポーネント。
NotificationStack(NotificationStackProps)	UI に通知を表示するコンポーネント。表示できるすべての文字列は、ローカライズできるように文字列として受け入れられます。アクティブな通知は、activeNotifications によって選択されます。このコンポーネントは、ユーザーが無視した部分を内部的に追跡します。タイムスタンプが関連付けられている通知: 通知が無視された後に発生した場合、通知は UI に再度表示されます。タイムスタンプがない通知: 通知は、props から消えるまで閉じられます。通知が繰り返される場合は、UI に表示されます。
ParticipantItem(ParticipantItemProps)	通話またはチャット参加者をレンダリングするコンポーネント。参加者のアバター、displayName、状態、およびオプションのアイコンとコンテキストメニューを表示します。
ParticipantList(ParticipantListProps)	すべての通話またはチャット参加者をレンダリングするコンポーネント。既定では、各参加者は ParticipantItemでレンダリングされます。オーバーライドする <xref:ParticipantListProps.onRenderParticipant> を参照してください。
ParticipantsButton(ParticipantsButtonProps)	通話またはチャットの参加者が表示されたメニューを表示するボタン。 ControlBarで使用できます。このボタンには、そのプロパティ `menuProps`によって定義されたドロップダウンメニュー項目が含まれています。既定では、完全なリストを持つリモート参加者の数をサブメニューとして表示し、すべての参加者をミュートするオプションと、通話の招待 URL をコピーするためのクリップボードへのコピーボタンを表示できます。この `menuProps` は完全に再定義でき、そのプロパティは IContextualMenuProps 型です。
RaiseHandButton(RaiseHandButtonProps)	画面共有を開始/停止するボタン。 ControlBarで使用できます。
ReactionButton(ReactionButtonProps)	リアクションを送信するボタン。 ControlBarで使用できます。
RealTimeText(RealTimeTextProps)	RealTimeTextの1行を表示するためのコンポーネント
RealTimeTextModal(RealTimeTextModalProps)	realTimeText モーダルのコンポーネント
ScreenShareButton(ScreenShareButtonProps)	画面共有を開始/停止するボタン。 ControlBarで使用できます。
SendBox(SendBoxProps)	メッセージを入力および送信するためのコンポーネント。ユーザーがテキストの入力を開始したときの入力通知の送信をサポートします。テキスト入力フィールドの下の省略可能なメッセージをサポートします。
StartCaptionsButton(StartCaptionsButtonProps)	キャプションを開始または停止するボタン ControlBar と一緒に使用できます
StartRealTimeTextButton(StartRealTimeTextButtonProps)	アクセシビリティ要件に基づいてRealTimeTextを起動するボタン、リアルタイムテキストは一度オンにするとオフにできません ControlBar と一緒に使用できます
StreamMedia(StreamMediaProps)	ビデオストリームを含む HTMLElement を JSX 要素に変換するユーティリティコンポーネント。ヘッドレス呼び出し API によって返される HTMLElement を、VideoTileとしてレンダリングできるコンポーネントに変換するために使用します。
TypingIndicator(TypingIndicatorProps)	チャットスレッド内の 1 人以上の参加者が入力しているときにローカルユーザーに通知するコンポーネント。
VideoGallery(VideoGalleryProps)	VideoGallery は、特定の通話のビデオタイルのレイアウトを表します。ローカルユーザーと、通話に参加した各リモート参加者の VideoTile が表示されます。
VideoTile(VideoTileProps)	1 人の通話参加者のビデオストリームをレンダリングするコンポーネント。 VideoGalleryで GridLayout と共に使用します。
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Azure Communication Services によってサポートされる CallAdapter を作成します。これは、このライブラリによって提供 CallAdapter の既定の実装です。注: `displayName` は最大 256 文字です。
createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)	Azure Communication Services によってサポートされる CallAdapter を作成します。これは、このライブラリによって提供 CallAdapter の既定の実装です。注: `displayName` は最大 256 文字です。
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)	指定された StatefulCallClientを使用して、CallAdapter を作成します。 StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)	指定された StatefulCallClientを使用して、CallAdapter を作成します。 StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)	Azure Communication サービスによってサポートされる CallWithChatAdapter を作成して、CallWithChatCompositeに接続します。
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	提供された StatefulChatClient と StatefulCallClient を使用して、CallWithChatAdapter作成します。 StatefulChatClient への参照を保持し、StatefulCallClient をする場合に便利です。 chatThreadClient は、StatefulChatClient が chatClient.getChatThreadClient(chatThreadId) API を使用して作成する必要があることに注意してください。よりシンプルな API createAzureCommunicationCallWithChatAdapter を使用することを検討してください。
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)	Azure Communication Services によってサポートされる ChatAdapter を作成します。これは、このライブラリによって提供 ChatAdapter の既定の実装です。
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)	提供された StatefulChatClientを使用して、ChatAdapter を作成します。 StatefulChatClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationChatAdapter を使用することを検討してください。
createDefaultCallingHandlers(StatefulCallClient, undefined \| CallAgent, undefined \| StatefulDeviceManager, undefined \| Call, CallingHandlersOptions)	チームコール用の CallingHandlers の既定の実装を作成します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)	ChatHandlersの既定の実装を作成します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。返されたオブジェクトは、React コンポーネントのプロパティとして使用する場合に再レンダリングを回避するためにメモされています。
createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })	チーム通話の TeamsCallingHandlers の既定の実装を作成します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)	ProxyCallClient を使用して CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> をプロキシすることで、StatefulCallClient <xref:ProxyCallClient> を作成し、宣言型の方法で状態にアクセスできるようにします。状態の変更を適切にプロキシするには、StatefulCallClient から取得した <xref:%40azure%2Fcommunication-calling%23DeviceManager> と <xref:%40azure%2Fcommunication-calling%23CallAgent> と <xref:%40azure%2Fcommunication-calling%23Call> (など) を使用することが重要です。
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)	ProxyChatClient を使用して ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> をプロキシすることで、ステートフル ChatClient <xref:ProxyChatClient> を作成し、宣言型の方法で状態にアクセスできるようにします。
createTeamsCallAdapter(TeamsCallAdapterArgs)
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)	提供されている StatefulCallClient を使用して TeamsCallAdapter を作成します。 StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。
fromFlatCommunicationIdentifier(string)	toFlatCommunicationIdentifierの逆操作。
getCallingSelector<Component>(Component)	指定したコンポーネントのセレクターを取得します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
getChatSelector<Component>(Component)	指定したコンポーネントのセレクターを取得します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
loadCallComposite(CallCompositeLoaderProps, HTMLElement)	アプリケーションで使用できる CallComposite のローダー関数。この関数は、指定された HTML 要素に CallComposite を読み込みます。これの最適なユースケースは、ReactベースではないNode UIフレームワークです。
loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)	アプリケーションで使用できる CallWithChatComposite の props。この関数は、指定された HTML 要素に CallWithChatComposite を読み込みます。これの最適なユースケースは、React ベースではない Node UI フレームワークです。
loadChatComposite(ChatCompositeLoaderProps, HTMLElement)	アプリケーションで使用できる ChatComposite のローダー関数。この関数は、指定された HTML 要素に ChatComposite を読み込みます。これの最適なユースケースは、React ベースではない Node UI フレームワークです。
loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)	アプリケーションで使用できる OutboundCallComposite の Loader 関数。この関数は、CallComposite を指定された HTML 要素に読み込み、アウトバウンド呼び出しを行います。これの最適なユースケースは、React ベースではない Node UI フレームワークです。
onResolveDeepNoiseSuppressionDependency()	遅延読み込みを使用したビデオ背景効果の依存関係の解決。
onResolveDeepNoiseSuppressionDependencyLazy()	遅延読み込みを使用したビデオ背景効果の依存関係の解決。
onResolveVideoEffectDependency()	ビデオの背景効果の依存関係の解決。
onResolveVideoEffectDependencyLazy()	遅延読み込みを使用したビデオ背景効果の依存関係の解決。
toFlatCommunicationIdentifier(CommunicationIdentifier)	<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>の文字列形式。 CommunicationIdentifier のこの文字列表現は、一意の Communication ユーザーに対して安定することが保証されます。こうしてこれは、外部データベースにユーザーの ID を保持するために使用できます。これは、ユーザーのデータを格納するためのマップへのキーとして使用できます。
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs \| AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)	CallAdapterの作成を簡略化するカスタム React フック。 createAzureCommunicationCallAdapterと同様ですが、アダプターの非同期作成は内部的に処理されます。ルールオブフックを尊重し、引数の作成時に渡すことができるように、引数を未定義にすることができます。アダプターは、すべての引数が定義されている場合にのみ作成されます。各レンダリングでアダプターを再作成しないように、引数をメモする必要があることに注意してください。一般的な使用例については、ストーリーブックを参照してください。
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)	CallWithChatAdapterの作成を簡略化するカスタム React フック。 createAzureCommunicationCallWithChatAdapterと同様ですが、アダプターの非同期作成は内部的に処理されます。ルールオブフックを尊重し、引数の作成時に渡すことができるように、引数を未定義にすることができます。アダプターは、すべての引数が定義されている場合にのみ作成されます。各レンダリングでアダプターを再作成しないように、引数をメモする必要があることに注意してください。一般的な使用例については、ストーリーブックを参照してください。
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)	ChatAdapterの作成を簡略化するカスタム React フック。 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 コンポーネントに必要なすべてのフックをこのライブラリから取得するためのプライマリフック。このフックを呼び出すには、コンポーネントを次のプロバイダーの下にラップする必要があります。チャットコンポーネントの場合: ChatClientProvider をし、ChatThreadClientProvider をします。コンポーネントを呼び出す場合: 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")	フックして、指定したコンポーネントのセレクターを取得します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
useTeamsCall()	フックしてプロバイダーから <xref:%40azure%2Fcommunication-calling%23TeamsCall> を取得します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。このフックを使用するには、以前に CallProvider を TeamsCall オブジェクトと共に使用していた必要があります
useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)	TeamsCallAdapter の作成を簡略化するためのカスタム React フック。 <xref:createTeamsAzureCommunicationCallAdapter> と似ていますが、アダプターの非同期作成を内部で処理します。ルールオブフックを尊重し、引数の作成時に渡すことができるように、引数を未定義にすることができます。アダプターは、すべての引数が定義されている場合にのみ作成されます。各レンダリングでアダプターを再作成しないように、引数をメモする必要があることに注意してください。一般的な使用例については、ストーリーブックを参照してください。
useTeamsCallAgent()	フックしてプロバイダーから <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> を取得します。このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。
useTheme()	アクセステーマにフックを反応させる

関数の詳細

CallAgentProvider(CallAgentProviderProps)

<xref:React.Context>を格納する <xref:%40azure%2Fcommunication-calling%23CallAgent>。

このパッケージから呼び出すコンポーネントは、CallAgentProviderでラップする必要があります。

function CallAgentProvider(props: CallAgentProviderProps): Element

パラメーター

props: CallAgentProviderProps

戻り値

Element

CallClientProvider(CallClientProviderProps)

<xref:React.Context>を格納する。

このパッケージからコンポーネントを呼び出すには、CallClientProviderでラップする必要があります。

function CallClientProvider(props: CallClientProviderProps): Element

パラメーター

props: CallClientProviderProps

戻り値

Element

CallComposite(CallCompositeProps)

呼び出しエクスペリエンス用のカスタマイズ可能な UI 複合。

function CallComposite(props: CallCompositeProps): Element

パラメーター

props: CallCompositeProps

戻り値

Element

注釈

呼び出し複合最小幅/高さは次のとおりです。

mobile: 17.5rem x 21rem (280px x 336px、既定の rem は 16px)
desktop: 30rem x 22rem (480px x 352px、既定の rem は 16px)

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

CaptionsBanner(CaptionsBannerProps)

ユーザーアイコン、displayName、およびキャプションテキストを含むCaptionsBannerを表示するためのコンポーネント。

function CaptionsBanner(props: CaptionsBannerProps): Element

パラメーター

props: CaptionsBannerProps

戻り値

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

音声言語を設定するためのコンポーネント

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

パラメーター

props: CaptionsSettingsModalProps

戻り値

Element

ChatClientProvider(ChatClientProviderProps)

<xref:React.Context>を格納する。

このパッケージのチャットコンポーネントは、ChatClientProviderでラップする必要があります。

function ChatClientProvider(props: ChatClientProviderProps): Element

パラメーター

props: ChatClientProviderProps

戻り値

Element

ChatComposite(ChatCompositeProps)

チャットエクスペリエンス用のカスタマイズ可能な UI 複合。

function ChatComposite(props: ChatCompositeProps): Element

パラメーター

props: ChatCompositeProps

戻り値

Element

注釈

チャット複合最小幅と高さは、それぞれ 17.5rem と 20rem (280px と 320px、既定の rem は 16px) です。

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の既定のボタンスタイル。

このコンポーネントを使用して、UI ライブラリによって提供される他のボタンと同じスタイルのカスタムボタンを作成します。

function ControlBarButton(props: ControlBarButtonProps): Element

パラメーター

props: ControlBarButtonProps

戻り値

Element

DevicesButton(DevicesButtonProps)

デバイスオプションを制御するメニューを開くボタン。

ControlBarで使用できます。

function DevicesButton(props: DevicesButtonProps): Element

パラメーター

props: DevicesButtonProps

戻り値

Element

Dialpad(DialpadProps)

ユーザーがダイヤルパッドをクリック/キーボードを使用して電話番号を入力できるようにするコンポーネント安定したビルドでは空のコンポーネントを返します

function Dialpad(props: DialpadProps): Element

パラメーター

props: DialpadProps

戻り値

Element

EndCallButton(EndCallButtonProps)

進行中の通話を終了するボタン。

ControlBarで使用できます。

function EndCallButton(props: EndCallButtonProps): Element

パラメーター

props: EndCallButtonProps

戻り値

Element

ErrorBar(ErrorBarProps)

UI にエラーメッセージを表示するコンポーネント。表示できるすべての文字列は、ローカライズできるように文字列として受け入れられます。アクティブエラーは、activeErrorMessages 選択されます。

このコンポーネントは、ユーザーが無視した部分を内部的に追跡します。

関連付けられたタイムスタンプを持つエラー: 無視された後に発生した場合、エラーは UI に再度表示されます。
タイムスタンプのないエラー: エラーは、プロパティから消えるまで無視されます。エラーが繰り返し発生すると、UI に表示されます。

UI 要素 <xref:%40fluentui%2Freact%23MessageBar> 使用します。

function ErrorBar(props: ErrorBarProps): Element

パラメーター

props: ErrorBarProps

戻り値

Element

FluentThemeProvider(FluentThemeProviderProps)

このライブラリの React コンポーネント全体に Fluent テーマを適用するプロバイダー。

function FluentThemeProvider(props: FluentThemeProviderProps): Element

パラメーター

props: FluentThemeProviderProps

戻り値

Element

注釈

このライブラリのコンポーネントは、主に Fluent UI、コントロール、v8 コントロールと v9 コントロールの混在で構成されています。このプロバイダーは、基になる Fluent UI コントロールに提供される任意のテーマの適用を処理します。 *

GridLayout(GridLayoutProps)

通話でオーディオ/ビデオ参加者のタイルをレイアウトするコンポーネント。

function GridLayout(props: GridLayoutProps): Element

パラメーター

props: GridLayoutProps

戻り値

Element

HoldButton(HoldButtonProps)

進行中の通話を保留または再開するためのボタン。

ControlBar と一緒に使用できます

function HoldButton(props: HoldButtonProps): Element

パラメーター

props: HoldButtonProps

hold ボタンのプロパティ。

戻り値

Element

ImageOverlay(ImageOverlayProps)

選択した画像のフルスクリーンモーダルをレンダリングするコンポーネント。

function ImageOverlay(props: ImageOverlayProps): Element

パラメーター

props: ImageOverlayProps

戻り値

Element

IncomingCallNotification(IncomingCallNotificationProps)

エンドユーザーへの着信呼び出しを表すために使用される通知コンポーネント。ユーザーは着信コールを受け入れるか拒否できます。

function IncomingCallNotification(props: IncomingCallNotificationProps): Element

パラメーター

props: IncomingCallNotificationProps

戻り値

Element

IncomingCallStack(IncomingCallStackProps)

複数の着信通話を管理するためのラッパー

function IncomingCallStack(props: IncomingCallStackProps): Element

パラメーター

props: IncomingCallStackProps

<xref:IncomingCallManagerProps>

戻り値

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 型の

ユーザーは、MessageThread コンポーネントをレンダリングするために、少なくともチャットメッセージと userId を指定する必要があります。ユーザーは、独自のアバター、MessageThread アイコン、MessageStatusIndicator、JumpToNewMessageButton、およびこれらのコントロールの動作を渡すことによって、LoadPreviousMessagesButton をカスタマイズすることもできます。

MessageThread内部的には、Chat の @fluentui-contrib/chat コンポーネントを使用します。これらのコンポーネントの詳細については、こちらを参照してください。

戻り値

Element

MicrophoneButton(MicrophoneButtonProps)

マイクのオン/オフを切り替えるボタン。

ControlBarで使用できます。

function MicrophoneButton(props: MicrophoneButtonProps): Element

パラメーター

props: MicrophoneButtonProps

戻り値

Element

Notification(NotificationProps)

UI に通知メッセージを表示するコンポーネント。

function Notification(props: NotificationProps): Element

パラメーター

props: NotificationProps

戻り値

Element

NotificationStack(NotificationStackProps)

UI に通知を表示するコンポーネント。表示できるすべての文字列は、ローカライズできるように文字列として受け入れられます。アクティブな通知は、activeNotifications によって選択されます。

このコンポーネントは、ユーザーが無視した部分を内部的に追跡します。

タイムスタンプが関連付けられている通知: 通知が無視された後に発生した場合、通知は UI に再度表示されます。
タイムスタンプがない通知: 通知は、props から消えるまで閉じられます。通知が繰り返される場合は、UI に表示されます。

function NotificationStack(props: NotificationStackProps): Element

パラメーター

props: NotificationStackProps

戻り値

Element

ParticipantItem(ParticipantItemProps)

通話またはチャット参加者をレンダリングするコンポーネント。

参加者のアバター、displayName、状態、およびオプションのアイコンとコンテキストメニューを表示します。

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

RaiseHandButton(RaiseHandButtonProps)

画面共有を開始/停止するボタン。

ControlBarで使用できます。

function RaiseHandButton(props: RaiseHandButtonProps): Element

パラメーター

props: RaiseHandButtonProps

戻り値

Element

ReactionButton(ReactionButtonProps)

リアクションを送信するボタン。

ControlBarで使用できます。

function ReactionButton(props: ReactionButtonProps): Element

パラメーター

props: ReactionButtonProps

戻り値

Element

RealTimeText(RealTimeTextProps)

RealTimeTextの1行を表示するためのコンポーネント

function RealTimeText(props: RealTimeTextProps): Element

パラメーター

props: RealTimeTextProps

戻り値

Element

RealTimeTextModal(RealTimeTextModalProps)

realTimeText モーダルのコンポーネント

function RealTimeTextModal(props: RealTimeTextModalProps): Element

パラメーター

props: RealTimeTextModalProps

戻り値

Element

ScreenShareButton(ScreenShareButtonProps)

画面共有を開始/停止するボタン。

ControlBarで使用できます。

function ScreenShareButton(props: ScreenShareButtonProps): Element

パラメーター

props: ScreenShareButtonProps

戻り値

Element

SendBox(SendBoxProps)

メッセージを入力および送信するためのコンポーネント。

ユーザーがテキストの入力を開始したときの入力通知の送信をサポートします。テキスト入力フィールドの下の省略可能なメッセージをサポートします。

function SendBox(props: SendBoxProps): Element

パラメーター

props: SendBoxProps

戻り値

Element

StartCaptionsButton(StartCaptionsButtonProps)

キャプションを開始または停止するボタン

ControlBar と一緒に使用できます

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

パラメーター

props: StartCaptionsButtonProps

[キャプションの開始] ボタンのプロパティ。

戻り値

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

アクセシビリティ要件に基づいてRealTimeTextを起動するボタン、リアルタイムテキストは一度オンにするとオフにできません

ControlBar と一緒に使用できます

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

パラメーター

props: StartRealTimeTextButtonProps

startRealTimeTextボタンのプロパティ。

戻り値

Element

StreamMedia(StreamMediaProps)

ビデオストリームを含む HTMLElement を JSX 要素に変換するユーティリティコンポーネント。

ヘッドレス呼び出し API によって返される HTMLElement を、VideoTileとしてレンダリングできるコンポーネントに変換するために使用します。

function StreamMedia(props: StreamMediaProps): Element

パラメーター

props: StreamMediaProps

戻り値

Element

TypingIndicator(TypingIndicatorProps)

チャットスレッド内の 1 人以上の参加者が入力しているときにローカルユーザーに通知するコンポーネント。

function TypingIndicator(props: TypingIndicatorProps): Element

パラメーター

props: TypingIndicatorProps

戻り値

Element

VideoGallery(VideoGalleryProps)

VideoGallery は、特定の通話のビデオタイルのレイアウトを表します。ローカルユーザーと、通話に参加した各リモート参加者の VideoTile が表示されます。

function VideoGallery(props: VideoGalleryProps): Element

パラメーター

props: VideoGalleryProps

戻り値

Element

VideoTile(VideoTileProps)

1 人の通話参加者のビデオストリームをレンダリングするコンポーネント。

VideoGalleryで GridLayout と共に使用します。

function VideoTile(props: VideoTileProps): Element

パラメーター

props: VideoTileProps

戻り値

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Azure Communication Services によってサポートされる CallAdapter を作成します。

これは、このライブラリによって提供 CallAdapter の既定の実装です。

注: displayName は最大 256 文字です。

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

パラメーター

args: AzureCommunicationCallAdapterArgs

戻り値

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

Azure Communication Services によってサポートされる CallAdapter を作成します。

これは、このライブラリによって提供 CallAdapter の既定の実装です。

注: displayName は最大 256 文字です。

function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>

パラメーター

args: AzureCommunicationOutboundCallAdapterArgs

戻り値

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)

指定された StatefulCallClientを使用して、CallAdapter を作成します。

StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>

パラメーター

callClient: StatefulCallClient

callAgent: CallAgent

targetCallees: CommunicationIdentifier[]

options: CommonCallAdapterOptions

戻り値

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

指定された StatefulCallClientを使用して、CallAdapter を作成します。

StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。

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

パラメーター

callClient: StatefulCallClient

callAgent: CallAgent

locator: CallAdapterLocator

options: CommonCallAdapterOptions

戻り値

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Azure Communication サービスによってサポートされる CallWithChatAdapter を作成して、CallWithChatCompositeに接続します。

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

パラメーター

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

戻り値

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

提供された StatefulChatClient と StatefulCallClient を使用して、CallWithChatAdapter作成します。

StatefulChatClient への参照を保持し、StatefulCallClient をする場合に便利です。 chatThreadClient は、StatefulChatClient が chatClient.getChatThreadClient(chatThreadId) API を使用して作成する必要があることに注意してください。よりシンプルな API createAzureCommunicationCallWithChatAdapter を使用することを検討してください。

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

パラメーター

__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs

戻り値

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Azure Communication Services によってサポートされる ChatAdapter を作成します。

これは、このライブラリによって提供 ChatAdapter の既定の実装です。

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

パラメーター

__namedParameters: AzureCommunicationChatAdapterArgs

戻り値

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

提供された StatefulChatClientを使用して、ChatAdapter を作成します。

StatefulChatClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationChatAdapter を使用することを検討してください。

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

パラメーター

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

chatAdapterOptions: ChatAdapterOptions

戻り値

Promise<ChatAdapter>

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

チームコール用の CallingHandlers の既定の実装を作成します。

このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。

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

パラメーター

callClient: StatefulCallClient

callAgent: undefined | CallAgent

deviceManager: undefined | StatefulDeviceManager

call: undefined | Call

options: CallingHandlersOptions

戻り値

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

ChatHandlersの既定の実装を作成します。

このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。

返されたオブジェクトは、React コンポーネントのプロパティとして使用する場合に再レンダリングを回避するためにメモされています。

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

パラメーター

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

戻り値

ChatHandlers

createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })

チーム通話の TeamsCallingHandlers の既定の実装を作成します。

このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。

function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers

パラメーター

callClient: StatefulCallClient

callAgent: TeamsCallAgent

deviceManager: StatefulDeviceManager

call: TeamsCall

options: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }

戻り値

TeamsCallingHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

ProxyCallClient を使用して CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> をプロキシすることで、StatefulCallClient <xref:ProxyCallClient> を作成し、宣言型の方法で状態にアクセスできるようにします。

状態の変更を適切にプロキシするには、StatefulCallClient から取得した <xref:%40azure%2Fcommunication-calling%23DeviceManager> と <xref:%40azure%2Fcommunication-calling%23CallAgent> と <xref:%40azure%2Fcommunication-calling%23Call> (など) を使用することが重要です。

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

パラメーター

args: StatefulCallClientArgs

StatefulCallClientArgs (ステートフルコールクライアント引数)

options: StatefulCallClientOptions

StatefulCallClientOptions (ステートフルコールクライアントオプション)

戻り値

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

ProxyChatClient を使用して ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> をプロキシすることで、ステートフル ChatClient <xref:ProxyChatClient> を作成し、宣言型の方法で状態にアクセスできるようにします。

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

パラメーター

args: StatefulChatClientArgs

options: StatefulChatClientOptions

戻り値

StatefulChatClient

createTeamsCallAdapter(TeamsCallAdapterArgs)

function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>

パラメーター

args: TeamsCallAdapterArgs

戻り値

Promise<TeamsCallAdapter>

createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

提供されている StatefulCallClient を使用して TeamsCallAdapter を作成します。

StatefulCallClientへの参照を保持する場合に便利です。よりシンプルな API createAzureCommunicationCallAdapter を使用することを検討してください。

function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>

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>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

アプリケーションで使用できる CallComposite のローダー関数。この関数は、指定された HTML 要素に CallComposite を読み込みます。これの最適なユースケースは、ReactベースではないNode UIフレームワークです。

function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

パラメーター

loaderArgs: CallCompositeLoaderProps

htmlElement: HTMLElement

戻り値

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

アプリケーションで使用できる CallWithChatComposite の props。この関数は、指定された HTML 要素に CallWithChatComposite を読み込みます。これの最適なユースケースは、React ベースではない Node UI フレームワークです。

function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>

パラメーター

loaderArgs: CallWithChatCompositeLoaderProps

htmlElement: HTMLElement

戻り値

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

アプリケーションで使用できる ChatComposite のローダー関数。この関数は、指定された HTML 要素に ChatComposite を読み込みます。これの最適なユースケースは、React ベースではない Node UI フレームワークです。

function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>

パラメーター

loaderArgs: ChatCompositeLoaderProps

htmlElement: HTMLElement

戻り値

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

アプリケーションで使用できる OutboundCallComposite の Loader 関数。この関数は、CallComposite を指定された HTML 要素に読み込み、アウトバウンド呼び出しを行います。これの最適なユースケースは、React ベースではない Node UI フレームワークです。

function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

パラメーター

loaderArgs: OutboundCallCompositeLoaderProps

htmlElement: HTMLElement

戻り値

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

遅延読み込みを使用したビデオ背景効果の依存関係の解決。

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

戻り値

Promise<DeepNoiseSuppressionEffectDependency>

onResolveDeepNoiseSuppressionDependencyLazy()

遅延読み込みを使用したビデオ背景効果の依存関係の解決。

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

戻り値

Promise<DeepNoiseSuppressionEffectDependency>

onResolveVideoEffectDependency()

ビデオの背景効果の依存関係の解決。

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

戻り値

Promise<VideoBackgroundEffectsDependency>

onResolveVideoEffectDependencyLazy()

遅延読み込みを使用したビデオ背景効果の依存関係の解決。

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

戻り値

Promise<VideoBackgroundEffectsDependency>

toFlatCommunicationIdentifier(CommunicationIdentifier)

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>の文字列形式。

CommunicationIdentifier のこの文字列表現は、一意の Communication ユーザーに対して安定することが保証されます。こうして

これは、外部データベースにユーザーの ID を保持するために使用できます。
これは、ユーザーのデータを格納するためのマップへのキーとして使用できます。

function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

パラメーター

identifier: CommunicationIdentifier

戻り値

string

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

CallAdapterの作成を簡略化するカスタム React フック。

createAzureCommunicationCallAdapterと同様ですが、アダプターの非同期作成は内部的に処理されます。

ルールオブフックを尊重し、引数の作成時に渡すことができるように、引数を未定義にすることができます。アダプターは、すべての引数が定義されている場合にのみ作成されます。

各レンダリングでアダプターを再作成しないように、引数をメモする必要があることに注意してください。一般的な使用例については、ストーリーブックを参照してください。

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

パラメーター

args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>

afterCreate: (adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose: (adapter: CallAdapter) => Promise<void>

戻り値

undefined | CallAdapter

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

CallWithChatAdapterの作成を簡略化するカスタム React フック。

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

ChatAdapterの作成を簡略化するカスタム React フック。

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 コンポーネントに必要なすべてのフックをこのライブラリから取得するためのプライマリフック。

このフックを呼び出すには、コンポーネントを次のプロバイダーの下にラップする必要があります。

チャットコンポーネントの場合: ChatClientProvider をし、ChatThreadClientProvider をします。
コンポーネントを呼び出す場合: 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)

useTeamsCall()

フックしてプロバイダーから <xref:%40azure%2Fcommunication-calling%23TeamsCall> を取得します。

このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。

このフックを使用するには、以前に CallProvider を TeamsCall オブジェクトと共に使用していた必要があります

function useTeamsCall(): undefined | TeamsCall

戻り値

undefined | TeamsCall

useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)

TeamsCallAdapter の作成を簡略化するためのカスタム React フック。

<xref:createTeamsAzureCommunicationCallAdapter> と似ていますが、アダプターの非同期作成を内部で処理します。

function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter

パラメーター

args: Partial<TeamsCallAdapterArgs>

afterCreate: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>

beforeDispose: (adapter: TeamsCallAdapter) => Promise<void>

戻り値

undefined | TeamsCallAdapter

useTeamsCallAgent()

フックしてプロバイダーから <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> を取得します。

このライブラリからエクスポートされたプロバイダーを利用するカスタムコンポーネントを実装する場合に便利です。

function useTeamsCallAgent(): undefined | TeamsCallAgent

戻り値

undefined | TeamsCallAgent

useTheme()

アクセステーマにフックを反応させる

function useTheme(): Theme

戻り値

Theme

次の方法で共有

@azure/communication-react package

クラス

インターフェイス

型エイリアス

関数

関数の詳細

CallAgentProvider(CallAgentProviderProps)

パラメーター

戻り値

CallClientProvider(CallClientProviderProps)

パラメーター

戻り値

CallComposite(CallCompositeProps)

パラメーター

戻り値

注釈

CallProvider(CallProviderProps)

パラメーター

戻り値

CallWithChatComposite(CallWithChatCompositeProps)

パラメーター

戻り値

CameraButton(CameraButtonProps)

パラメーター

戻り値

CaptionsBanner(CaptionsBannerProps)

パラメーター

戻り値

CaptionsSettingsModal(CaptionsSettingsModalProps)

パラメーター

戻り値

ChatClientProvider(ChatClientProviderProps)

パラメーター

戻り値

ChatComposite(ChatCompositeProps)

パラメーター

戻り値

注釈

ChatThreadClientProvider(ChatThreadClientProviderProps)

パラメーター

戻り値

ControlBar(ControlBarProps)

パラメーター

戻り値

ControlBarButton(ControlBarButtonProps)

パラメーター

戻り値

DevicesButton(DevicesButtonProps)

パラメーター

戻り値

Dialpad(DialpadProps)

パラメーター

戻り値

EndCallButton(EndCallButtonProps)

パラメーター

戻り値

ErrorBar(ErrorBarProps)

パラメーター

戻り値

FluentThemeProvider(FluentThemeProviderProps)

パラメーター

戻り値

注釈

GridLayout(GridLayoutProps)

パラメーター

戻り値

HoldButton(HoldButtonProps)

パラメーター

戻り値

ImageOverlay(ImageOverlayProps)

パラメーター

戻り値

IncomingCallNotification(IncomingCallNotificationProps)

パラメーター

戻り値

IncomingCallStack(IncomingCallStackProps)

パラメーター

戻り値

LocalizationProvider(LocalizationProviderProps)