Getting Started

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. 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.

Manual Setup을 사용하는 경우, 플러그인을 설치하려면 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

bun add @capgo/capacitor-intercom
bunx cap sync

Import

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

API 개요

loadWithKeys

API 키를 런타임에 초기화하여 capacitor.config에서 키를 구성하지 않으려면 사용하세요.

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

await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);

registerIdentifiedUser

알려진 사용자를 Intercom에 등록합니다. 사용자 ID 또는 이메일 중 하나 이상을 제공해야 합니다.

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

await CapgoIntercom.registerIdentifiedUser({} as IntercomIdentifiedUserOptions);

registerUnidentifiedUser

익명 사용자를 Intercom에 등록합니다.

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

메시지 작성을 위한 오픈한 채팅 창을 열어주세요.

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

await CapgoIntercom.displayMessageComposer({} as IntercomMessageComposerOptions);

displayHelpCenter

인터콤 도움말 센터를 열어주세요.

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

await CapgoIntercom.displayHelpCenter();

hideMessenger

인터콤 메신저를 숨기세요.

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

await CapgoIntercom.hideMessenger();

displayLauncher

인터콤 런처 버튼을 표시하세요.

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

await CapgoIntercom.displayLauncher();

hideLauncher

인터콤 런처 버튼을 숨기세요.

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

await CapgoIntercom.hideLauncher();

displayInAppMessages

인터콤에서 앱 내 메시지를 활성화하세요.

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

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

인터콤에서 앱 내 메시지를 비활성화하세요.

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

await CapgoIntercom.hideInAppMessages();

displayCarousel

특정 인터콤 카러셀을 표시하세요.

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

await CapgoIntercom.displayCarousel({} as IntercomCarouselOptions);

displayArticle

특정 Intercom 글을 표시하세요.

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

await CapgoIntercom.displayArticle({} as IntercomArticleOptions);

displaySurvey

특정 Intercom 설문조사를 표시하세요.

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

await CapgoIntercom.displaySurvey({} as IntercomSurveyOptions);

setUserHash

사용자 식별성을 확인하기 위한 HMAC 설정

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

await CapgoIntercom.setUserHash({} as IntercomUserHashOptions);

setUserJwt

안전한 메신저 인증을 위한 JWT 설정

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

await CapgoIntercom.setUserJwt({} as IntercomUserJwtOptions);

setBottomPadding

Intercom 메신저 UI의 하단 패딩을 설정하세요.

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

await CapgoIntercom.setBottomPadding({} as IntercomBottomPaddingOptions);

sendPushTokenToIntercom

Intercom로 푸시 토큰을 전송하세요.

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

await CapgoIntercom.sendPushTokenToIntercom({} as IntercomPushTokenOptions);

receivePush

받은 Intercom 푸시 알림을 처리하세요.

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

await CapgoIntercom.receivePush({} as IntercomPushNotificationData);

getUnreadConversationCount

현재 사용자의 읽지 않은 대화 수를 가져오세요.

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. upstream에서 API가 변경되면 다시 싱크를 실행하세요.

Getting Started에서 계속

이 플러그인을 사용하는 경우 Getting Started 계획 대시보드 및 API 운영을 위해 Using @capgo/capacitor-intercom Using @capgo/capacitor-intercom API 개요 API 구현 세부 정보를 위한 소개 __CAPGO_KEEP_0__ 구현 세부 정보를 위한 API 키 API 키 구현 세부 정보를 위한, 그리고 장치 __CAPGO_KEEP_0__ 구현 세부 정보를 위한