시작하기

설치

bun add @capgo/capacitor-intercom
bunx cap sync

수입

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

API 개요

loadWithKeys

API 키를 런타임에 초기화하여 Intercom을 초기화합니다. capacitor.config에서 키를 구성하지 않아도 됩니다.

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

await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);

registerIdentifiedUser

__CAPGO_KEEP_0__ 사용자 ID 또는 이메일 중 하나 이상을 제공해야 합니다.

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

await CapgoIntercom.registerIdentifiedUser({} as IntercomIdentifiedUserOptions);

registerUnidentifiedUser

클립보드 복사

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

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Intercom에서 사용자 속성을 업데이트합니다.

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

await CapgoIntercom.updateUser({} as IntercomUserUpdateOptions);

logout

Intercom에서 사용자를 로그아웃합니다.

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

await CapgoIntercom.logout();

logEvent

Intercom에서 사용자 정의 이벤트를 로깅합니다.

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

await CapgoIntercom.logEvent({} as IntercomLogEventOptions);

displayMessenger

Intercom 메신저를 열어주세요.

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

await CapgoIntercom.displayMessenger();

displayMessageComposer

__CAPGO_KEEP_1__

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

await CapgoIntercom.displayMessageComposer({} as IntercomMessageComposerOptions);

displayHelpCenter

__CAPGO_KEEP_1__

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

await CapgoIntercom.displayHelpCenter();

hideMessenger

__CAPGO_KEEP_1__

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

await CapgoIntercom.hideMessenger();

displayLauncher

__CAPGO_KEEP_1__

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

await CapgoIntercom.displayLauncher();

hideLauncher

__CAPGO_KEEP_1__

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

await CapgoIntercom.hideLauncher();

displayInAppMessages

__CAPGO_KEEP_4__

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

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

__CAPGO_KEEP_7__

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

await CapgoIntercom.hideInAppMessages();

displayCarousel

__CAPGO_KEEP_10__

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

await CapgoIntercom.displayCarousel({} as IntercomCarouselOptions);

displayArticle

__CAPGO_KEEP_1__

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

await CapgoIntercom.displayArticle({} as IntercomArticleOptions);

displaySurvey

__CAPGO_KEEP_4__

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

await CapgoIntercom.displaySurvey({} as IntercomSurveyOptions);

setUserHash

__CAPGO_KEEP_7__

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

await CapgoIntercom.setUserHash({} as IntercomUserHashOptions);

setUserJwt

__CAPGO_KEEP_10__

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

await CapgoIntercom.setUserJwt({} as IntercomUserJwtOptions);

setBottomPadding

__CAPGO_KEEP_1__

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

await CapgoIntercom.setBottomPadding({} as IntercomBottomPaddingOptions);

sendPushTokenToIntercom

__CAPGO_KEEP_4__

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

await CapgoIntercom.sendPushTokenToIntercom({} as IntercomPushTokenOptions);

receivePush

__CAPGO_KEEP_7__

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

await CapgoIntercom.receivePush({} as IntercomPushNotificationData);

getUnreadConversationCount

__CAPGO_KEEP_10__

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

await CapgoIntercom.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이 업스트림에서 변경될 때 다시 싱크를 실행하세요.