次の方法で共有

@azure/communication-react package

  • リファレンス

クラス

CallError

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

失敗した StatefulChatClient メソッドからスローされたエラー。

インターフェイス

ActiveErrorMessage

ErrorBar 経由で表示されるアクティブなエラー メッセージ。
AdapterError

エラー イベントを介して報告され、アダプターの状態で格納されるエラー。
AdapterState

複合アダプターの状態とインターフェイスするための機能。
BaseCompositeProps

このライブラリからエクスポートされるすべての複合に共通のプロパティ。
BaseCustomStyles

この libray からエクスポートされるすべてのコンポーネントの基本的な fluent スタイル props。
CallAdapter

CommonCallAdapter を拡張する Azure Communication ID に固有のアダプター インターフェイス。
CallAdapterCallManagement

現在の呼び出しを管理したり、新しい呼び出しを開始したりするための機能
CallAdapterCallOperations

現在の呼び出しを管理するための機能。
CallAdapterDeviceManagement

通話内でデバイスを管理するための機能。
CallAdapterSubscribers

サブスクライブできる複合イベントを呼び出します。
CallAgentProviderProps

CallAgentProvider を初期化するための引数。
CallAgentState

State only version of <xref:%40azure%2Fcommunication-calling%23CallAgent> except call is moved to a child of CallClientState and not included here. (呼び出しを除く) の状態のみのバージョンは、 CallClientState の子に直接移動され、ここには含まれません。 CallAgent の状態をプロキシ化する理由は、displayName へのアクセスを提供するためです。 CallAgent.displayName をフラット化せず、CallClientState に配置します。これは、displayName が使用できる CallAgent の作成/存在に実際に依存していることを明確にするためです。
CallAndChatLocator

CreateAzureCommunicationCallWithChatAdapter で使用して、関連付けられたチャット スレッドと呼び出しを結合するための引数。
CallClientProviderProps

CallClientProvider を初期化するための引数。
CallClientState

StatefulCallClient によってプロキシ化されたすべての状態データのコンテナー。 callAgent が作成されている場合、calls、callsEnded、incomingCalls、および incomingCallsEnded の各状態が自動的に提供されます。 deviceManager が設定されるまで、deviceManager は最初は空になります。 「DeviceManagerState」を参照してください。 userId 状態は開発者にとって便利な状態として提供され、開発者によって完全に制御および設定されます。
CallCompositeProps

CallComposite の Props。
CallCompositeStrings

CallComposite で直接使用される文字列。

この文字列は、コンポーネント ライブラリのコンポーネントで使用される文字列に加えて使用されます。
CallProviderProps

CallProvider を初期化するための引数。
CallState

の状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23Call>。 StatefulCallClient は、呼び出しの状態を自動的に取得し、 StatefulCallClient によって公開されている状態に追加します。
CallWithChatAdapter

CallWithChatComposite アダプター インターフェイス。
CallWithChatAdapterManagement

チャットで現在の通話を管理するための機能。
CallWithChatAdapterState

CallWithChat 状態は、ステートフル チャットクライアントとステートフル通話クライアントの組み合わせであり、CallWithChat 複合のみに固有の状態があります。
CallWithChatAdapterSubscriptions

CallWithChatAdapter でサブスクライブできる通話イベントとチャット イベント。
CallWithChatAdapterUiState

CallWithChatComposite に関連する UI 状態。
CallWithChatClientState

CallWithChatComposite を駆動するバックエンド サービスからの状態。
CallWithChatCompositeProps

CallWithChatComposite に必要な Props
CallWithChatCompositeStrings

CallWithChatComposite で直接使用される文字列。

この文字列は、コンポーネント ライブラリのコンポーネントで使用される文字列に加えて使用されます。
CallWithChatControlOptions

CallWithChatComposite 呼び出し元コントロール バーのボタンを表示または非表示にするコントロールを呼び出します。
CallingHandlers

コンポーネントの呼び出しに必要なすべてのハンドラーを含む オブジェクト。

このパッケージから関連コンポーネントを呼び出すと、このオブジェクトから関連するハンドラーを選択できます。 「および usePropsFor」を参照してください<xref:useHandlers>。
CallingTheme

