Referência de tipos

Use esta página quando

Use esta página como um índice selecionado dos tipos mais referenciados pela documentação. As declarações do pacote que você instalar continuam sendo o contrato completo da sua versão.

• você quer o formato exato de uma prop, do conteúdo de um evento ou de um modelo compartilhado
• um guia aponta para um tipo nomeado como TimelineItem, Conversation ou PublicVisitor
• você está construindo a sua própria interface sobre os hooks, os eventos ou os primitivos

Se você ainda está decidindo como moldar o widget, comece por Visão geral, Mude uma coisa só ou Páginas e layouts.

Tipos do widget

DefaultMessage

Estrutura das mensagens de boas-vindas anteriores à conversa.

VisitorMetadata

Pares chave-valor para guardar dados próprios sobre os contatos.

SenderType

Enumeração que define quem pode enviar mensagens.

SupportMode

Modo de layout do widget.

Copiartype SupportMode = "floating" | "responsive";

TriggerRenderProps

Props recebidas pelas funções de renderização do gatilho personalizado.

SupportHandle

Manipulador imperativo para controlar o widget por refs.

Dados de visitante e de site

PublicVisitor

O objeto de visitante devolvido pelo widget, representando um visitante anônimo ou identificado.

PublicContact

Dados de contato de um visitante identificado.

PublicWebsiteResponse

Configuração do site e informações sobre a disponibilidade de agentes.

HumanAgent

Informações sobre um agente de suporte humano.

AIAgent

Informações sobre um agente de suporte de IA.

Conversas e mensagens

Conversation

Registro de conversa usado em todo o widget de suporte e no conteúdo dos eventos.

TimelineItem

Conteúdo do item da linha do tempo usado nas mensagens do widget, nos eventos e na saída das ferramentas de IA.

Tipos de hooks e de eventos

IdentifyParams

Parâmetros da função identify().

MessageComposer

Estado e ações devolvidos por useConversationPage para redigir mensagens.

SupportEvent

Tipo união de todos os eventos possíveis do widget.

Tipos do cliente

FluxoClient

A instância de cliente de baixo nível para o controle programático avançado. A tabela abaixo destaca os principais stores e métodos públicos expostos pelo cliente.