Guide
Comment utiliser Intercom dans Capacitor
Tester sur l'appareil
Téléchargez l'application Capgo, puis scannez le QR code.
Utiliser @capgo/capacitor-intercom
Plugin Intercom Capacitor.
Installer
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapgoIntercom } from '@capgo/capacitor-intercom';
Aperçu de API
| Méthode | Description |
|---|---|
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 l'un des champs userId ou e-mail doit être fourni. |
registerUnidentifiedUser |
Enregistrez un utilisateur anonyme auprès d'Intercom. |
updateUser |
Update user attributes in Intercom. |
logout |
Déconnectez l'utilisateur d'Intercom. |
logEvent |
Enregistrez un événement personnalisé dans Intercom. |
displayMessenger |
Ouvrez le messenger Intercom. |
displayMessageComposer |
Ouvrez le composeur de message avec un message prérempli. |
displayHelpCenter |
Ouvrez le centre d'aide Intercom. |
hideMessenger |
Masquez le messenger Intercom. |
displayLauncher |
Affichez le bouton de lancement Intercom. |
hideLauncher |
Masquer le bouton Intercom. |
displayInAppMessages |
Activer les messages in-app d'Intercom. |
hideInAppMessages |
Désactiver les messages in-app d'Intercom. |
displayCarousel |
Afficher un carrousel Intercom spécifique. |
displayArticle |
Afficher un article Intercom spécifique. |
displaySurvey |
Afficher un sondage Intercom spécifique. |
setUserHash |
Définir le HMAC pour la vérification de l'identité. |
setUserJwt |
Définir le JWT pour l'authentification sécurisée du messenger. |
setBottomPadding |
Définir le padding inférieur pour l'interface du messenger Intercom. |
sendPushTokenToIntercom |
Envoyer un token de notification push à Intercom. |
receivePush |
Gérer une notification push Intercom reçue. |
getUnreadConversationCount |
Récupérer le nombre de conversations non lues de l'utilisateur actuel. |
Exemples
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.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
Enregistrez un utilisateur connu auprès d'Intercom. Au moins l'un des champs userId ou e-mail doit être fourni.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Enregistrez un utilisateur anonyme auprès d'Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Update user attributes in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Déconnectez l'utilisateur d'Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Enregistrez un événement personnalisé dans Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
Le tableau ci-dessus liste les 23 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Écouter les événements
addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapgoIntercom.removeAllListeners() pour supprimer tous les listeners.
Référence complète
Continuer après « Utiliser @capgo/capacitor-intercom »
Si vous utilisez Utiliser @capgo/capacitor-intercom pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-intercom pour les détails d’implémentation dans @capgo/capacitor-intercom, Prise en main pour les détails d'implémentation dans Getting Started 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 les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.