Démarrage

Installer

bun add @capgo/capacitor-crisp
bunx cap sync

Importer

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

API Vue d'ensemble

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

Ouvrez la fenêtre de chat de Crisp. Affiche l'interface de chat à l'utilisateur.

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

await CapacitorCrisp.openMessenger();

setTokenID

Définissez un ID de jeton unique pour la session actuelle de l'utilisateur. Utilisé pour identifier et restaurer les conversations précédentes.

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

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

setUser

Définissez les informations de l'utilisateur pour la session actuelle. Met à jour le profil de l'utilisateur visible aux agents de support.

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

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

pushEvent

Envoie un événement personnalisé à Crisp. Utile pour suivre les actions et le comportement de l'utilisateur.

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

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

setCompany

Configurez les informations de l'entreprise pour la session actuelle. Associez l'utilisateur à une entreprise dans Crisp.

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

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

setInt

Définissez un champ de données entier personnalisé. Stockez des données numériques associées à la session de l'utilisateur.

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

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

setString

Définissez un champ de données de chaîne personnalisé. Stockez des données de texte associées à la session de l'utilisateur.

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

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

sendMessage

Envoyez un message de l'utilisateur à la conversation. Envoyez un message de manière programmée comme si l'utilisateur l'avait tapé.

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

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

setSegment

Définir un segment d'utilisateur pour la ciblage et l'organisation. Utilisé pour classer les utilisateurs dans l'interface de dashboard Crisp.

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

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

reset

Réinitialiser la session Crisp. Efface toutes les données utilisateur et démarre une nouvelle session. Utile lorsqu'un utilisateur se déconnecte.

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

await CapacitorCrisp.reset();

Référence de type

ConfigureOptions

Configuration pour l'initialisation de 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

Couleurs disponibles pour les événements Crisp. Utilisées pour catégoriser visuellement les événements dans l'interface de dashboard Crisp.

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque les données publiques API changent en amont.