@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 |
신원 확인을 위한 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개의 핵심 메서드가 나와 있습니다. Listener와 version 헬퍼, 그리고 각 메서드의 전체 명세는 다음 문서에 설명되어 있습니다. GitHub 리포지토리.
이벤트 수신
addListener 핸들을 반환합니다. 호출하세요 handle.remove() 화면이 언마운트될 때, 또는 CapgoIntercom.removeAllListeners() 모든 리스너를 해제하려면.
전체 레퍼런스
@capgo/capacitor-intercom 사용법 계속 보기
사용 중이라면 @capgo/capacitor-intercom 사용하기 네이티브 플러그인 작업을 계획하려면, 이를 다음 항목과 연결하세요: @capgo/capacitor-intercom 구현 세부 사항은 @capgo/capacitor-intercom에서, 시작하기 Getting Started의 구현 상세 내용은 Capgo 플러그인 디렉토리 Capgo Plugin Directory의 제품 워크플로우에 맞춰, Capgo의 Capacitor 플러그인 Capgo의 Capacitor Plugins 구현 세부 사항 및 플러그인 추가 또는 업데이트 플러그인 추가 또는 업데이트의 구현 세부 사항은.