CallClientState.yml

### YamlMime:TSType
name: CallClientState
uid: '@azure/communication-react.CallClientState'
package: '@azure/communication-react'
summary: >-
  Container for all of the state data proxied by <xref:StatefulCallClient>. The
  calls, callsEnded, incomingCalls, and

  incomingCallsEnded states will be automatically provided if a callAgent has
  been created. The deviceManager will be

  empty initially until populated see <xref:DeviceManagerState>. The userId
  state is provided as a convenience for the

  developer and is completely controled and set by the developer.
fullName: CallClientState
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: callAgent
    uid: '@azure/communication-react.CallClientState.callAgent'
    package: '@azure/communication-react'
    summary: >-
      Proxy of <xref:%40azure%2Fcommunication-calling%23CallAgent>. Please
      review <xref:CallAgentState>.
    fullName: callAgent
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'callAgent?: CallAgentState'
      return:
        type: <xref uid="@azure/communication-react.CallAgentState" />
        description: ''
  - name: calls
    uid: '@azure/communication-react.CallClientState.calls'
    package: '@azure/communication-react'
    summary: >-
      Proxy of <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> as an
      object with CallState <xref:CallState> fields.

      It is keyed by <xref:%40azure%2Fcommunication-calling%23Call.id>. Please
      note that

      <xref:%40azure%2Fcommunication-calling%23Call.id> could change. You should
      not cache the id itself but the entire

      <xref:%40azure%2Fcommunication-calling%23Call> and then use the id
      contained to look up data in this map.
    fullName: calls
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'calls: [key: string]: CallState'
      return:
        type: '[key: string]\: <xref uid="@azure/communication-react.CallState" />'
        description: ''
  - name: callsEnded
    uid: '@azure/communication-react.CallClientState.callsEnded'
    package: '@azure/communication-react'
    summary: >
      Calls that have ended are stored here so the callEndReason could be
      checked.

      It is an object with <xref:%40azure%2Fcommunication-calling%23Call.id>
      keys and <xref:CallState> values.

      Only <xref:MAX_CALL_HISTORY_LENGTH> Calls are kept in the history. Oldest
      calls are evicted if required.
    fullName: callsEnded
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'callsEnded: [key: string]: CallState'
      return:
        type: '[key: string]\: <xref uid="@azure/communication-react.CallState" />'
        description: ''
  - name: deviceManager
    uid: '@azure/communication-react.CallClientState.deviceManager'
    package: '@azure/communication-react'
    summary: >-
      Proxy of <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Please
      review <xref:DeviceManagerState>.
    fullName: deviceManager
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'deviceManager: DeviceManagerState'
      return:
        type: <xref uid="@azure/communication-react.DeviceManagerState" />
        description: ''
  - name: incomingCalls
    uid: '@azure/communication-react.CallClientState.incomingCalls'
    package: '@azure/communication-react'
    summary: >-
      Proxy of <xref:%40azure%2Fcommunication-calling%23IncomingCall> as an
      object with <xref:IncomingCall> fields.

      It is keyed by <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.
    fullName: incomingCalls
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'incomingCalls: [key: string]: IncomingCallState'
      return:
        type: >-
          [key: string]\: <xref
          uid="@azure/communication-react.IncomingCallState" />
        description: ''
  - name: incomingCallsEnded
    uid: '@azure/communication-react.CallClientState.incomingCallsEnded'
    package: '@azure/communication-react'
    summary: >
      Incoming Calls that have ended are stored here so the callEndReason could
      be checked.

      It is an as an object with
      <xref:%40azure%2Fcommunication-calling%23Call.id> keys and
      <xref:IncomingCall> values.

      Only <xref:MAX_CALL_HISTORY_LENGTH> Calls are kept in the history. Oldest
      calls are evicted if required.
    fullName: incomingCallsEnded
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'incomingCallsEnded: [key: string]: IncomingCallState'
      return:
        type: >-
          [key: string]\: <xref
          uid="@azure/communication-react.IncomingCallState" />
        description: ''
  - name: latestErrors
    uid: '@azure/communication-react.CallClientState.latestErrors'
    package: '@azure/communication-react'
    summary: |
      Stores the latest error for each API method.
      See documentation of {@Link CallErrors} for details.
    fullName: latestErrors
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'latestErrors: CallErrors'
      return:
        type: <xref uid="@azure/communication-react.CallErrors" />
        description: ''
  - name: userId
    uid: '@azure/communication-react.CallClientState.userId'
    package: '@azure/communication-react'
    summary: >-
      Stores a userId. This is not used by the <xref:StatefulCallClient> and is
      provided here as a convenience for the

      developer for easier access to userId. Must be passed in at initialization
      of the <xref:StatefulCallClient>.

      Completely controlled by the developer.
    fullName: userId
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'userId: CommunicationUserKind'
      return:
        type: CommunicationUserKind
        description: ''