CallClientState interface

Pacote:

@azure/communication-react

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

Propriedades

alternateCallerId	Um número de telefone no formato E.164 que será usado para representar a identidade dos chamadores. Por exemplo, usando o alternateCallerId para adicionar um participante usando PSTN, esse número será usado como o ID do chamador na chamada PSTN.
callAgent	Procuração de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Consulte CallAgentState.
calls	Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> como um objeto com campos de CallState CallState. É chaveado por <xref:%40azure%2Fcommunication-calling%23Call.id>. Por favor, note que <xref:%40azure%2Fcommunication-calling%23Call.id> pode mudar. Você não deve armazenar em cache o id em si, mas todo o <xref:%40azure%2Fcommunication-calling%23Call> e, em seguida, usar o id contido para procurar 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 de CallState. Apenas <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são despejadas, se necessário.
deviceManager	Procuração de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Consulte DeviceManagerState.
environmentInfo	estado para controlar o ambiente em que o cliente stateful foi criado é suportado
incomingCalls	Proxy de <xref:%40azure%2Fcommunication-calling%23IncomingCall> como um objeto com campos <xref:IncomingCall>. É chaveado por <xref:%40azure%2Fcommunication-calling%23IncomingCall.id>.
incomingCallsEnded	As chamadas recebidas 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. Apenas <xref:MAX_CALL_HISTORY_LENGTH> chamadas são mantidas no histórico. As chamadas mais antigas são despejadas, se necessário.
latestErrors	Armazena o erro mais recente para cada método de API. Consulte a documentação de {@Link CallErrors} para obter detalhes.
latestNotifications	Armazena as notificações mais recentes. Consulte a documentação de {@Link CallNotifications} para obter detalhes.
userId	Armazena um userId. Isso não é usado pelo StatefulCallClient e é fornecido aqui como uma conveniência para o desenvolvedor para facilitar o acesso ao userId. Deve ser passado na inicialização do StatefulCallClient. Completamente controlado pelo desenvolvedor.

Detalhes de Propriedade

alternateCallerId

Um número de telefone no formato E.164 que será usado para representar a identidade dos chamadores. Por exemplo, usando o alternateCallerId para adicionar um participante usando PSTN, esse número será usado como o ID do chamador na chamada PSTN.

alternateCallerId?: string

Valor de Propriedade

string

callAgent

Procuração de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Consulte CallAgentState.

callAgent?: CallAgentState

Valor de Propriedade

CallAgentState

calls

Proxy de <xref:%40azure%2Fcommunication-calling%23CallAgent.calls> como um objeto com campos de CallState CallState. É chaveado por <xref:%40azure%2Fcommunication-calling%23Call.id>. Por favor, note que <xref:%40azure%2Fcommunication-calling%23Call.id> pode mudar. Você não deve armazenar em cache o id em si, mas todo o <xref:%40azure%2Fcommunication-calling%23Call> e, em seguida, usar o id contido para procurar dados neste mapa.

calls: {[key: string]: CallState}

Valor de 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 de CallState.

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

callsEnded: {[key: string]: CallState}

Valor de Propriedade

{[key: string]: CallState}

deviceManager

Procuração de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Consulte DeviceManagerState.

deviceManager: DeviceManagerState

Valor de Propriedade

DeviceManagerState

environmentInfo

estado para controlar o ambiente em que o cliente stateful foi criado é suportado

environmentInfo?: EnvironmentInfo

Valor de Propriedade

EnvironmentInfo

incomingCalls

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

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

Valor de Propriedade

{[key: string]: IncomingCallState | TeamsIncomingCallState}

incomingCallsEnded

As chamadas recebidas 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.

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

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

Valor de Propriedade

{[key: string]: IncomingCallState | TeamsIncomingCallState}

latestErrors

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

Consulte a documentação de {@Link CallErrors} para obter detalhes.

latestErrors: CallErrors

Valor de Propriedade

CallErrors

latestNotifications

Armazena as notificações mais recentes.

Consulte a documentação de {@Link CallNotifications} para obter detalhes.

latestNotifications: CallNotifications

Valor de Propriedade

CallNotifications

userId

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

userId: CommunicationIdentifierKind

Valor de Propriedade

CommunicationIdentifierKind