メインコンテンツにジャンプ

@capgo/capacitor-crisp

SDKのCrisp Chat プラグインは、Capacitorでライブチャットや顧客サポート機能を提供します。

Cloudflareの「Crisp Chat SDK」プラグイン。 Capacitor に対して、リアルタイムチャットや顧客サポート機能を提供します。

  • configure - Cloudflareの「Crisp SDK」にウェブサイトIDを設定する。使用する他のメソッドよりも前に呼び出す必要があります。
  • openMessenger - Crispメッセンジャーウィンドウを開く。ユーザーにチャットインターフェイスを表示します。
  • setTokenID - 現在のユーザーセッションに一意のトークンIDを設定する。以前の会話を識別して復元するために使用します。
  • setUser - 現在のセッションにユーザー情報を設定する。サポートエージェントに表示されるユーザープロフィールを更新します。
メソッド説明
configureサイトIDを入力してCrispを設定してください。SDKを呼び出す前に他のメソッドを使用することはできません。
openMessengerCrispのメッセンジャーチャットウィンドウを開きます。ユーザーにチャットインターフェースを表示します。
setTokenIDユーザーセッションのユニークなトークンIDを設定します。ユーザーを識別し、前の会話を復元するために使用されます。
setUserユーザー情報を現在のセッションに設定します。サポートエージェントに表示されるユーザープロフィールを更新します。
pushEventユーザー行動や動作を追跡するために、カスタムイベントをCrispにプッシュします。
setCompany現在のセッションに会社情報を設定します。ユーザーをCrispの会社と関連付けます。
setIntユーザーセッションに関連付けられた数値データを保存するカスタム整数データフィールドを設定します。
setStringユーザーセッションに関連付けられたテキストデータを保存するカスタム文字列データフィールドを設定します。
sendMessageユーザーからチャットにメッセージを送信します。ユーザーが入力したようにメッセージをプログラムで送信します。
setSegmentユーザーをターゲットや組織化するためにセグメントを設定します。Crispのダッシュボードでユーザーを分類します。
resetCrispのセッションをリセットします。ユーザーデータをすべてクリアし、新しいセッションを開始します。ユーザーがログアウトしたときに便利です。
getPluginVersionプラグインのバージョン番号を取得します。

このリファレンスは src/definitions.tscapacitor-crisp.