Mulai Berjalan

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

Kamu bisa menggunakan Setup Bantuan AI untuk menginstal plugin ini. Tambahkan Capgo kemampuan ke alat AI kamu menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-crisp` plugin in my project.

Jika kamu lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

bun add @capgo/capacitor-crisp
bunx cap sync

Import

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

Ringkasan API

`configure`

Konfigurasi Crisp SDK dengan ID situs web Anda. Wajib 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`

Setel token ID 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`

Set informasi pengguna untuk sesi saat ini. Mengupdate profil pengguna yang dapat dilihat oleh agen dukungan.

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

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

`pushEvent`

Kirimkan event kustom ke Crisp. Bermanfaat untuk melacak aksi pengguna dan perilaku.

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

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

`setCompany`

Set informasi perusahaan untuk sesi saat ini. Menyertakan 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`

Set nilai integer data kustom. Menyimpan data numerik yang terkait dengan sesi pengguna.

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

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

`setString`

Setlah nilai string data yang dapat disesuaikan. Mengarsipkan 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. Mengirim pesan secara programatis seolah-olah pengguna mengetiknya.

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

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

`setSegment`

Setlah segment pengguna untuk target dan pengorganisasian. Digunakan untuk mengategorikan pengguna di dashboard Crisp.

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

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

`reset`

Mengatur ulang sesi Crisp. Menghapus semua data pengguna dan memulai sesi baru. Dapat berguna ketika pengguna keluar.

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

await CapacitorCrisp.reset();

Referensi Tipe

`ConfigureOptions`

Pengaturan untuk menginisialisasi 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`

Warna yang tersedia untuk event Crisp. Digunakan untuk mengkategorikan visual event 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. Re-run 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 dalam Menggunakan @capgo/capacitor-crisp, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi dalam Pendahuluan, API Kunci untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.