はじめに

インストール

bun add @capgo/capacitor-crisp
bunx cap sync

インポート

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

APIの概要

configure

SDKの設定

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

setTokenID

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

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

setUser

setUser

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

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

pushEvent

pushEvent

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

Crisp セッションをリセットします。 ユーザー データをすべてクリアし、新しいセッションを開始します。 ユーザーがログアウトしたときに便利です。

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

await CapacitorCrisp.reset();

タイプ リファレンス

ConfigureOptions

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

Crisp イベントの利用可能な色。Crisp ダッシュボードでイベントを視覚的に分類するために使用されます。

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

真実の源

このページはプラグインの src/definitions.ts公開 API がアップストリームで変更された場合に再度 Sync を実行してください。