Pemula

Instal

Anda dapat menggunakan Pengaturan AI-Assisted 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 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

Impor

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

Ringkasan API

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

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

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

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

setUser

Atur 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

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

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

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

setCompany

Tetapkan informasi perusahaan untuk sesi saat ini. Menghubungkan 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

Tetapkan sebuah data integer kustom. Menyimpan data numerik yang terkait dengan sesi pengguna.

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

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

setString

Tetapkan sebuah data string kustom. Menyimpan 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 programatis seperti pengguna mengetiknya.

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

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

setSegment

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

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 acara Crisp. Digunakan untuk mengategorikan acara secara visual 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 sync ketika publik API berubah di atas.

Teruskan dari Getting Started

Jika Anda menggunakan Membuat Mulai 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 dalam API Kunci, dan Perangkat untuk detail implementasi dalam Perangkat.