Mulai Menggunakan

Copikan 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.

Instalasi

Anda dapat menggunakan Pengaturan Bantuan AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda 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 Anda lebih suka Pengaturan 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';

API Ringkasan

`configure`

Konfigurasi Crisp SDK dengan ID situs web Anda. Harus dipanggil sebelum menggunakan metode lainnya.

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

await CapacitorCrisp.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`

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

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

await CapacitorCrisp.setTokenID({ tokenID: 'token-id-123' });

`setUser`

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

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

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

`pushEvent`

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

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

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

`setCompany`

Atur informasi perusahaan untuk sesi saat ini. Menghubungkan pengguna dengan perusahaan di Crisp.

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

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

`setInt`

Set lapangan data integer kustom. Menyimpan data numerik terkait sesi pengguna.

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

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

`setString`

Set lapangan data string kustom. Menyimpan data teks terkait sesi pengguna.

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

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

`sendMessage`

Kirim pesan dari pengguna ke obrolan. Mengirim pesan secara programatis seperti pengguna mengetiknya.

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

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

`setSegment`

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

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

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

`reset`

Mulai ulang 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.

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 mengategorikan event secara visual di dashboard Crisp.

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

Sumber Kebenaran

Sumber Kebenaran ini dihasilkan dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika API publik berubah di atas

Teruskan dari Getting Started

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