このライブラリの関連コンポーネントを呼び出すことによって使用されるカスタム Fluent テーマ パレット。
CameraButtonContextualMenuStyles

CameraButton メニューのスタイル。
CameraButtonProps

CameraButton コンポーネントの Props。
CameraButtonStrings

オーバーライドできる CameraButton の文字列。
CameraButtonStyles

CameraButton のスタイル
ChatAdapterSubscribers

サブスクライブできるチャット複合イベント。
ChatAdapterThreadManagement

現在のチャット スレッドを管理するための機能。
ChatCompositeProps

ChatComposite の Props。
ChatCompositeStrings

ChatComposite で直接使用される文字列。

この文字列は、コンポーネント ライブラリのコンポーネントで使用される文字列に加えて使用されます。
ChatMessage

チャット メッセージ。
CommonCallAdapter

CallComposite アダプター インターフェイス。
CommonCallingHandlers

コンポーネントの呼び出しに必要なすべてのハンドラーを含む オブジェクト。

このパッケージから関連コンポーネントを呼び出すと、このオブジェクトから関連するハンドラーを選択できます。 「および usePropsFor」を参照してください。<xref:useHandlers>
ComponentLocale

このライブラリからエクスポートされるすべてのコンポーネントのロケール情報。
ComponentStrings

このライブラリからエクスポートされたすべてのコンポーネントで使用される文字列。
CompositeLocale

このライブラリからエクスポートされるすべての複合のロケール情報。
CompositeStrings

複合で直接使用される文字列。

これらの文字列は、含まれているコンポーネントではなく、複合によって直接使用されます。
ContentSystemMessage

アービタリ コンテンツを含むシステム メッセージ。
ControlBarButtonProps

ControlBarButton の Props。
ControlBarButtonStrings

オーバーライドできる ControlBarButton の文字列。
ControlBarProps

ControlBar の Props。
CreateVideoStreamViewResult

ローカルまたはリモート VideoStream の作成後に返されるオブジェクト。 これには、ストリームのレンダリングを操作するためのヘルパー関数が含まれています。
CustomMessage

カスタム メッセージの種類。

カスタム メッセージは既定ではレンダリングされませんが、アプリケーションはカスタム レンダラーを提供できます。
DevicesButtonContextualMenuStyles

[デバイス ボタン] メニューのスタイル。
DevicesButtonProps

DevicesButton の Props。
DevicesButtonStrings

オーバーライドできる DevicesButton の文字列。
DevicesButtonStyles

[デバイス] ボタンメニュー項目のスタイル。
DiagnosticsCallFeatureState

の状態のみのプロキシ <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>。
Disposable

複合を正しく破棄するための機能。
EndCallButtonProps

EndCallButton の Props。
EndCallButtonStrings

オーバーライドできる EndCallButton の文字列。
ErrorBarProps

ErrorBar の Props。

次に加えて、ErrorBar は基になる <xref:%40fluentui%2Freact%23MessageBar>にすべてを<xref:%40fluentui%2Freact%23IMessageBarProps>転送します。
ErrorBarStrings

ErrorBar の UI に表示される可能性のあるすべての文字列。
FluentThemeProviderProps

FluentThemeProvider の Props。
GridLayoutProps

GridLayout の Props。
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 の Props。
MessageStatusIndicatorStrings

オーバーライドできる MessageStatusIndicator の文字列。
MessageThreadStrings

オーバーライドできる MessageThread の文字列。
MessageThreadStyles

MessageThread の Fluent スタイル。
MicrophoneButtonContextualMenuStyles

MicrophoneButton メニューのスタイル。
MicrophoneButtonProps

MicrophoneButton の Props。
MicrophoneButtonStrings

オーバーライドできる MicrophoneButton の文字列。
MicrophoneButtonStyles

MicrophoneButton のスタイル
NetworkDiagnosticsState

の状態のみのプロキシ <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>。
OptionsDevice

DevicesButton ポップアップ内のデバイス (カメラ、マイク、スピーカーなど)。
ParticipantAddedSystemMessage

参加者がチャット スレッドに追加されたことを通知するシステム メッセージ。
ParticipantItemProps

ParticipantItem の Props。
ParticipantItemStrings

オーバーライドできる ParticipantItem の文字列。
ParticipantItemStyles

