Guía
Cómo usar Intercom en Capacitor
Probar en dispositivo
Descarga la aplicación Capgo, luego escanea el código QR code.
Usando @capgo/capacitor-intercom
Plugin de Intercom Capacitor
Instalar
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync copia el plugin nativo code en tus proyectos nativos. Correrlo nuevamente después de cada actualización del plugin.
Importar
import { CapgoIntercom } from '@capgo/capacitor-intercom';
Vista general de API
| Método | Descripción |
|---|---|
loadWithKeys |
Inicialice Intercom con API claves en tiempo de ejecución. Utilice esto si prefiere no configurar claves en capacitor.config. |
registerIdentifiedUser |
Registre a un usuario conocido con Intercom. Se debe proporcionar al menos uno de los campos userId o email. |
registerUnidentifiedUser |
Registre a un usuario anónimo con Intercom. |
updateUser |
Actualiza los atributos del usuario en Intercom. |
logout |
Cierre la sesión del usuario en Intercom. |
logEvent |
Registre un evento personalizado en Intercom. |
displayMessenger |
Abra el mensajero de Intercom. |
displayMessageComposer |
Abra el compositor de mensajes con un mensaje prellenado. |
displayHelpCenter |
Abra el centro de ayuda de Intercom. |
hideMessenger |
Oculte el mensajero de Intercom. |
displayLauncher |
Muestre el botón de lanzador de Intercom. |
hideLauncher |
Oculte el botón de lanzador de Intercom. |
displayInAppMessages |
Activar mensajes en la aplicación desde Intercom. |
hideInAppMessages |
Desactivar mensajes en la aplicación desde Intercom. |
displayCarousel |
Mostrar un carrusel específico de Intercom. |
displayArticle |
Mostrar un artículo específico de Intercom. |
displaySurvey |
Mostrar un sondeo específico de Intercom. |
setUserHash |
Establecer el HMAC para la verificación de identidad. |
setUserJwt |
Establecer JWT para la autenticación del mensajero seguro. |
setBottomPadding |
Set the bottom padding for the Intercom messenger UI. |
sendPushTokenToIntercom |
Enviar un token de notificación push a Intercom. |
receivePush |
Manejar una notificación push recibida de Intercom. |
getUnreadConversationCount |
Obtener el número de conversaciones no leídas para el usuario actual. |
Ejemplos
loadWithKeys()
Inicialice Intercom con API claves en tiempo de ejecución. Utilice esto si prefiere no configurar 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()
Registre a un usuario conocido con Intercom. Se debe proporcionar al menos uno de los campos userId o email.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registre a un usuario anónimo con 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()
Desconecte al usuario de Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Registre un evento personalizado en Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
La tabla anterior muestra los 23 métodos básicos. Los ayudantes de escucha y versión, y la completa contratación de cada método, se documentan en el GitHub repositorio.
Escuche eventos
addListener devuelve un manejador. Llame a handle.remove() cuando se desmonte la pantalla, o CapgoIntercom.removeAllListeners() para eliminar todos los escuchadores.
Referencia completa
Sigue adelante desde Using @capgo/capacitor-intercom
Si estás utilizando Usando @capgo/capacitor-intercom para planificar el trabajo de plugin nativo, conectarlo con @capgo/capacitor-intercom para los detalles de implementación en @capgo/capacitor-intercom Inicio rápido para los detalles de implementación en Inicio rápido, Directorio de Plugins Capgo para el flujo de trabajo del producto en Directorio de Plugins Capgo Plugins de Capacitor por Capgo para el detalle de implementación en Plugins de Capacitor por Capgo, y Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins.