Aller au contenu

@capgo/capacitor-intercom

Intercom Messenger, centre d'aide et messagerie in-app pour les applications iOS et Android Capacitor.

@capgo/capacitor-intercom encapsule les SDK mobiles officiels d'Intercom pour que le support, l'onboarding et les campagnes de cycle de vie restent natifs, tandis que le shell de votre application reste Capacitor. Identifiez les utilisateurs, ouvrez le Messenger, enregistrez des événements et affichez le contenu du centre d'aide en JavaScript.

PlateformeSupport
iOSIntercom iOS SDK
AndroidIntercom Android SDK
Le WebNon supporté
  • loadWithKeys - Initialisez Intercom avec les clés API au runtime. Utilisez cette option si vous préférez ne pas configurer les clés dans capacitor.config.
  • registerIdentifiedUser - Enregistrez un utilisateur connu auprès d'Intercom. Au moins un des champs userId ou email doit être fourni.
  • registerUnidentifiedUser - Enregistrez un utilisateur anonyme auprès d'Intercom.
  • updateUser - Update user attributes in Intercom.
MéthodeDescription
loadWithKeysInitialisez Intercom avec les clés API au runtime. Utilisez cette option si vous préférez ne pas configurer les clés dans capacitor.config.
registerIdentifiedUserEnregistrez un utilisateur connu auprès d'Intercom. Au moins l'un des champs userId ou e-mail doit être fourni.
registerUnidentifiedUserEnregistrez un utilisateur anonyme auprès d'Intercom.
updateUserUpdate user attributes in Intercom.
logoutDéconnectez l'utilisateur d'Intercom.
logEventEnregistrez un événement personnalisé dans Intercom.
displayMessengerOuvrez le messenger Intercom.
displayMessageComposerOuvrez le composeur de message avec un message prérempli.
displayHelpCenterOuvrez le centre d'aide Intercom.
hideMessengerMasquez le messenger Intercom.
displayLauncherAffichez le bouton de lancement Intercom.
hideLauncherMasquer le bouton Intercom.
displayInAppMessagesActiver les messages in-app d'Intercom.
hideInAppMessagesDésactiver les messages in-app d'Intercom.
displayCarouselAfficher un carrousel Intercom spécifique.
displayArticleAfficher un article Intercom spécifique.
displaySurveyAfficher un sondage Intercom spécifique.
setUserHashDéfinir le HMAC pour la vérification de l'identité.
setUserJwtDéfinir le JWT pour l'authentification sécurisée du messenger.
setBottomPaddingDéfinir le padding inférieur pour l'interface du messenger Intercom.
sendPushTokenToIntercomEnvoyez un token de notification push à Intercom.
receivePushGérez une notification push Intercom reçue.
getUnreadConversationCountRécupérez le nombre de conversations non lues pour l'utilisateur actuel.
addListenerÉcoutez l'affichage de la fenêtre Intercom.
addListenerÉcoutez la fermeture de la fenêtre Intercom.
addListenerÉcoutez les changements du nombre de conversations non lues.
removeAllListenersSupprimer tous les écouteurs d'événements.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-intercom.

Si vous utilisez @capgo/capacitor-intercom pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-intercom pour la fonctionnalité native dans « Utiliser @capgo/capacitor-intercom », Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.