ParticipantItem の Fluent スタイル。
ParticipantListItemStyles

ParticipantListParticipantItem のスタイル。
ParticipantListStyles

ParticipantList のスタイル。
ParticipantRemovedSystemMessage

参加者がチャット スレッドから削除されたことを通知するシステム メッセージ。
ParticipantsButtonContextualMenuStyles

ParticipantsButton メニューのスタイル。
ParticipantsButtonProps

ParticipantsButton の Props。
ParticipantsButtonStrings

オーバーライドできる ParticipantsButton の文字列。
ParticipantsButtonStyles

ParticipantsButton のスタイル のプロパティ。
RecordingCallFeature

の状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>。 StatefulCallClient は、呼び出しの記録状態を自動的にリッスンし、それに応じて StatefulCallClient によって公開される状態を更新します。
RemoteParticipantState

の状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>。 StatefulCallClient は、RemoteParticipants を自動的に取得し、その状態を StatefulCallClient によって公開される状態に追加します。
RemoteVideoStreamState

の状態のみのバージョン <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>。
ScreenShareButtonProps

ScreenShareButton の Props。
ScreenShareButtonStrings

オーバーライドできる ScreenShareButton の文字列。
SendBoxProps

SendBox の Props。
SendBoxStrings

オーバーライドできる SendBox の文字列。
SendBoxStylesProps

の <xref:Sendbox>Fluent スタイル。
StatefulCallClient

CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> をステートフルに使用できるようにするメソッドを定義します。 インターフェイスは、プロキシ状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。 状態の定義については、「 CallClientState」を参照してください。

状態変更イベントは、次の方法で駆動されます。

  • API から <xref:%40azure%2Fcommunication-calling%23DeviceManager> 返されたデータ。
  • API から <xref:%40azure%2Fcommunication-calling%23CallAgent> 返されたデータ。
  • さまざまな Azure 通信呼び出しオブジェクトに自動的にアタッチされるリスナー:
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • 'stateChanged' を呼び出す
    • 'idChanged' を呼び出す
    • 'isMutedChanged' を呼び出す
    • 'isScreenSharingOnChanged' を呼び出す
    • 'remoteParticipantsUpdated' を呼び出す
    • 'localVideoStreamsUpdated' を呼び出す
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

