CallClientState interface

パッケージ:

@azure/communication-react

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

プロパティ

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

プロパティの詳細

alternateCallerId

発信者の ID を表すために使用される E.164 形式の電話番号。 たとえば、alternateCallerId を使用して PSTN を使用して参加者を追加すると、この番号は PSTN 通話の発信者 ID として使用されます。

alternateCallerId?: string

プロパティ値

string

callAgent

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

callAgent?: CallAgentState

プロパティ値

CallAgentState

calls

CallState <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> フィールドを持つオブジェクトとしての のプロキシ。 それは <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 を確認できます。 これは、<xref:%40azure%2Fcommunication-calling%23Call.id> キーと CallState 値 持つオブジェクトです。

<xref:MAX_CALL_HISTORY_LENGTH> 通話のみが履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。

callsEnded: {[key: string]: CallState}

プロパティ値

{[key: string]: CallState}

deviceManager

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

deviceManager: DeviceManagerState

プロパティ値

DeviceManagerState

environmentInfo

ステートフル クライアントが作成された環境を追跡するための state がサポートされています

environmentInfo?: EnvironmentInfo

プロパティ値

EnvironmentInfo

incomingCalls

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

incomingCalls: {[key: string]: IncomingCallState | TeamsIncomingCallState}

プロパティ値

{[key: string]: IncomingCallState | TeamsIncomingCallState}

incomingCallsEnded

終了した着信呼び出しは、callEndReason を確認できるようにここに格納されます。 これは、<xref:%40azure%2Fcommunication-calling%23Call.id> キーと <xref:IncomingCall> 値を持つオブジェクトとして使用されます。

<xref:MAX_CALL_HISTORY_LENGTH> 通話のみが履歴に保持されます。 必要に応じて、最も古い呼び出しが削除されます。

incomingCallsEnded: {[key: string]: IncomingCallState | TeamsIncomingCallState}

プロパティ値

{[key: string]: IncomingCallState | TeamsIncomingCallState}

latestErrors

各 API メソッドの最新のエラーを格納します。

詳細については、{@Link CallErrors} のドキュメントを参照してください。

latestErrors: CallErrors

プロパティ値

CallErrors

latestNotifications

最新の通知を格納します。

詳細については、{@Link CallNotifications} のドキュメントを参照してください。

latestNotifications: CallNotifications

プロパティ値

CallNotifications

userId

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

userId: CommunicationIdentifierKind

プロパティ値

CommunicationIdentifierKind