Anleitung
Intercom in Capacitor nutzen
Auf dem Gerät testen
Lade die Capgo App herunter und scanne den QR code.
@capgo/capacitor-intercom verwenden
Intercom Capacitor Plugin.
Installieren
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.
Importieren
import { CapgoIntercom } from '@capgo/capacitor-intercom';
API auf einen Blick
| Methode | Beschreibung |
|---|---|
loadWithKeys |
Initialisiere Intercom zur Laufzeit mit den API Keys. Nutze dies, wenn du die Keys nicht in capacitor.config konfigurieren möchtest. |
registerIdentifiedUser |
Registriere einen bekannten User bei Intercom. Mindestens userId oder email muss angegeben werden. |
registerUnidentifiedUser |
Registriere einen anonymen User bei Intercom. |
updateUser |
Aktualisiere die User-Attribute in Intercom. |
logout |
Logge den User bei Intercom aus. |
logEvent |
Logge ein Custom Event in Intercom. |
displayMessenger |
Öffne den Intercom Messenger. |
displayMessageComposer |
Öffne den Message Composer mit einer vorausgefüllten Nachricht. |
displayHelpCenter |
Öffne das Intercom Help Center. |
hideMessenger |
Blende den Intercom Messenger aus. |
displayLauncher |
Zeige den Intercom Launcher-Button an. |
hideLauncher |
Blende den Intercom-Launcher-Button aus. |
displayInAppMessages |
In-App-Nachrichten von Intercom aktivieren. |
hideInAppMessages |
In-App-Nachrichten von Intercom deaktivieren. |
displayCarousel |
Ein bestimmtes Intercom-Carousel anzeigen. |
displayArticle |
Einen bestimmten Intercom-Artikel anzeigen. |
displaySurvey |
Zeigt eine spezifische Intercom-Umfrage an. |
setUserHash |
Setzt den HMAC zur Identitätsverifizierung. |
setUserJwt |
Setzt das JWT für die sichere Messenger-Authentifizierung. |
setBottomPadding |
Setzt das untere Padding für die Intercom-Messenger-UI. |
sendPushTokenToIntercom |
Sende einen Push-Token an Intercom. |
receivePush |
Verarbeite eine empfangene Intercom-Push-Notification. |
getUnreadConversationCount |
Rufe die Anzahl ungelesener Konversationen für den aktuellen User ab. |
Beispiele
loadWithKeys()
Initialisiere Intercom zur Laufzeit mit den API Keys. Nutze dies, wenn du die Keys nicht in capacitor.config 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 User bei Intercom. Mindestens userId oder email muss angegeben werden.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registriere einen anonymen User bei Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Aktualisiere die User-Attribute in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Logge den User bei Intercom aus.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Logge ein Custom Event in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
Die obige Tabelle listet die 23 Kernmethoden auf. Listener- und Versions-Helper sowie der vollständige Contract jeder Methode sind in der GitHub Repository.
Events abonnieren
addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder CapgoIntercom.removeAllListeners() auf, um alle Listener zu entfernen.
Vollständige Referenz
Weiter mit @capgo/capacitor-intercom
Wenn du es nutzt @capgo/capacitor-intercom verwenden Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-intercom für die Implementierungsdetails in @capgo/capacitor-intercom, Erste Schritte für die Implementierungsdetails in Erste Schritte, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.