Guide
Comment utiliser Intercom dans Capacitor
Testez sur appareil
Téléchargez l'application Capgo, puis scannez le code QR code.
Utilisez @capgo/capacitor-intercom
Le plugin Capacitor Intercom.
Installer
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync copie le code natif du plugin code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.
Importer
import { CapgoIntercom } from '@capgo/capacitor-intercom';
API en un coup d'œil
| Méthode | Description |
|---|---|
loadWithKeys |
Initialisez Intercom avec API clés en temps de exécution. Utilisez cela si vous préférez ne pas configurer les clés dans capacitor.config. |
registerIdentifiedUser |
Enregistrez un utilisateur connu avec Intercom. Au moins l'un des identifiants utilisateur ou email doit être fourni. |
registerUnidentifiedUser |
Enregistrez un utilisateur anonyme avec 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 messager Intercom. |
displayMessageComposer |
Ouvrez le compositeur de message avec un message pré-rempli. |
displayHelpCenter |
Ouvrez le centre d'aide Intercom. |
hideMessenger |
Cacherez le messager Intercom. |
displayLauncher |
Affichez le bouton de lancement Intercom. |
hideLauncher |
Cacherez le bouton de lancement Intercom. |
displayInAppMessages |
Activer les messages dans l'application de Intercom. |
hideInAppMessages |
Désactiver les messages en application de Intercom. |
displayCarousel |
Afficher un carrousel spécifique d'Intercom. |
displayArticle |
Afficher un article spécifique d'Intercom. |
displaySurvey |
Afficher un sondage spécifique d'Intercom. |
setUserHash |
Configurer le HMAC pour la vérification d'identité. |
setUserJwt |
Configurer JWT pour une authentification sécurisée du messager. |
setBottomPadding |
Fixer l'écartement en bas pour l'interface utilisateur de messagerie Intercom. |
sendPushTokenToIntercom |
Envoyer un jeton de notification push à Intercom. |
receivePush |
Gérer un message de notification push reçu d'Intercom. |
getUnreadConversationCount |
Obtenir le nombre de conversations non lues pour l'utilisateur actuel. |
Exemples
loadWithKeys()
Initialisez Intercom avec API clés en temps de exécution. Utilisez cela 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 avec Intercom. Au moins l'un des userId ou email 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 avec 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' });
La table ci-dessus liste les 23 méthodes de base. Les aides aux écouteurs et aux versions, ainsi que la pleine convention de chaque méthode, sont documentés dans le GitHub dépôt.
Écoutez les événements
addListener retourne un gestionnaire. Appelez handle.remove() lorsque la page se démonte, ou CapgoIntercom.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-intercom
Si vous utilisez L'utilisation de @capgo/capacitor-intercom pour planifier le travail du plugin natif, connectez-l’avec @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 Prise en main, Répertoire de plugins Capgo pour le flux de travail du produit dans le Capgo Répertoire de plugins Capacitor Plugins par Capgo pour le détail d'implémentation dans les Capacitor Plugins par Capgo, et Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins.