Mobile SDK Diagramas de evento
Esta página fornece diagramas e explicações de eventos comuns que ocorrem durante uma interação de chat.
Aplicativo fica ativo
Este diagrama de sequência captura o fluxo que ocorre quando o aplicativo móvel se torna ativo, prepara o chat, processa as informações do visitante e do cliente e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido e registrado adequadamente.
Abrir diagrama em uma nova janela ![]()
Estado inicial:
-
O status inicial do SDK é definido como initial.
-
O aplicativo móvel entra em primeiro plano.
Preparação de Chat:
-
O usuário inicia a preparação de chat chamando prepare(brandId:channelId:).
-
Se o estado do chat não for inicial ou offline, um IllegalChatStateError será retornado.
-
Caso contrário, o SDK define o estado do chat como preparing e notifica a interface do usuário com onChatUpdated().
Configuração do canal:
-
O SDK solicita a configuração do canal do back-end com getChannelConfiguration().
-
Se houver um erro de servidor, um ServerError é retornado e o estado do chat é redefinido para initialize.
-
Caso contrário, a configuração do canal será recebida, e o SDK criará um ID de destino.
-
Se o ID do visitante ou do cliente for null, eles são criados e armazenados localmente.
Atendimento de Visitantes e Cliente:
-
O SDK chama createOrUpdateVisitor(visitorId:customerId:deviceToken:) no back-end.
-
Se houver um erro de servidor, o estado do chat será redefinido para initialize.
-
Caso contrário, o atendimento de visitantes e clientes será bem-sucedido.
Estado de Chat preparado:
-
O estado do chat é definido como prepared.
-
A interface do usuário é notificada com onChatUpdated().
-
Os Analytics para exibições de página são rastreados entre o aplicativo móvel e o back-end.
Aplicativo entra em Plano de fundo
Este diagrama de sequência captura o fluxo quando o aplicativo móvel entra em plano de fundo, lida com o rastreamento de visualização de página e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente. Quando um aplicativo entra em plano de fundo, significa que ele não é mais a coisa principal que você vê ou com a qual interage no seu dispositivo. Imagine que você esteja usando um aplicativo de mensagens e, então, pressione o botão home ou mude para outro aplicativo. O aplicativo de mensagens agora está em segundo plano. Ainda está em execução, mas você não está utilizando-o ativamente. Isso ocorre quando você minimiza um aplicativo, muda para um aplicativo diferente ou bloqueia seu telefone. O aplicativo ainda está lá, mas não está mais em primeiro plano.
Aplicativo entrando em Plano de fundo:
-
A UI exibe uma caixa indicando que o aplicativo está entrando em plano de fundo.
-
A UI notifica o SDK de que a visualização da página foi encerrada usando pageViewEnded.
-
O back-end recebe o evento pageViewEnded.
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, o evento será bem-sucedido.
-
Desconexão e tratamento de Estado:
-
A interface do usuário inicia a desconexão usando disconnect().
-
Dependendo do estado atual:
-
Se estiver em preparação, o SDK definirá o estado como initial.
-
Se já estiver preparado, o SDK desconectará o soquete e definirá o estado como prepared.
-
Visualizar Página
Este diagrama de sequência representa o fluxo quando um usuário visualiza uma página no aplicativo móvel, incluindo interações com o SDK e os serviços de backend. Mostra o evento de análise quando um usuário visualiza uma página, rastreia detalhes da visita e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente.
Application Activation Reference:
-
O diagrama faz referência ao evento de ativação do aplicativo.
Evento de visualização de Página:
-
O usuário visualiza uma página, e a UI notifica o SDK com viewPage(title:url:).
-
O modo de chat está verificado:
-
Se não estiver preparado, um illegalChatStateError será retornado.
-
Caso contrário, a expiração dos detalhes da visita será verificada.
-
Se expirados, novos detalhes da visita serão criados (UUID e expiração).
-
Se forem válidos, o SDK ajustará a expiração atual.
-
-
Se a última página Visualizada não foi enviada, o SDK encerrará a visualização da página.
-
O título, o URI e o registro de data/hora da última página visualizada atualmente são armazenados.
-
Se houver uma falha, como um erro de servidor, ela será tratada.
-
Interação com o back-end:
-
O SDK se comunica com os serviços de back-end:
-
visitorVisit(date:) é chamado para gravar a visita.
-
pageView(title:uri:timestamp) é chamado para registrar a visualização da página.
-
Se houver um erro de servidor, ele será tratado.
-
Chat aberto
Este diagrama de sequência captura o fluxo quando um usuário abre o chat, trata OAuth e estabelece uma conexão com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente.
Referência de Ativação do aplicativo:
-
O diagrama faz referência ao evento de ativação do aplicativo.
Abertura de Chat:
-
O usuário do aplicativo abre o chat, e a interface do usuário inicia uma conexão com connect().
-
O estado do chat está verificado:
-
Se estiver conectando, o SDK estabelece uma conexão WebSocket.
-
Se for inicial ou em preparação, um IllegalChatStateError será retornado.
-
Se estiver preparado, o modo de chat é verificado:
-
Se for chat ao vivo e o status do chat ao vivo for Offline, o estado do chat será definido como offline.
-
Caso contrário, a conexão WebSocket é estabelecida.
-
O tratamento de OAuth depende se ele está ativado ou desativado.
-
-
OAuth Processamento:
-
Se OAuth estiver ativado:
-
O SDK se reconectará com reconnectCustomerEventData(accessToken:).
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, o CustomerReconnectedEvent será recebido.
-
-
Se OAuth estiver desativado:
-
O SDK autorizará com authorizeCustomerEventData(authorizationCode:codeVerifier:).
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, o CustomerAuthorizedEvent será recebido, e o token de acesso e a identidade do cliente serão armazenados.
-
Estado de chat conectado:
-
O estado do chat é definido como connected.
-
A interface do usuário é notificada com onChatUpdated().
-
Dependendo se o chat for de thread único
Em um aplicativo de thread única, cada contato tem uma thread de chat que gerencia qualquer interação que ele tenha com a sua organização. ou multithread
Em um aplicativo multithread, os contatos podem criar quantos threads quiserem para discutir novos tópicos. Esses threads podem estar ativos ao mesmo tempo., a visualização de chat relevante será exibida.
Single-thread
Este diagrama de sequência captura o fluxo quando um usuário interage com um chat single-thread
Em um aplicativo de thread única, cada contato tem uma thread de chat que gerencia qualquer interação que ele tenha com a sua organização., lida com a recuperação de thread e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente.
Referência de ativação do aplicativo:
-
O diagrama faz referência ao evento de abertura de chat.
Recuperação de conversas:
-
O SDK carrega o id da conversa do armazenamento local.
-
Se qualquer ID de conversa de uma plataforma externa for armazenado localmente, o SDK recuperará a conversa usando RecoverMessagingThreadEvent(threadId:).
-
Se nenhum UUID estiver disponível, O SDK tentará a recuperação com RecoverMessagingThreadEvent(nil).
Verificar existência de conversa:
-
Se a conversa existir, o ThreadRecoveredEvent será recebido.
-
Os estados do chat e da conversa serão definidos como ready.
-
A interface do usuário é notificada com onThreadUpdated().
-
-
Se a conversa não existir, o ThreadRecoverFailedEvent será recebido.
-
O estado do chat será definido como pronto.
-
A interface do usuário é notificada com onChatUpdated().
-
Uma nota indica que nenhuma recuperação de conversa é necessária.
-
Interação por Chat:
-
A interface do usuário exibe a janela de chat para o usuário interagir com um agente.
Multi-thread
Este diagrama de sequência captura o fluxo quando um usuário interage com um chat multithread
Em um aplicativo multithread, os contatos podem criar quantos threads quiserem para discutir novos tópicos. Esses threads podem estar ativos ao mesmo tempo., trata a recuperação de threads e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente.
Abrir diagrama em uma nova janela
Referência de Ativação do aplicativo:
-
O diagrama faz referência ao evento de abertura de chat.
Recuperação da lista de conversas:
-
O SDK busca a lista de conversas do back-end usando FetchThreadListEvent.
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, a lista de conversas será obtida.
Tratamento de conversas:
-
Se houver conversas:
-
O SDK define o estado de cada conversa como received e carrega as últimas mensagens.
-
Os metadados da conversa são carregados, e o estado é definido como loaded.
-
O estado do chat é definido como ready, e a interface do usuário é notificada.
-
-
Se não houver conversas:
-
O estado do chat é definido como ready, e a interface do usuário é notificada.
-
Criar ou abrir conversas:
-
Se estiver criando uma nova conversa:
-
O usuário iniciará a criação da conversa.
-
-
Se estiver abrindo uma conversa existente:
-
O usuário selecionará uma conversa.
-
A interface do usuário abre a conversa usando openThread(thread:).
-
A conversa será recuperada do back-end.
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, a conversa será recuperada, e o estado será definido como ready.
-
Interação por Chat:
-
O usuário interage com um agente por chat.
Chat ao Vivo
Este diagrama de sequência demonstra o fluxo de back-end de uma interação de Live Chat. O Live Chat é a opção de chat digital em tempo real, enquanto o Chat Messaging é a opção de mensagens assíncrona, que é semelhante a mensagens privadas ou mensagens diretas.
Criar conversa
Este diagrama de sequência captura o fluxo quando um usuário cria um novo tópico de chat, trata a criação do tópico e se comunica com o SDK. Se ocorrer algum erro, ele será resolvido adequadamente.
Detalhes do usuário e pré-chat:
-
Se o nome do cliente não for fornecido, a interface do usuário mostrará uma visualização de formulário de detalhes do usuário.
-
Se informações pré-chat estiverem disponíveis, a interface do usuário mostrará uma visualização de formulário pré-chat.
Criação de conversa:
-
O usuário iniciará uma conversa.
-
A interface do usuário inicia a criação da conversa usando createThread(customFields:).
-
Se o modo de chat não for multi-thread, e já existir uma conversa:
-
Um unsupportedChannelConfigError será retornado.
-
Um alerta de erro é exibido.
-
-
Caso contrário:
-
O SDK cria a conversa localmente com um UUID.
-
O UUID é armazenado localmente.
-
O estado da conversa é definido como pending.
-
A interface do usuário é notificada com onThreadUpdated().
-
Chat com um Agente
Este diagrama de sequência captura o fluxo quando um usuário final interage com um agente por meio de chat, trata mensagens de boas-vindas e se comunica com os serviços de back-end. Se ocorrer algum erro, ele será resolvido adequadamente.
Inicialização de Chat:
-
O usuário envia uma mensagem usando sendMessage(message:).
-
Se uma mensagem de boas-vindas estiver disponível:
-
O SDK enviará uma mensagem de boas-vindas usando SendOutboundMessageEvent(welcomeMessage:).
-
Se houver um erro de servidor, ele será resolvido.
-
Caso contrário, o MessageCreatedEvent é recebido, e a interface do usuário é atualizada.
-
-
O SDK enviará a mensagem do usuário usando sendMessageEvent.
-
Se houver um erro de servidor, ele será tratado.
-
Caso contrário, o MessageCreatedEvent é recebido, e a interface do usuário é atualizada.
-
Encerrar contato
Este diagrama de sequência captura o fluxo quando um usuário encerra um chat, trata o encerramento da conversa e se comunica com os serviços de backend. Se ocorrer algum erro, ele será resolvido adequadamente.
Encerramento de Chat:
-
O usuário clica em encerrar conversa.
-
A interface do usuário notifica o SDK para encerrar a conversa usando endConversation().
-
O back-end recebe o EndConversationEvent.
-
Se houver um erro de servidor, ele será tratado.
-
Caso contrário, o status do caso será alterado, e o estado da conversa será definido como closed.
-
A interface do usuário é notificada com onThreadUpdated().
-
Visualização da experiência de encerrar contato:
-
A interface do usuário exibe a visualização de encerrar contato.
Processar Eventos Grandes
Uma das limitações do AWS API Gateway é que ele pode enviar somente um máximo de 128 KB em uma mensagem. Para enviar eventos maiores do servidor para o cliente:
-
No servidor, carregue eventos maiores em um bucket S3 disponível publicamente.
-
O cliente pode então receber somente a URL deste arquivo via WebSocket e baixar o corpo do evento real por meio de REST.