Getting Started

Copy prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        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.

Instal

bun add @capgo/capacitor-crisp
bunx cap sync

Impor

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

API Ringkasan

`configure`

Konfigurasi Crisp SDK dengan ID Situs Web Anda. Harus dipanggil sebelum menggunakan metode lainnya.

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

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

`openMessenger`

Buka jendela obrolan chat Crisp. Menampilkan antarmuka obrolan kepada pengguna.

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

await CapacitorCrisp.openMessenger();

`setTokenID`

Tetapkan ID token unik untuk sesi pengguna saat ini. Digunakan untuk mengidentifikasi dan memulihkan percakapan sebelumnya.

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

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

`setUser`

Tetapkan informasi pengguna untuk sesi saat ini. Mengupdate profil pengguna yang terlihat oleh agen dukungan.

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

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

`pushEvent`

Sampaikan acara kustom ke Crisp. Bermanfaat untuk melacak aksi dan perilaku pengguna.

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

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

`setCompany`

Tentukan informasi perusahaan untuk sesi saat ini. Hubungkan pengguna dengan perusahaan di 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`

Tentukan nilai integer data yang dapat disesuaikan. Simpan data numerik yang terkait dengan sesi pengguna.

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

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

`setString`

Tentukan nilai string data yang dapat disesuaikan. Simpan data teks yang terkait dengan sesi pengguna.

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

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

`sendMessage`

Kirim pesan dari pengguna ke obrolan. Kirim pesan secara otomatis seperti pengguna mengetiknya.

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

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

`setSegment`

Atur segment pengguna untuk target dan organisasi. Digunakan untuk mengategorikan pengguna di dashboard Crisp.

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

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

`reset`

Reset sesi Crisp. Menghapus semua data pengguna dan memulai sesi baru. Bermanfaat ketika pengguna keluar.

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

await CapacitorCrisp.reset();

Referensi Tipe

`ConfigureOptions`

Konfigurasi untuk menginisialisasi Crisp. __CAPGO_KEEP_0__

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`

Warna-warna yang tersedia untuk acara Crisp. Digunakan untuk mengategorikan visual acara di dashboard Crisp.

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

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Jalankan ulang sinkronisasi ketika publik API berubah di atas.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-crisp untuk kemampuan asli di Menggunakan @capgo/capacitor-crisp, Ringkasan API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API, dan Perangkat untuk detail implementasi di Perangkat.