{@Link @azure/communication-chat#ChatClient} を一元的に生成された状態で使用できるようにするメソッドを定義します。

インターフェイスは、プロキシ状態へのアクセスを提供し、状態変更イベントのハンドラーを登録することもできます。
StatefulDeviceManager

の上にステートフルによって追加される追加の <xref:%40azure%2Fcommunication-calling%23DeviceManager>メソッドを定義します。
StreamMediaProps

StreamMedia の Props。
SystemMessageCommon

すべてのシステム メッセージの共通プロパティ。
TopicUpdatedSystemMessage

チャット スレッド トピックが更新されたことを通知するシステム メッセージ。
TranscriptionCallFeature

の状態のみバージョン <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>。 StatefulCallClient は、呼び出しの文字起こし状態を自動的にリッスンし、それに応じて StatefulCallClient によって公開されている状態を更新します。
TypingIndicatorProps

TypingIndicator の Props。
TypingIndicatorStrings

オーバーライドできる TypingIndicator の 文字列。
TypingIndicatorStylesProps

TypingIndicator の Fluent スタイル。
VideoGalleryProps

VideoGallery の Props。
VideoGalleryRemoteParticipant

VideoGallery のリモート参加者の状態。
VideoGalleryStream

VideoGallery の参加者のビデオ ストリーム。
VideoGalleryStrings

VideoGallery の UI に表示できるすべての文字列。
VideoGalleryStyles

VideoGallery コンポーネントのスタイル。
VideoStreamOptions

ビデオ ストリームのレンダリング方法を制御するオプション。
VideoStreamRendererViewState

の状態のみバージョン <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>。 このプロパティは、createView によって StatefulCallClient によって公開される状態に追加され、disposeView によって削除されます。
VideoTileProps

VideoTile の Props。
VideoTileStylesProps

VideoTile の Fluent スタイル。

型エイリアス

AdapterErrors

アダプターは、各操作の最新のエラーを状態で格納します。

target は、アダプターによって実行される一意の操作ごとにアダプター定義の文字列です。
AreEqual

2 つの反応成分が完全に等しいかどうかを比較すると、結果の型は true/false になります
AreParamEqual

2 つの反応成分の小道具が等しいかどうかを比較すると、結果の型は true/false になります
AreTypeEqual

2 つの型が等しいかどうかを比較すると、結果の型は true/false になります
AvatarPersonaData

ユーザーのアバターを表示するためのカスタム データ属性。
AvatarPersonaDataCallback

ユーザーのアバターを作成するためのカスタム データを提供するために使用されるコールバック関数。
AzureCommunicationCallAdapterArgs

CallAdapter のAzure Communication Services実装を作成するための引数。

注: displayName 最大 256 文字を指定できます。
AzureCommunicationCallWithChatAdapterArgs

createAzureCommunicationCallWithChatAdapter の引数
AzureCommunicationCallWithChatAdapterFromClientArgs

<xref:createAzureCommunicationCallWithChatAdapterFromClient> の引数
AzureCommunicationChatAdapterArgs

ChatAdapter のAzure Communication Services実装を作成するための引数。
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

API 呼び出しから Calling SDK へのエラー。

オブジェクトの各プロパティには、特定の SDK API メソッドの最新のエラーが格納されます。

このオブジェクトからのエラーは、 を使用して <xref:newClearCallErrorsModifier>クリアできます。 さらに、エラーは次の場合に自動的にクリアされます。

  • 状態がクリアされます。
  • 関連する API メソッドの後続の呼び出しは成功します。 エラーが自動的にクリアされるタイミングの詳細については、個々のステートフル クライアント メソッドのドキュメントを参照してください。
CallIdChangedListener

CallAdapterSubscribers 'callIdChanged' イベントのコールバック。
CallParticipantListParticipant

UI コンポーネントに反映されている参加者の状態を呼び出す。
CallWithChatCompositeIcons

CallWithChatComposite でオーバーライドできるアイコン。
CallWithChatCompositeOptions

CallWithChatComposite のオプション機能。
CallWithChatEvent

CallWithChatAdapter によって発生したイベント。
CallingBaseSelectorProps

宣言型クライアント状態の呼び出しを参照するために使用される一般的なプロパティ。
CallingReturnProps

usePropsFor のヘルパー型。
CameraButtonSelector

CameraButton コンポーネントのセレクターの種類。
ChatAdapter

ChatComposite アダプター インターフェイス。
ChatAdapterState

ChatAdapter の 状態。
ChatAdapterUiState

純粋な UI 用の ChatAdapter 状態。
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>
ChatMessageWithStatus

<xref:%40azure%2Fcommunication-chat%23ChatMessage>チャット メッセージのクライアント側のみのメタデータを格納する 拡張機能。

TODO: 名前が bitrotted です。 名前を変更します。
ChatParticipantListSelector

ParticipantList コンポーネントのセレクターの種類。
ChatReturnProps

usePropsFor のヘルパー型。
ChatThreadClientProviderProps

ChatThreadClientProvider を初期化するための引数。
ChatThreadClientState

の <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>一元化された状態。
ChatThreadProperties

チャット スレッドのプロパティ。

基になる API で使用されるさまざまな型を非表示にするのに役立つ最小限の型を定義します。
ClientState

または <xref:%40azure%2Fcommunication-chat%23ChatClient>の<xref:%40azure%2Fcommunication-calling%23CallClient>一元化された状態。

CallClientState、ChatClientState も参照してください。

Common

2 種類の交差型を返します
CommonProperties

2 種類の交差プロパティを返す
CommunicationParticipant

UI に反映されているチャットまたは通話参加者の状態。
ComponentIcons

このライブラリからエクスポートされたReact コンポーネントによって使用されるアイコン。
ComponentProps

usePropsFor のヘルパー型。
CompositeIcons

このライブラリによってエクスポートされた複合のいずれかでオーバーライドできるアイコン。

よりターゲットを絞った型については、「 ChatCompositeIcons」、「 CallCompositeIcons 」、 および「CallWithChatCompositeIcons 」を参照してください。
ControlBarButtonStyles

すべての ControlBarButton 実装のスタイル。
ControlBarLayout

ControlBar のレイアウトを表示します。
CreateViewResult

createView から結果を返します。
CustomAvatarOptions

アバター (Persona) コンポーネントをonRenderカスタマイズするために関数に挿入できるオプション。
DeviceManagerState

この型は、 内 <xref:%40azure%2Fcommunication-calling%23DeviceManager>のすべての状態をカプセル化するためのものです。 省略可能なパラメーターの場合、ユーザーがアクセス許可を付与するまで使用できない場合があります。 対応する <xref:%40azure%2Fcommunication-calling%23DeviceManager>getCameras、getMicrophones、getSpeakers、askDevicePermission API が呼び出されて完了するまで、カメラ、マイク、スピーカー、および deviceAccess の状態は空になります。
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 の Props。
MediaDiagnosticChangedEvent

メディア診断に変更がある DiagnosticChangedEventListner のペイロード。
Message

すべてのメッセージの判別共用体。

フィールドは messageType 共用体バリアントに特化しています。
MessageAttachedStatus

チャット メッセージをメッセージの前/後にマージして表示するかどうかを示します。

同じ送信者からの多数のメッセージを 1 つのメッセージ バブルにマージする場合に便利です。
MessageContentType

サポートされている種類のチャット メッセージ コンテンツ。
MessageProps

1 つのメッセージをレンダリングするための Prop。

「MessageRenderer」を参照してください。
MessageReadListener

ChatAdapterSubscribers 'messageRead' イベントのコールバック。
MessageReceivedListener

ChatAdapterSubscribers 'messageReceived' イベントのコールバック。
MessageRenderer

1 つのメッセージをレンダリングするコンポーネント。
MessageSentListener

ChatAdapterSubscribers 'messageSent' イベントのコールバック。
MessageStatus

送信されたメッセージのクライアント側の状態。

バックエンドからメッセージ配信が確認される前に発生する遷移状態が含まれます。
MessageThreadProps

MessageThread の Props。
MessageThreadSelector

MessageThread コンポーネントのセレクターの種類。
MicrophoneButtonSelector

MicrophoneButton コンポーネントのセレクターの種類。
NetworkDiagnosticChangedEvent

ネットワーク診断に変更がある DiagnosticChangedEventListner のペイロード。
OnRenderAvatarCallback

ユーザーが Persona コンポーネントのレンダリングをカスタマイズできるようにするカスタム レンダリング コールバック。
ParticipantListParticipant

参加者リストに表示される参加者。
ParticipantListProps

ParticipantList の Props。
ParticipantListSelector

ParticipantList コンポーネントのセレクターの種類。
ParticipantMenuItemsCallback

ParticipantList の各参加者にカスタム メニュー項目を提供するためのコールバック。
ParticipantState

通話参加者の接続状態。
ParticipantsAddedListener

ChatAdapterSubscribers 'participantsAdded' イベントのコールバック。
ParticipantsButtonSelector

ParticipantsButton コンポーネントのセレクターの種類。
ParticipantsJoinedListener

CallAdapterSubscribers 'participantsJoined' イベントのコールバック。
ParticipantsLeftListener

CallAdapterSubscribers 'participantsLeft' イベントのコールバック。
ParticipantsRemovedListener

ChatAdapterSubscribers 'participantsRemoved' イベントのコールバック。
ReadReceiptsBySenderId

各送信者の表示名と最後の読み取りメッセージを格納するキー値ペアの配列
ScreenShareButtonSelector

ScreenShareButton コンポーネントのセレクターの種類。
Selector

このライブラリ内の React コンポーネントのプロパティに ClientState 更新プログラムを絞り込む最適化されたセレクター。
SendBoxSelector

SendBox コンポーネントのセレクターの種類。
StatefulCallClientArgs

StatefulCallClient を構築するための引数。
StatefulCallClientOptions

StatefulCallClient を作成するオプション。
StatefulChatClientArgs

StatefulChatClient を構築するための引数。
StatefulChatClientOptions

StatefulChatClient を構築するためのオプション。
SystemMessage

すべてのシステム メッセージの判別共用体。

フィールドは systemMessageType 共用体バリアントに特化しています。
TopicChangedListener

ChatAdapterSubscribers 'topicChanged' イベントのコールバック。
TypingIndicatorSelector

TypingIndicator コンポーネントのセレクターの種類。
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)

