ガイド
Capacitor で Intercom を使う方法
@capgo/capacitor-intercom の使用方法
Intercom Capacitor プラグイン。
インストール
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapgoIntercom } from '@capgo/capacitor-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 |
現在のユーザーの未読会話数を取得します。 |
例
loadWithKeys()
実行時に API キーで Intercom を初期化します。capacitor.config でキーを設定したくない場合に使用します。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
Intercom に既知のユーザーを登録します。userId または email の少なくとも一方が必須です。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Intercom に匿名ユーザーを登録します。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Intercom のユーザー属性を更新します。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Intercomからユーザーをログアウトします。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Intercomでカスタムイベントを記録します。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
上記の表には、23個のコアメソッドが記載されています。リスナーとバージョンのヘルパー、および各メソッドの完全なコントラクトは、次にドキュメント化されています。 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapgoIntercom.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
「@capgo/capacitor-intercom の使用方法」から続ける
使用している場合 @capgo/capacitor-intercom の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-intercom @capgo/capacitor-intercom の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。