Compartilhar via

CallClientState interface

  • Referência
Pacote:
@azure/communication-react

Contêiner para todos os dados de estado com proxy por StatefulCallClient. Os estados calls, callsEnded, incomingCalls e incomingCallsEnded serão fornecidos automaticamente se um callAgent tiver sido criado. O deviceManager estará vazio inicialmente até que seja preenchido, consulte DeviceManagerState. O estado userId é fornecido como uma conveniência para o desenvolvedor e é completamente controlado e definido pelo desenvolvedor.

Propriedades

callAgent

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

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> como um objeto com campos CallState CallState . Ela é chaveada por <xref:%40azure%2Fcommunication-calling%23Call.id>. Observe que <xref:%40azure%2Fcommunication-calling%23Call.id> isso pode mudar. Você não deve armazenar em cache a ID em si, mas a inteira <xref:%40azure%2Fcommunication-calling%23Call> e, em seguida, usar a ID contida para pesquisar dados neste mapa.
callsEnded

As chamadas que terminaram são armazenadas aqui para que o callEndReason possa ser verificado. É um objeto com <xref:%40azure%2Fcommunication-calling%23Call.id> chaves e valores CallState .

Somente <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são removidas, se necessário.
deviceManager

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

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> como um objeto com <xref:IncomingCall> campos. Ela é chaveada por <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.
incomingCallsEnded

As chamadas de entrada que terminaram são armazenadas aqui para que o callEndReason possa ser verificado. É um como um objeto com <xref:%40azure%2Fcommunication-calling%23Call.id> chaves e <xref:IncomingCall> valores.

Somente <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são removidas, se necessário.
latestErrors

Armazena o erro mais recente para cada método de API.

Confira a documentação do {@Link CallErrors} para obter detalhes.
userId

Armazena uma userId. Isso não é usado pelo StatefulCallClient e é fornecido aqui como uma conveniência para o desenvolvedor para facilitar o acesso a userId. Deve ser passado na inicialização do StatefulCallClient. Totalmente controlado pelo desenvolvedor.

Detalhes da propriedade

callAgent

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

callAgent?: CallAgentState

Valor da propriedade

CallAgentState

calls

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> como um objeto com campos CallState CallState . Ela é chaveada por <xref:%40azure%2Fcommunication-calling%23Call.id>. Observe que <xref:%40azure%2Fcommunication-calling%23Call.id> isso pode mudar. Você não deve armazenar em cache a ID em si, mas a inteira <xref:%40azure%2Fcommunication-calling%23Call> e, em seguida, usar a ID contida para pesquisar dados neste mapa.

calls: {[key: string]: CallState}

Valor da propriedade

{[key: string]: CallState}

callsEnded

As chamadas que terminaram são armazenadas aqui para que o callEndReason possa ser verificado. É um objeto com <xref:%40azure%2Fcommunication-calling%23Call.id> chaves e valores CallState .

Somente <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são removidas, se necessário.

callsEnded: {[key: string]: CallState}

Valor da propriedade

{[key: string]: CallState}

deviceManager

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

deviceManager: DeviceManagerState

Valor da propriedade

DeviceManagerState

incomingCalls

Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> como um objeto com <xref:IncomingCall> campos. Ela é chaveada por <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.

incomingCalls: {[key: string]: IncomingCallState}

Valor da propriedade

{[key: string]: IncomingCallState}

incomingCallsEnded

As chamadas de entrada que terminaram são armazenadas aqui para que o callEndReason possa ser verificado. É um como um objeto com <xref:%40azure%2Fcommunication-calling%23Call.id> chaves e <xref:IncomingCall> valores.

Somente <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são removidas, se necessário.

incomingCallsEnded: {[key: string]: IncomingCallState}

Valor da propriedade

{[key: string]: IncomingCallState}

latestErrors

Armazena o erro mais recente para cada método de API.

Confira a documentação do {@Link CallErrors} para obter detalhes.

latestErrors: CallErrors

Valor da propriedade

CallErrors

userId

Armazena uma userId. Isso não é usado pelo StatefulCallClient e é fornecido aqui como uma conveniência para o desenvolvedor para facilitar o acesso a userId. Deve ser passado na inicialização do StatefulCallClient. Totalmente controlado pelo desenvolvedor.

userId: CommunicationIdentifierKind

Valor da propriedade

CommunicationIdentifierKind