Referencia de tipos

Usa esta página cuando

Usa esta página como un índice seleccionado de los tipos que más enlaza la documentación. Las declaraciones del paquete que instales siguen siendo el contrato completo de tu versión.

• quieres la forma exacta de una prop, del contenido de un evento o de un modelo compartido
• una guía enlaza a un tipo con nombre como TimelineItem, Conversation o PublicVisitor
• estás construyendo tu propia interfaz sobre los hooks, los eventos o los primitivos

Si todavía estás decidiendo cómo dar forma al widget, empieza por Visión general, Cambia una sola cosa o Páginas y layouts.

Tipos del widget

DefaultMessage

Estructura de los mensajes de bienvenida previos a la conversación.

VisitorMetadata

Pares clave-valor para guardar datos propios sobre los contactos.

SenderType

Enumeración que define quién puede enviar mensajes.

SupportMode

Modo de maquetación del widget.

Copiartype SupportMode = "floating" | "responsive";

TriggerRenderProps

Props que reciben las funciones de renderizado del disparador personalizado.

SupportHandle

Manejador imperativo para controlar el widget mediante refs.

Datos de visitante y de sitio web

PublicVisitor

El objeto de visitante que devuelve el widget, que representa a un visitante anónimo o identificado.

PublicContact

Datos de contacto de un visitante identificado.

PublicWebsiteResponse

Configuración del sitio web e información sobre la disponibilidad de agentes.

HumanAgent

Información sobre un agente de soporte humano.

AIAgent

Información sobre un agente de soporte de IA.

Conversaciones y mensajes

Conversation

Registro de conversación que se usa en todo el widget de soporte y en el contenido de los eventos.

TimelineItem

Contenido del elemento de la línea de tiempo que se usa para los mensajes del widget, los eventos y la salida de las herramientas de IA.

Tipos de hooks y de eventos

IdentifyParams

Parámetros de la función identify().

MessageComposer

Estado y acciones que devuelve useConversationPage para redactar mensajes.

SupportEvent

Tipo unión de todos los eventos posibles del widget.

Tipos del cliente

FluxoClient

La instancia de cliente de bajo nivel para el control programático avanzado. La tabla de abajo destaca los principales stores y métodos públicos que expone el cliente.