エクスペリエンスを呼び出すためのカスタマイズ可能な UI 複合。
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)

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

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

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

呼び出しコントロールのさまざまなボタンのコンテナー。

このライブラリのさまざまな呼び出しコントロール ボタン ( CameraButton、 ControlBarButton の独自のインスタンスなど) を直接使用します。
ControlBarButton(ControlBarButtonProps)

ControlBar の既定のボタン スタイル。

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

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

ControlBar と共に使用できます。
EndCallButton(EndCallButtonProps)

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

ControlBar と共に使用できます。
ErrorBar(ErrorBarProps)

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

このコンポーネントは、ユーザーによって無視されたを内部的に追跡します。

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

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

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

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

このライブラリの React コンポーネントにローカライズされた文字列を提供するプロバイダー。
MessageStatusIndicator(MessageStatusIndicatorProps)

送信されたメッセージの状態を表示するコンポーネント。

メッセージの状態に対応するアイコンとツールヒントを追加します。
MessageThread(MessageThreadProps)

MessageThread を使用すると、チャット メッセージをレンダリングしたり、新旧メッセージのスクロール動作を処理したり、チャット スレッド内のコントロール & アイコンをカスタマイズしたりするためのコンポーネントを簡単に作成できます。
MicrophoneButton(MicrophoneButtonProps)

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

