Getting Started

GitHub

Ein Setup-Vorschlag kopieren, der die Installationsanweisungen und die vollständige Markdown-Anleitung für diesen Plugin enthält.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-crisp`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/crisp/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

bun add @capgo/capacitor-crisp
bunx cap sync

Importieren

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

API Übersicht

`configure`

Configure the Crisp SDK with your website ID. Must be called before using any other methods.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.configure({ websiteID: 'YOUR_WEBSITE_ID' });

`openMessenger`

Öffnen Sie das Chatfenster von Crisp. Zeigt dem Benutzer das Chatinterface.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.openMessenger();

`setTokenID`

Setzen Sie eine eindeutige Token-ID für die aktuelle Benutzersitzung. Wird verwendet, um vorherige Gespräche zu identifizieren und wiederherzustellen.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.setTokenID({} as { tokenID: string });

`setUser`

Setzen Sie Benutzerinformationen für die aktuelle Sitzung. Aktualisiert das Benutzerprofil, das für die Supportagenten sichtbar ist.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setUser({
  nickname: 'John Doe',
  email: 'john@example.com',
  phone: '+1234567890'
});

`pushEvent`

Senden Sie ein benutzerdefiniertes Ereignis an Crisp. Wird verwendet, um Benutzeraktionen und Verhalten zu tracken.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.pushEvent({
  name: 'completed_purchase',
  color: 'green'
});

`setCompany`

Firmeninformationen für die aktuelle Sitzung festlegen. Ein Benutzer mit einer Firma in Crisp verbinden.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setCompany({
  name: 'Acme Corp',
  url: 'https://acme.com',
  employment: ['CEO', 'Executive'],
  geolocation: ['USA', 'San Francisco']
});

`setInt`

Eine benutzerdefinierte Ganzzahl-Datenfeld festlegen. Zahlendaten, die dem Benutzer-Sitzung zugeordnet sind, speichern.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setInt({ key: 'user_level', value: 42 });

`setString`

Ein benutzerdefiniertes Text-Datenfeld festlegen. Textdaten, die dem Benutzer-Sitzung zugeordnet sind, speichern.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setString({ key: 'subscription_tier', value: 'premium' });

`sendMessage`

Ein Nachrichten von dem Benutzer an die Chat senden. Programmatisch eine Nachricht senden, als ob der Benutzer sie getippt hätte.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.sendMessage({ value: 'Hello, I need help!' });

`setSegment`

Setze einen Benutzersegment für Ziele und Organisation. Wird verwendet, um Benutzer in der Crisp-Dashboard zu kategorisieren.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setSegment({ segment: 'premium-users' });

`reset`

Richte die Crisp-Sitzung neu ein. Löscht alle Benutzerdaten und startet eine frische Sitzung. Wird nützlich, wenn sich ein Benutzer abmeldet.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.reset();

Typenverweis

`ConfigureOptions`

Konfiguration für die Initialisierung von Crisp.

export interface ConfigureOptions {
  /**
   * Your Crisp website ID from dashboard.
   */
  websiteID: string;
  /**
   * Optional - Locale to force in the Crisp chat widget (ISO 639-1), eg. `en`, `fr`, `es`.
   * Web + Android: overrides the runtime locale. iOS follows the device/app locale.
   */
  locale?: string;
  /**
   * Optional - Unique token identifier for the user session continuity.
   */
  tokenID?: string;
}

`eventColor`

Verfügbare Farben für Crisp-Ereignisse. Wird verwendet, um Ereignisse in der Crisp-Dashboard visuell zu kategorisieren.

export type eventColor =
  | 'red'
  | 'orange'
  | 'yellow'
  | 'green'
  | 'blue'
  | 'purple'
  | 'pink'
  | 'brown'
  | 'grey'
  | 'black';

Wahrheitsquelle

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

Fortsetzen von Getting Started

Wenn Sie " Getting Started " verwenden, um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-crisp für die native Fähigkeit in Using @capgo/capacitor-crisp, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.