Guía
Cómo usar Intercom en Capacitor
Usando @capgo/capacitor-intercom
Plugin de Intercom para Capacitor.
Instalar
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapgoIntercom } from '@capgo/capacitor-intercom';
API de un vistazo
| Método | Descripción |
|---|---|
loadWithKeys |
Inicializa Intercom con las claves de API en tiempo de ejecución. Úsalo si prefieres no configurar las claves en capacitor.config. |
registerIdentifiedUser |
Registra un usuario conocido en Intercom. Debes proporcionar al menos uno de los dos: userId o email. |
registerUnidentifiedUser |
Registra un usuario anónimo en Intercom. |
updateUser |
Actualiza los atributos del usuario en Intercom. |
logout |
Cierra la sesión del usuario en Intercom. |
logEvent |
Registra un evento personalizado en Intercom. |
displayMessenger |
Abre el messenger de Intercom. |
displayMessageComposer |
Abre el compositor de mensajes con un mensaje precargado. |
displayHelpCenter |
Abre el centro de ayuda de Intercom. |
hideMessenger |
Oculta el messenger de Intercom. |
displayLauncher |
Muestra el botón de Intercom. |
hideLauncher |
Oculta el botón del launcher de Intercom. |
displayInAppMessages |
Activa los mensajes in-app de Intercom. |
hideInAppMessages |
Desactiva los mensajes in-app de Intercom. |
displayCarousel |
Muestra un carrusel específico de Intercom. |
displayArticle |
Muestra un artículo específico de Intercom. |
displaySurvey |
Muestra una encuesta específica de Intercom. |
setUserHash |
Configura el HMAC para la verificación de identidad. |
setUserJwt |
Configura el JWT para la autenticación segura del messenger. |
setBottomPadding |
Configura el padding inferior de la UI del messenger de Intercom. |
sendPushTokenToIntercom |
Envía un token de notificaciones push a Intercom. |
receivePush |
Gestiona una notificación push recibida de Intercom. |
getUnreadConversationCount |
Obtén el número de conversaciones sin leer del usuario actual. |
Ejemplos
loadWithKeys()
Inicializa Intercom con las claves de API en tiempo de ejecución. Úsalo si prefieres no configurar las claves en capacitor.config.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
Registra un usuario conocido en Intercom. Debes proporcionar al menos uno de los dos: userId o email.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registra un usuario anónimo en Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Actualiza los atributos del usuario en Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Cierra la sesión del usuario en Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Registra un evento personalizado en Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
La tabla anterior enumera los 23 métodos principales. Los helpers de versión y listeners, así como el contrato completo de cada método, están documentados en la repositorio GitHub.
Escuchar eventos
addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o CapgoIntercom.removeAllListeners() para limpiar todos los listeners.
Referencia completa
Continúa desde Usando @capgo/capacitor-intercom
Si estás usando Usando @capgo/capacitor-intercom para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-intercom para los detalles de implementación en @capgo/capacitor-intercom, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.