Partager via

CallClientState interface

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

Conteneur pour toutes les données d’état proxiées par StatefulCallClient. Les appels, appelsEnded, incomingCalls et les états incomingCallsEnded sont automatiquement fournis si un callAgent a été créé. DeviceManager sera vide initialement jusqu’à ce qu’il soit renseigné DeviceManagerState. L’état userId est fourni comme commodité pour le développeur et est complètement controlé et défini par le développeur.

Propriétés

callAgent

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Veuillez consulter CallAgentState.
calls

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

Les appels qui se sont terminés sont stockés ici afin que l’appelEndReason puisse être vérifié. Il s’agit d’un objet avec des clés <xref:%40azure%2Fcommunication-calling%23Call.id> et des valeurs CallState.

Seuls les appels <xref:MAX_CALL_HISTORY_LENGTH> 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>. Veuillez consulter DeviceManagerState.
incomingCalls

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> en tant qu’objet avec des champs <xref:IncomingCall>. 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 l’appelEndReason puisse être vérifié. Il s’agit d’un objet avec des clés <xref:%40azure%2Fcommunication-calling%23Call.id> et des valeurs <xref:IncomingCall>.

Seuls les appels <xref:MAX_CALL_HISTORY_LENGTH> sont conservés dans l’historique. Les appels les plus anciens sont supprimés si nécessaire.
latestErrors

Stocke la dernière erreur 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 l'StatefulCallClient et est fourni ici comme commodité pour le développeur pour faciliter l’accès à userId. Doit être passé lors de l’initialisation du StatefulCallClient. Complètement contrôlé par le développeur.

Détails de la propriété

callAgent

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Veuillez consulter CallAgentState.

callAgent?: CallAgentState

Valeur de propriété

CallAgentState

calls

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> en tant qu’objet avec les champs CallState CallState. Il est clé par <xref:%40azure%2Fcommunication-calling%23Call.id>. Veuillez noter que <xref:%40azure%2Fcommunication-calling%23Call.id> pourrait changer. Vous ne devez pas mettre en cache l’ID lui-même, mais l’ensemble de la <xref:%40azure%2Fcommunication-calling%23Call>, puis utiliser l’ID contenu pour rechercher des 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 l’appelEndReason puisse être vérifié. Il s’agit d’un objet avec des clés <xref:%40azure%2Fcommunication-calling%23Call.id> et des valeurs CallState.

Seuls les appels <xref:MAX_CALL_HISTORY_LENGTH> 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>. Veuillez consulter DeviceManagerState.

deviceManager: DeviceManagerState

Valeur de propriété

DeviceManagerState

incomingCalls

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> en tant qu’objet avec des champs <xref:IncomingCall>. 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 l’appelEndReason puisse être vérifié. Il s’agit d’un objet avec des clés <xref:%40azure%2Fcommunication-calling%23Call.id> et des valeurs <xref:IncomingCall>.

Seuls les appels <xref:MAX_CALL_HISTORY_LENGTH> 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 la dernière erreur 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 l'StatefulCallClient et est fourni ici comme commodité pour le développeur pour faciliter l’accès à userId. Doit être passé lors de l’initialisation du StatefulCallClient. Complètement contrôlé par le développeur.

userId: CommunicationIdentifierKind

Valeur de propriété

CommunicationIdentifierKind