Partager via

CallClientState interface

  • Référence
Paquet:
@azure/communication-react

Conteneur pour toutes les données d’état proxiées par StatefulCallClient. Les états appels, callsEnded, incomingCalls et incomingCallsEnded sont automatiquement fournis si un callAgent a été créé. Le deviceManager sera vide initialement jusqu’à ce que le champ soit rempli, voir DeviceManagerState. L’état userId est fourni à titre pratique pour le développeur et est entièrement controlé et défini par le développeur.

Propriétés

callAgent

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Passez en revue CallAgentState.
calls

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> en tant qu’objet avec des champs CallState CallState . Il est clé par <xref:%40azure%2Fcommunication-calling%23Call.id>. Notez que cela <xref:%40azure%2Fcommunication-calling%23Call.id> peut changer. Vous ne devez pas mettre en cache l’ID lui-même, mais l’ensemble <xref:%40azure%2Fcommunication-calling%23Call> , puis utiliser l’ID contenu pour rechercher les données dans cette carte.
callsEnded

Les appels qui se sont terminés sont stockés ici afin que le callEndReason puisse être vérifié. Il s’agit d’un objet avec <xref:%40azure%2Fcommunication-calling%23Call.id> des clés et CallState des valeurs. Seuls les <xref:MAX_CALL_HISTORY_LENGTH> appels sont conservés dans l’historique. Les appels les plus anciens sont supprimés si nécessaire.
deviceManager

Proxy de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Passez en revue DeviceManagerState.
incomingCalls

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> en tant qu’objet avec <xref:IncomingCall> des champs. Il est clé par <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.
incomingCallsEnded

Les appels entrants qui se sont terminés sont stockés ici afin que le callEndReason puisse être vérifié. Il s’agit d’un objet en tant qu’objet avec <xref:%40azure%2Fcommunication-calling%23Call.id> des clés et <xref:IncomingCall> des valeurs. Seuls les <xref:MAX_CALL_HISTORY_LENGTH> appels sont conservés dans l’historique. Les appels les plus anciens sont supprimés si nécessaire.
latestErrors

Stocke l’erreur la plus récente pour chaque méthode d’API. Pour plus d’informations, consultez la documentation de {@Link CallErrors}.
userId

Stocke un userId. Cela n’est pas utilisé par et StatefulCallClient est fourni ici à titre pratique pour le développeur pour faciliter l’accès à userId. Doit être passé lors de l’initialisation StatefulCallClientdu . Entièrement contrôlé par le développeur.

Détails de la propriété

callAgent

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Passez en revue CallAgentState.

callAgent?: CallAgentState

Valeur de propriété

CallAgentState

calls

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> en tant qu’objet avec des champs CallState CallState . Il est clé par <xref:%40azure%2Fcommunication-calling%23Call.id>. Notez que cela <xref:%40azure%2Fcommunication-calling%23Call.id> peut changer. Vous ne devez pas mettre en cache l’ID lui-même, mais l’ensemble <xref:%40azure%2Fcommunication-calling%23Call> , puis utiliser l’ID contenu pour rechercher les données dans cette carte.

calls: [key: string]: CallState

Valeur de propriété

[key: string]: CallState

callsEnded

Les appels qui se sont terminés sont stockés ici afin que le callEndReason puisse être vérifié. Il s’agit d’un objet avec <xref:%40azure%2Fcommunication-calling%23Call.id> des clés et CallState des valeurs. Seuls les <xref:MAX_CALL_HISTORY_LENGTH> appels sont conservés dans l’historique. Les appels les plus anciens sont supprimés si nécessaire.

callsEnded: [key: string]: CallState

Valeur de propriété

[key: string]: CallState

deviceManager

Proxy de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Passez en revue DeviceManagerState.

deviceManager: DeviceManagerState

Valeur de propriété

DeviceManagerState

incomingCalls

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> en tant qu’objet avec <xref:IncomingCall> des champs. Il est clé par <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.

incomingCalls: [key: string]: IncomingCallState

Valeur de propriété

[key: string]: IncomingCallState

incomingCallsEnded

Les appels entrants qui se sont terminés sont stockés ici afin que le callEndReason puisse être vérifié. Il s’agit d’un objet en tant qu’objet avec <xref:%40azure%2Fcommunication-calling%23Call.id> des clés et <xref:IncomingCall> des valeurs. Seuls les <xref:MAX_CALL_HISTORY_LENGTH> appels sont conservés dans l’historique. Les appels les plus anciens sont supprimés si nécessaire.

incomingCallsEnded: [key: string]: IncomingCallState

Valeur de propriété

[key: string]: IncomingCallState

latestErrors

Stocke l’erreur la plus récente pour chaque méthode d’API. Pour plus d’informations, consultez la documentation de {@Link CallErrors}.

latestErrors: CallErrors

Valeur de propriété

CallErrors

userId

Stocke un userId. Cela n’est pas utilisé par et StatefulCallClient est fourni ici à titre pratique pour le développeur pour faciliter l’accès à userId. Doit être passé lors de l’initialisation StatefulCallClientdu . Entièrement contrôlé par le développeur.

userId: CommunicationIdentifierKind

Valeur de propriété

CommunicationIdentifierKind