ページ/エリア: Capgo マーケティング ウェブサイト。役割: ウェブサイト コピーの文。見られる場所: component doc/SignupCta.astro, component Hero.astro。

インストール

AIアシストセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-intercom` plugin in my project.

もしも手動設定を好むのであれば、以下のコマンドを実行し、下記のプラットフォーム固有の指示に従ってください:

bun add @capgo/capacitor-intercom
bunx cap sync

インポート

import { CapgoIntercom } from '@capgo/capacitor-intercom';

クイックスタート

Intercomを capacitor.config または loadWithKeys() 以下のAPIの前に。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.loadWithKeys({
  appId: 'your-app-id',
  apiKeyIOS: 'ios-api-key',
  apiKeyAndroid: 'android-api-key',
});
await CapgoIntercom.registerIdentifiedUser({ userId: '42', email: 'user@example.com' });
await CapgoIntercom.displayMessenger();

例：ヘルプセンター記事

await CapgoIntercom.displayArticle({ articleId: '12345' });

例：未読のアイコン

await CapgoIntercom.addListener('unreadCountDidChange', ({ count }) => {
  setBadge(count);
});

よくある間違い

• キー:呼び出し loadWithKeys() または、他のAPIよりもIntercomのキーを設定する。
• ログアウト: call logout() Web
• Web__CAPGO_KEEP_0__の概要

セクション「APIの概要」

loadWithKeys

IntercomをAPIキーで実行時に初期化します。 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ユーザーを登録します。 ユーザーIDまたはメールアドレスのいずれかを入力してください。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerIdentifiedUser({
  userId: 'user-id-123',
  email: 'user@example.com',
});

registerUnidentifiedUser

未知のユーザーを登録

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerUnidentifiedUser();

updateUser

ログアウト

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.updateUser({ userId: 'user-id-123' });

logout

未知のユーザーを登録

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logout();

logEvent

Intercomのカスタムイベントをログに記録します。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logEvent({ name: 'example' });

displayMessenger

Intercomのメッセンジャーを開きます。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessenger();

displayMessageComposer

メッセージコンポーザーを開き、メッセージを事前に埋め込みます。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessageComposer({ message: 'Hello from Capacitor' });

displayHelpCenter

Intercomのヘルプセンターを開きます。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayHelpCenter();

hideMessenger

Intercom メッセンジャーを非表示にする。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideMessenger();

displayLauncher

Intercom ランチャーボタンを表示する。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayLauncher();

hideLauncher

Intercom ランチャーボタンを非表示にする。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideLauncher();

displayInAppMessages

インアプリメッセージを有効にする

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

Intercomのインアプリメッセージを無効にします。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideInAppMessages();

displayCarousel

「表示カレンダー」セクション

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayCarousel({ carouselId: 'carousel-id-123' });

displayArticle

「表示記事」セクション

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayArticle({ articleId: 'article-id-123' });

displaySurvey

「表示アンケート」セクション

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displaySurvey({ surveyId: 'survey-id-123' });

setUserHash

ID認証のためのHMACを設定します。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserHash({ hmac: 'hmac' });

setUserJwt

ユーザーJWTを設定

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserJwt({ jwt: 'jwt' });

setBottomPadding

インター コム メッセンジャー UI の下部パディングを設定

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setBottomPadding({ value: 1 });

sendPushTokenToIntercom

プッシュ通知を受信

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.sendPushTokenToIntercom({ value: 'value' });

receivePush

受信したIntercomプッシュ通知を処理する。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.receivePush({});

getUnreadConversationCount

現在のユーザーの未読会話の数を取得する。

import { CapgoIntercom } from '@capgo/capacitor-intercom';

const result = await CapgoIntercom.getUnreadConversationCount();
console.log(result);

「getUnreadConversationCount」セクション

IntercomLoadOptions

export interface IntercomLoadOptions {
  appId?: string;
  apiKeyIOS?: string;
  apiKeyAndroid?: string;
}

IntercomIdentifiedUserOptions

export interface IntercomIdentifiedUserOptions {
  userId?: string;
  email?: string;
}

IntercomUserUpdateOptions

export interface IntercomUserUpdateOptions {
  userId?: string;
  email?: string;
  name?: string;
  phone?: string;
  languageOverride?: string;
  customAttributes?: { [key: string]: any };
  companies?: IntercomCompany[];
}

IntercomLogEventOptions

export interface IntercomLogEventOptions {
  name: string;
  data?: { [key: string]: any };
}

IntercomMessageComposerOptions

export interface IntercomMessageComposerOptions {
  message: string;
}

IntercomCarouselOptions

export interface IntercomCarouselOptions {
  carouselId: string;
}

IntercomArticleOptions

export interface IntercomArticleOptions {
  articleId: string;
}

IntercomSurveyOptions

export interface IntercomSurveyOptions {
  surveyId: string;
}

IntercomUserHashOptions

export interface IntercomUserHashOptions {
  hmac: string;
}

IntercomUserJwtOptions

export interface IntercomUserJwtOptions {
  jwt: string;
}

IntercomBottomPaddingOptions

export interface IntercomBottomPaddingOptions {
  value: number;
}

IntercomPushTokenOptions

export interface IntercomPushTokenOptions {
  value: string;
}

真実の源

このページはプラグインの src/definitions.tsパブリック API がアップストリームで変更されたときに再度同期してください。

Getting Started から続けてください

Capgoを使用している場合 Getting Started Capgoを使用してダッシュボードとAPIの操作を計画する場合、CapgoをAPIに接続します。 Using @capgo/capacitor-intercom @capgo/capacitor-intercomのネイティブ機能の使用 CapgoのAPIの概要 CapgoのAPIの概要 Capgoの導入 Capgoの導入 CapgoのAPIキー CapgoのAPIキー デバイス デバイスの実装詳細について