@capgo/capacitor-intercom

概要

@capgo/capacitor-intercom 公式の Intercom モバイル SDK をラップし、サポート、オンボーディング、ライフサイクルキャンペーンをネイティブに保ちながら、アプリシェルを Capacitor のままにします。JavaScript からユーザーを識別し、メッセンジャーを開き、イベントを記録し、ヘルプセンターのコンテンツを表示できます。

プラットフォーム対応

プラットフォーム	サポート
iOSと	Intercom iOS SDK
Androidでは	Intercom Android SDK
Web	非対応

コア機能

• loadWithKeys - 実行時に API キーで Intercom を初期化します。capacitor.config でキーを設定したくない場合に使用します。
• registerIdentifiedUser - Intercom に既知のユーザーを登録します。userId または email の少なくとも一方が必須です。
• registerUnidentifiedUser - Intercom に匿名ユーザーを登録します。
• updateUser - Intercom のユーザー属性を更新します。

公開 API

メソッド	説明
loadWithKeys	実行時に API キーで Intercom を初期化します。capacitor.config でキーを設定したくない場合に使用します。
registerIdentifiedUser	Intercom に既知のユーザーを登録します。userId または email の少なくとも一方が必須です。
registerUnidentifiedUser	Intercom に匿名ユーザーを登録します。
updateUser	Intercom のユーザー属性を更新します。
logout	Intercomからユーザーをログアウトします。
logEvent	Intercomでカスタムイベントを記録します。
displayMessenger	Intercomのメッセンジャーを開きます。
displayMessageComposer	メッセージが入力済みの状態でメッセージコンポーザーを開きます。
displayHelpCenter	Intercom ヘルプセンターを開く
hideMessenger	Intercom メッセンジャーを非表示にする
displayLauncher	Intercom ランチャーボタンを表示する
hideLauncher	Intercom のランチャーボタンを非表示にします。
displayInAppMessages	Intercomのアプリ内メッセージを有効にします。
hideInAppMessages	Intercomのアプリ内メッセージを無効にします。
displayCarousel	特定のIntercomカルーセルを表示します。
displayArticle	特定のIntercom記事を表示します。
displaySurvey	特定の Intercom 調査を表示します。
setUserHash	ID 検証用の HMAC を設定します。
setUserJwt	セキュアなメッセンジャー認証用の JWT を設定します。
setBottomPadding	Intercom メッセンジャー UI の下パディングを設定します。
sendPushTokenToIntercom	プッシュ通知トークンを Intercom に送信します。
receivePush	受信した Intercom のプッシュ通知を処理します。
getUnreadConversationCount	現在のユーザーの未読会話数を取得します。
addListener	Intercom ウィンドウが表示されたときにリスニングします。
addListener	Intercom ウィンドウが非表示になったときにリスニングします。
addListener	未読会話数の変更をリスニングします。
removeAllListeners	すべてのイベントリスナーを削除します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-intercom.

@capgo/capacitor-intercomから続行

使用している場合 @capgo/capacitor-intercom ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-intercom の使用方法 @capgo/capacitor-intercomのネイティブ機能について、@capgo/capacitor-intercomの使用において、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。