ControlBar と共に使用できます。
ParticipantItem(ParticipantItemProps)

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

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

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

既定では、各参加者は ParticipantItem でレンダリングされます。 オーバーライドする方法に関するページを参照してください <xref:ParticipantListProps.onRenderParticipant> 。
ParticipantsButton(ParticipantsButtonProps)

通話またはチャットの参加者を含むメニューを表示するボタン。

ControlBar と共に使用できます。

このボタンには、そのプロパティ menuPropsを使用して定義されたドロップダウン メニュー項目が含まれています。 既定では、完全なリストを持つリモート参加者の数をサブメニューとして表示し、すべての参加者をミュートするオプションと、呼び出しの招待 URL をコピーするためのクリップボードへのコピー ボタンを表示できます。 これは menuProps 完全に再定義でき、そのプロパティの型は IContextualMenuProps です。
ScreenShareButton(ScreenShareButtonProps)

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

ControlBar と共に使用できます。
SendBox(SendBoxProps)

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

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

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

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

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

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

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

VideoGallery で GridLayout と共に使用します。
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Azure Communication Servicesでサポートされる CallAdapter を作成します。

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

注: displayName 最大 256 文字を指定できます。
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

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

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

Azure Communication Services によってサポートされる CallWithChatAdapter を作成して、 CallWithChatComposite にプラグインします。
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

指定された StatefulChatClient と StatefulCallClient を使用して CallWithChatAdapterを作成します。

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

Azure Communication Servicesでサポートされる ChatAdapter を作成します。

これは、このライブラリによって提供される ChatAdapter の既定の実装です。
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

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

StatefulChatClient への参照を保持する場合に便利です。 よりシンプルな API には createAzureCommunicationChatAdapter を使用することを検討してください。
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Teams 通話用の CallingHandlers の既定の実装を作成します。

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

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

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

返されたオブジェクトは、React コンポーネントの props として使用される場合に再レンダリングを回避するためにメモされています。
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

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

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

toFlatCommunicationIdentifier の逆操作。
getCallingSelector<Component>(Component)

指定したコンポーネントのセレクターを取得します。

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

指定したコンポーネントのセレクターを取得します。

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

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

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

  • 外部データベースにユーザーの ID を保持するために使用できます。
  • ユーザーのデータを格納するための Map へのキーとして使用できます。
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (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 コンポーネントに必要なすべてのフックを取得するためのプライマリ フック。

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

  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)

エクスペリエンスを呼び出すためのカスタマイズ可能な 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

ChatClientProvider(ChatClientProviderProps)

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

このパッケージのチャット コンポーネントは、 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

EndCallButton(EndCallButtonProps)

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

ControlBar と共に使用できます。

function EndCallButton(props: EndCallButtonProps): Element

パラメーター

props
EndCallButtonProps

戻り値

Element

ErrorBar(ErrorBarProps)

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

このコンポーネントは、ユーザーによって無視されたを内部的に追跡します。

  • 関連付けられたタイムスタンプを持つエラー: このエラーは、無視された後に発生した場合に UI に再度表示されます。
  • タイムスタンプのないエラー: エラーは、props から消えるまで無視されます。 エラーが繰り返される場合は、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、コントロール、および Fluent React Northstar コントロールから構成されます。 このプロバイダーは、基になる Fluent UI コントロールと Fluent React Northstar コントロールの両方に提供されるテーマの適用を処理します。

GridLayout(GridLayoutProps)

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

function GridLayout(props: GridLayoutProps): Element

パラメーター

props
GridLayoutProps

戻り値

Element

LocalizationProvider(LocalizationProviderProps)

このライブラリの React コンポーネントにローカライズされた文字列を提供するプロバイダー。

function LocalizationProvider(props: LocalizationProviderProps): Element

パラメーター

props
LocalizationProviderProps

戻り値

Element

注釈

このプロバイダーが使用されていない場合、コンポーネントは既定で英語 (米国) でローカライズされた文字列が提供されます。

MessageStatusIndicator(MessageStatusIndicatorProps)

送信されたメッセージの状態を表示するコンポーネント。

メッセージの状態に対応するアイコンとツールヒントを追加します。

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

パラメーター

props
MessageStatusIndicatorProps

戻り値

Element

MessageThread(MessageThreadProps)

MessageThread を使用すると、チャット メッセージをレンダリングしたり、新旧メッセージのスクロール動作を処理したり、チャット スレッド内のコントロール & アイコンをカスタマイズしたりするためのコンポーネントを簡単に作成できます。

function MessageThread(props: MessageThreadProps): Element

パラメーター

props
MessageThreadProps

MessageThreadProps 型の

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

MessageThread では、 の Chat & Chat.Message コンポーネント @fluentui/react-northstarが内部的に使用されます。 これら 2 つのコンポーネントの詳細をチェックアウトできます。

戻り値

Element

MicrophoneButton(MicrophoneButtonProps)

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

ControlBar と共に使用できます。

function MicrophoneButton(props: MicrophoneButtonProps): Element

パラメーター

props
MicrophoneButtonProps

戻り値

Element

ParticipantItem(ParticipantItemProps)

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

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

function ParticipantItem(props: ParticipantItemProps): Element

パラメーター

props
ParticipantItemProps

戻り値

Element

ParticipantList(ParticipantListProps)

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

既定では、各参加者は 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 要素に変換するユーティリティ コンポーネント。

ヘッドレス呼び出し 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 と、通話に参加したリモート参加者ごとに 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(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>

パラメーター

__namedParameters
AzureCommunicationCallAdapterArgs

戻り値

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

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

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

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

パラメーター

callClient
StatefulCallClient
callAgent
CallAgent
locator
CallAdapterLocator

戻り値

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Azure Communication Services によってサポートされる CallWithChatAdapter を作成して、 CallWithChatComposite にプラグインします。

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

パラメーター

__namedParameters
AzureCommunicationCallWithChatAdapterArgs

戻り値

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

指定された StatefulChatClient と StatefulCallClient を使用して CallWithChatAdapterを作成します。

StatefulChatClient と StatefulCallClient への参照を保持する場合に便利です。 よりシンプルな 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)

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

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

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

パラメーター

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

戻り値

Promise<ChatAdapter>

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

Teams 通話用の CallingHandlers の既定の実装を作成します。

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

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

パラメーター

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

戻り値

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

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

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

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

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

パラメーター

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

戻り値

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

状態の変更を <xref:%40azure%2Fcommunication-calling%23DeviceManager> 適切にプロキシするには、StatefulCallClient から取得された と <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 をプロキシすることでステートフル ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient>StatefulChatClient を作成し、<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 ユーザーに対して安定することが保証されます。 したがって

  • 外部データベースにユーザーの ID を保持するために使用できます。
  • ユーザーのデータを格納するための Map へのキーとして使用できます。
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

パラメーター

identifier
CommunicationIdentifier

戻り値

string

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

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

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

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

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

  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