Saltar al contenido

@capgo/capacitor-intercom

Messenger de Intercom, centro de ayuda y mensajería in-app para apps de Capacitor en iOS y Android.

@capgo/capacitor-intercom envuelve los SDK oficiales de Intercom para que el soporte, el onboarding y las campañas de ciclo de vida sigan siendo nativos mientras tu app shell se mantiene Capacitor. Identifica usuarios, abre el messenger, registra eventos y muestra contenido del help center desde JavaScript.

PlataformaSoporte
iOSIntercom para iOS SDK
AndroidIntercom para Android SDK
WebNo soportado
  • 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.
MétodoDescripción
loadWithKeysInicializa Intercom con las claves de API en tiempo de ejecución. Úsalo si prefieres no configurar las claves en capacitor.config.
registerIdentifiedUserRegistra un usuario conocido en Intercom. Debes proporcionar al menos uno de los dos: userId o email.
registerUnidentifiedUserRegistra un usuario anónimo en Intercom.
updateUserActualiza los atributos del usuario en Intercom.
logoutCierra la sesión del usuario en Intercom.
logEventRegistra un evento personalizado en Intercom.
displayMessengerAbre el messenger de Intercom.
displayMessageComposerAbre el editor con un mensaje predefinido.
displayHelpCenterAbre el centro de ayuda de Intercom.
hideMessengerOculta el messenger de Intercom.
displayLauncherMuestra el botón de lanzamiento de Intercom.
hideLauncherOculta el botón del launcher de Intercom.
displayInAppMessagesActiva los mensajes in-app de Intercom.
hideInAppMessagesDesactiva los mensajes in-app de Intercom.
displayCarouselMuestra un carrusel específico de Intercom.
displayArticleMuestra un artículo específico de Intercom.
displaySurveyMuestra una encuesta específica de Intercom.
setUserHashConfigura el HMAC para la verificación de identidad.
setUserJwtConfigura el JWT para la autenticación segura del messenger.
setBottomPaddingConfigura el padding inferior de la UI del messenger de Intercom.
sendPushTokenToIntercomEnvía un token de notificaciones push a Intercom.
receivePushGestiona una notificación push recibida de Intercom.
getUnreadConversationCountObtén el número de conversaciones sin leer del usuario actual.
addListenerEscucha cuando se muestra la ventana de Intercom.
addListenerEscucha cuando se oculta la ventana de Intercom.
addListenerEscucha cambios en el contador de conversaciones no leídas.
removeAllListenersElimina todos los listeners de eventos.

Esta referencia se sincroniza desde src/definitions.ts en capacitor-intercom.

Si estás usando @capgo/capacitor-intercom para planificar el trabajo con plugins nativos, conéctalo con Usando @capgo/capacitor-intercom para la funcionalidad nativa en Uso de @capgo/capacitor-intercom, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para el detalle de implementación en los Plugins de Capacitor por Capgo, Añadir o actualizar plugins para el detalle de implementación en Agregar o actualizar plugins, y Alternativas a plugins de Ionic Enterprise para el flujo de trabajo del producto en Alternativas a plugins de Ionic Enterprise.