Getting Started

설치

bun add @capgo/capacitor-crisp
bunx cap sync

Import

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

API 개요

configure

SDK을 사용하여 웹사이트 ID를 설정하세요. 다른 메서드를 사용하기 전에 반드시 호출해야 합니다.

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

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

openMessenger

Crisp 메신저 대화 창을 열어 주세요.

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

await CapacitorCrisp.openMessenger();

setTokenID

현재 사용자 세션에 고유한 토큰 ID를 설정합니다. 이전 대화 복원 및 사용자 식별을 위해 사용됩니다.

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

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

setUser

현재 세션에 사용자 정보를 설정합니다. 지원 대원에게 표시되는 사용자 프로필을 업데이트합니다.

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

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

pushEvent

Crisp에 사용자 행동 및 행동을 추적하기 위한 커스텀 이벤트를 푸시합니다.

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

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

setCompany

현재 세션에 회사 정보를 설정합니다. 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

현재 세션에 숫자 데이터를 저장합니다.

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

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

setString

현재 세션에 텍스트 데이터를 저장합니다.

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

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

sendMessage

사용자가 입력한 것처럼 메시지를 프로그램적으로 전송합니다.

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

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

setSegment

사용자를 분류하기 위해 Crisp 대시보드에서 사용하는 사용자 세그먼트를 설정합니다.

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

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

reset

사용자 데이터를 모두 삭제하고 새로운 세션을 시작합니다. 사용자가 로그아웃할 때 유용합니다.

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

await CapacitorCrisp.reset();

타입 참조

ConfigureOptions

클립보드에 복사

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

__CAPGO_KEEP_0__

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

진리 근원

이 페이지는 플러그인의 src/definitions.ts 다시 싱크를 실행하세요. upstream의 API가 변경되었을 때.