Anleitung
So verwendest du Intercom in Capacitor
Verwende @capgo/capacitor-intercom
Intercom-Capacitor-Plugin
Installieren
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync kopiert die native code des Plugins in Ihre native Projekte. Führen Sie es erneut durch, nachdem Sie jedes Plugin aktualisiert haben.
Importieren
import { CapgoIntercom } from '@capgo/capacitor-intercom';
API im Überblick
| Methode | Beschreibung |
|---|---|
loadWithKeys |
Initialisiere Intercom mit API-Schlüsseln am Laufzeitpunkt. Verwende diese Option, wenn du die Schlüssel in capacitor.config nicht konfigurieren möchtest. |
registerIdentifiedUser |
Registriere einen bekannten Benutzer bei Intercom. Mindestens einer von userId oder email muss bereitgestellt werden. |
registerUnidentifiedUser |
Registriere einen anonymen Benutzer bei Intercom. |
updateUser |
Aktualisiere Benutzerattribute in Intercom. |
logout |
Melde den Benutzer bei Intercom ab. |
logEvent |
Logge ein benutzerdefiniertes Ereignis in Intercom. |
displayMessenger |
Öffne den Intercom-Messenger. |
displayMessageComposer |
Öffne den Nachrichtenkomponisten mit einer vorab gefüllten Nachricht. |
displayHelpCenter |
Öffne das Intercom-Hilfezentrum. |
hideMessenger |
Verstecke den Intercom-Messenger. |
displayLauncher |
Zeige den Intercom-Launcher-Button an. |
hideLauncher |
Verstecke den Intercom-Launcher-Button. |
displayInAppMessages |
Intercom-Nachrichten aktivieren. |
hideInAppMessages |
Intercom-Nachrichten deaktivieren. |
displayCarousel |
Einen bestimmten Intercom-Karussell anzuzeigen. |
displayArticle |
Einen bestimmten Intercom-Artikel anzuzeigen. |
displaySurvey |
Einen bestimmten Intercom-Umfrage anzuzeigen. |
setUserHash |
Die HMAC für die Identitätsprüfung festlegen. |
setUserJwt |
JWT für sichere Messengerauthentifizierung festlegen. |
setBottomPadding |
Die untere Padding für die Intercom-Messenger-UI festlegen. |
sendPushTokenToIntercom |
Ein Push-Benachrichtigungs-Token an Intercom senden. |
receivePush |
Eine empfangene Intercom-Push-Benachrichtigung bearbeiten. |
getUnreadConversationCount |
Die Anzahl der ungelesenen Gespräche für den aktuellen Benutzer abrufen. |
Beispiele
loadWithKeys()
Initialisiere Intercom mit API-Schlüsseln zum Laufzeit. Verwende dies, wenn du die Schlüssel in capacitor.config nicht konfigurieren möchtest.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
Registriere einen bekannten Benutzer bei Intercom. Mindestens einer von userId oder email muss bereitgestellt werden.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registriere einen anonymen Benutzer bei Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Aktualisiere Benutzerattribute in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Melde den Benutzer bei Intercom ab.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Logge ein benutzerdefiniertes Ereignis in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
Die Tabelle oben listet die 23 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind in der GitHub-Repository.
Höre auf Ereignisse
addListener gibt einen Handle zurück. Ruf handle.remove() auf, wenn die Seite unmontiert wird, oder CapgoIntercom.removeAllListeners() um alle Listener zu löschen.
Vollständige Referenz
Fortfahren von Using @capgo/capacitor-intercom
Wenn Sie Using verwenden Mit @capgo/capacitor-Intercom um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-Intercom zur Implementierungsdetail in @capgo/capacitor-intercom Getting Started zur Implementierungsdetail in Anleitung Capgo Plugin-Verzeichnis zur Produktionsablauf in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo zur Implementierungsdetail in Capacitor Plugins von Capgo, und Hinzufügen oder Aktualisieren von Plugins zur Implementierungsdetail in Hinzufügen oder Aktualisieren von Plugins.