CallClientState interface

パッケージ:

@azure/communication-react

によって StatefulCallClientプロキシされるすべての状態データのコンテナー。 callAgent が作成されると、calls、callsEnded、incomingCalls、および incomingCallsEnded の各状態が自動的に提供されます。 deviceManager は、 が表示 DeviceManagerStateされるまで最初は空になります。 userId 状態は開発者にとって便利な機能として提供され、開発者によって完全に制御および設定されます。

プロパティ

callAgent	の <xref:%40azure%2Fcommunication-calling%23CallAgent>プロキシ。 を確認 CallAgentStateしてください。
calls	<xref:%40azure%2Fcommunication-calling%23CallAgent.calls> CallState CallState フィールドを持つオブジェクトとしての のプロキシ。 キーは によって行 <xref:%40azure%2Fcommunication-calling%23Call.id>われます。 変更される可能性があることに <xref:%40azure%2Fcommunication-calling%23Call.id> 注意してください。 ID 自体ではなく全体 <xref:%40azure%2Fcommunication-calling%23Call> をキャッシュし、含まれている ID を使用してこのマップ内のデータを検索する必要があります。
callsEnded	終了した呼び出しは、callEndReason を確認できるようにここに格納されます。 これは、キーとCallState値を持つ<xref:%40azure%2Fcommunication-calling%23Call.id>オブジェクトです。 通話のみが <xref:MAX_CALL_HISTORY_LENGTH> 履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。
deviceManager	の <xref:%40azure%2Fcommunication-calling%23DeviceManager>プロキシ。 を確認 DeviceManagerStateしてください。
incomingCalls	<xref:%40azure%2Fcommunication-calling%23IncomingCall>フィールドを持つ<xref:IncomingCall>オブジェクトとしての のプロキシ。 キーは によって行 <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>われます。
incomingCallsEnded	終了した着信呼び出しは、callEndReason を確認できるようにここに格納されます。 これは、キーと<xref:IncomingCall>値を持つ<xref:%40azure%2Fcommunication-calling%23Call.id>オブジェクトとしての です。 通話のみが <xref:MAX_CALL_HISTORY_LENGTH> 履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。
latestErrors	各 API メソッドの最新のエラーを格納します。 詳細については、{@Link CallErrors} のドキュメントを参照してください。
userId	userId を格納します。 これは によって StatefulCallClient 使用されるのではなく、userId に簡単にアクセスできるように開発者にとって便利な方法としてここで提供されています。 の初期化 StatefulCallClient時に を渡す必要があります。 開発者によって完全に制御されます。

プロパティの詳細

callAgent

の <xref:%40azure%2Fcommunication-calling%23CallAgent>プロキシ。 を確認 CallAgentStateしてください。

callAgent?: CallAgentState

プロパティ値

CallAgentState

calls

<xref:%40azure%2Fcommunication-calling%23CallAgent.calls> CallState CallState フィールドを持つオブジェクトとしての のプロキシ。 キーは によって行 <xref:%40azure%2Fcommunication-calling%23Call.id>われます。 変更される可能性があることに <xref:%40azure%2Fcommunication-calling%23Call.id> 注意してください。 ID 自体ではなく全体 <xref:%40azure%2Fcommunication-calling%23Call> をキャッシュし、含まれている ID を使用してこのマップ内のデータを検索する必要があります。

calls: [key: string]: CallState

プロパティ値

[key: string]: CallState

callsEnded

終了した呼び出しは、callEndReason を確認できるようにここに格納されます。 これは、キーとCallState値を持つ<xref:%40azure%2Fcommunication-calling%23Call.id>オブジェクトです。 通話のみが <xref:MAX_CALL_HISTORY_LENGTH> 履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。

callsEnded: [key: string]: CallState

プロパティ値

[key: string]: CallState

deviceManager

の <xref:%40azure%2Fcommunication-calling%23DeviceManager>プロキシ。 を確認 DeviceManagerStateしてください。

deviceManager: DeviceManagerState

プロパティ値

DeviceManagerState

incomingCalls

<xref:%40azure%2Fcommunication-calling%23IncomingCall>フィールドを持つ<xref:IncomingCall>オブジェクトとしての のプロキシ。 キーは によって行 <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>われます。

incomingCalls: [key: string]: IncomingCallState

プロパティ値

[key: string]: IncomingCallState

incomingCallsEnded

終了した着信呼び出しは、callEndReason を確認できるようにここに格納されます。 これは、キーと<xref:IncomingCall>値を持つ<xref:%40azure%2Fcommunication-calling%23Call.id>オブジェクトとしての です。 通話のみが <xref:MAX_CALL_HISTORY_LENGTH> 履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。

incomingCallsEnded: [key: string]: IncomingCallState

プロパティ値

[key: string]: IncomingCallState

latestErrors

各 API メソッドの最新のエラーを格納します。 詳細については、{@Link CallErrors} のドキュメントを参照してください。

latestErrors: CallErrors

プロパティ値

CallErrors

userId

userId を格納します。 これは によって StatefulCallClient 使用されるのではなく、userId に簡単にアクセスできるように開発者にとって便利な方法としてここで提供されています。 の初期化 StatefulCallClient時に を渡す必要があります。 開発者によって完全に制御されます。

userId: CommunicationIdentifierKind

プロパティ値

CommunicationIdentifierKind