Einstieg

Installieren

bun add @capgo/capacitor-intercom
bunx cap sync

Importieren

import { CapgoIntercom } from '@capgo/capacitor-intercom';

API Übersicht

loadWithKeys

Intercom mit API Schlüsseln bei Laufzeit initialisieren. Verwenden Sie diese Option, wenn Sie die Schlüssel in capacitor.config nicht konfigurieren möchten.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);

registerIdentifiedUser

Ein bekannter Benutzer bei Intercom registrieren. Zumindest einer der Werte userId oder email muss angegeben werden.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerIdentifiedUser({} as IntercomIdentifiedUserOptions);

registerUnidentifiedUser

Ein anonymer Benutzer bei Intercom registrieren.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Aktualisiere Benutzerattribute in Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.updateUser({} as IntercomUserUpdateOptions);

logout

Melden Sie den Benutzer aus Intercom ab.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logout();

logEvent

Ein benutzerdefiniertes Ereignis in Intercom protokollieren.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logEvent({} as IntercomLogEventOptions);

displayMessenger

Öffne den Intercom-Messenger.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessenger();

displayMessageComposer

Der Nachrichtenkomponist öffnen und mit einer vorab eingegebenen Nachricht versehen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessageComposer({} as IntercomMessageComposerOptions);

displayHelpCenter

Das Intercom-Hilfzentrum öffnen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayHelpCenter();

hideMessenger

Der Intercom-Messenger ausblenden.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideMessenger();

displayLauncher

Den Intercom-Launcher-Button anzeigen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayLauncher();

hideLauncher

Der Intercom-Launcher-Button ausblenden.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideLauncher();

displayInAppMessages

In-App-Nachrichten von Intercom aktivieren.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

In-App-Nachrichten von Intercom deaktivieren.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideInAppMessages();

displayCarousel

Ein bestimmtes Intercom-Carousel anzeigen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayCarousel({} as IntercomCarouselOptions);

displayArticle

Ein bestimmtes Intercom-Artikel anzeigen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayArticle({} as IntercomArticleOptions);

displaySurvey

Ein bestimmtes Intercom-Umfrage anzeigen.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displaySurvey({} as IntercomSurveyOptions);

setUserHash

Setze den HMAC für die Identitätsprüfung.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserHash({} as IntercomUserHashOptions);

setUserJwt

Setze JWT für sichere Messenger-Authentifizierung.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserJwt({} as IntercomUserJwtOptions);

setBottomPadding

Setzen Sie die untere Abstandseinstellung für die Intercom-Messenger-Oberfläche.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setBottomPadding({} as IntercomBottomPaddingOptions);

sendPushTokenToIntercom

Senden Sie ein Push-Benachrichtigungs-Token an Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.sendPushTokenToIntercom({} as IntercomPushTokenOptions);

receivePush

Ein empfangenes Intercom-Push-Benachrichtigung verarbeiten.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.receivePush({} as IntercomPushNotificationData);

getUnreadConversationCount

Ermitteln Sie die Anzahl der ungelesenen Gespräche für den aktuellen Benutzer.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.getUnreadConversationCount();

Typenverweis

IntercomLoadOptions

export interface IntercomLoadOptions {
  appId?: string;
  apiKeyIOS?: string;
  apiKeyAndroid?: string;
}

IntercomIdentifiedUserOptions

export interface IntercomIdentifiedUserOptions {
  userId?: string;
  email?: string;
}

IntercomUserUpdateOptions

export interface IntercomUserUpdateOptions {
  userId?: string;
  email?: string;
  name?: string;
  phone?: string;
  languageOverride?: string;
  customAttributes?: { [key: string]: any };
  companies?: IntercomCompany[];
}

IntercomLogEventOptions

export interface IntercomLogEventOptions {
  name: string;
  data?: { [key: string]: any };
}

IntercomMessageComposerOptions

export interface IntercomMessageComposerOptions {
  message: string;
}

IntercomCarouselOptions

export interface IntercomCarouselOptions {
  carouselId: string;
}

IntercomArticleOptions

export interface IntercomArticleOptions {
  articleId: string;
}

IntercomSurveyOptions

export interface IntercomSurveyOptions {
  surveyId: string;
}

IntercomUserHashOptions

export interface IntercomUserHashOptions {
  hmac: string;
}

IntercomUserJwtOptions

export interface IntercomUserJwtOptions {
  jwt: string;
}

IntercomBottomPaddingOptions

export interface IntercomBottomPaddingOptions {
  value: number;
}

IntercomPushTokenOptions

export interface IntercomPushTokenOptions {
  value: string;
}

Quellwahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.