Getting Started
설치
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-intercom`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/intercom/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
설치
설치Capgo 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-intercombunx cap syncimport
설정import { CapgoIntercom } from '@capgo/capacitor-intercom';API 개요
API 개요loadWithKeys
loadWithKeysAPI 키를 런타임에 초기화하여 capacitor.config에서 키를 구성하지 않으려면 사용하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);registerIdentifiedUser
__CAPGO_KEEP_0__등록된 사용자 등록
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
메시지 작성을 위한 화면 표시 섹션메시지 작성을 위한 메시지 컴포저를 열어보세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayMessageComposer({} as IntercomMessageComposerOptions);displayHelpCenter
displayHelpCenter도움말 센터를 열어보세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayHelpCenter();hideMessenger
hideMessenger인터콤 메신저를 숨기세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.hideMessenger();displayLauncher
displayLauncher인터콤 런처 버튼을 표시하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayLauncher();hideLauncher
hideLauncher인터콤 런처 버튼을 숨기세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.hideLauncher();displayInAppMessages
"displayInAppMessages" 섹션인터콤에서 앱 내 메시지를 활성화하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayInAppMessages();hideInAppMessages
"hideInAppMessages" 섹션인터콤에서 앱 내 메시지를 비활성화하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.hideInAppMessages();displayCarousel
"displayCarousel" 섹션특정 인터콤 카러셀을 표시하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayCarousel({} as IntercomCarouselOptions);displayArticle
"displayArticle" 섹션특정 Intercom 문서를 표시합니다.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displayArticle({} as IntercomArticleOptions);displaySurvey
설명서 제목 “displaySurvey”특정 Intercom 설문조사를 표시합니다.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.displaySurvey({} as IntercomSurveyOptions);setUserHash
설명서 제목 “setUserHash”사용자 식별성을 확인하기 위한 HMAC 설정
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.setUserHash({} as IntercomUserHashOptions);setUserJwt
설명서 제목 “setUserJwt”안전한 메신저 인증을 위한 JWT 설정
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.setUserJwt({} as IntercomUserJwtOptions);setBottomPadding
설명서 제목 “setBottomPadding”Intercom 메신저 UI의 하단 패딩을 설정하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.setBottomPadding({} as IntercomBottomPaddingOptions);sendPushTokenToIntercom
sendPushTokenToIntercomIntercom으로 푸시 토큰을 전송하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.sendPushTokenToIntercom({} as IntercomPushTokenOptions);receivePush
receivePush받은 Intercom 푸시 알림을 처리하세요.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.receivePush({} as IntercomPushNotificationData);getUnreadConversationCount
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
인터콤 사용자 JWT 옵션 항목export interface IntercomUserJwtOptions { jwt: string;}IntercomBottomPaddingOptions
인터콤 하단 여백 옵션 항목export interface IntercomBottomPaddingOptions { value: number;}IntercomPushTokenOptions
인터콤 푸시 토큰 옵션 항목export interface IntercomPushTokenOptions { value: string;}실질적인 출처
“실질적인 출처” 섹션이 페이지는 플러그인의 src/definitions.ts. Re-run the sync when the public API changes upstream.
Getting Started에서 계속
“Getting Started에서 계속” 섹션이 플러그인을 사용하는 경우 Getting Started 계획 대시보드 및 API 운영을 위해 Using @capgo/capacitor-intercom Using @capgo/capacitor-intercom API 개요 API 개요의 구현 세부 정보를 위해 소개 소개의 구현 세부 정보를 위해 API 키 API 키의 구현 세부 정보, 그리고 장치 장치의 구현 세부 정보를 위해