Mulai Menggunakan

Instalasi

Anda dapat menggunakan Pengaturan Bantu AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

bun add @capgo/capacitor-intercom
bunx cap sync

Import

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

API Pengantar

loadWithKeys

Mulai Intercom dengan API kunci pada waktu eksekusi. Gunakan ini jika Anda lebih suka tidak mengonfigurasi kunci di capacitor.config.

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

await CapgoIntercom.loadWithKeys({
  appId: 'app-id-123',
  apiKeyIOS: 'api-key-ios',
  apiKeyAndroid: 'api-key-android',
});

registerIdentifiedUser

Mendaftarkan pengguna yang dikenal dengan Intercom. Setidaknya salah satu userId atau email harus disediakan.

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

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

registerUnidentifiedUser

Mendaftarkan pengguna anonim dengan Intercom.

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

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Mengupdate atribut pengguna di Intercom.

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

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

logout

Mengeluarkan pengguna dari Intercom.

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

await CapgoIntercom.logout();

logEvent

Mengirimkan event kustom di Intercom.

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

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

displayMessenger

Buka pesan Intercom.

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

await CapgoIntercom.displayMessenger();

displayMessageComposer

Buka komposer pesan dengan pesan yang sudah diisi.

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

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

displayHelpCenter

Buka pusat bantuan Intercom.

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

await CapgoIntercom.displayHelpCenter();

hideMessenger

Sembunyikan pesan Intercom.

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

await CapgoIntercom.hideMessenger();

displayLauncher

Tampilkan tombol launcher Intercom.

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

await CapgoIntercom.displayLauncher();

hideLauncher

Sembunyikan tombol launcher Intercom.

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

await CapgoIntercom.hideLauncher();

displayInAppMessages

Aktifkan pesan dalam aplikasi dari Intercom.

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

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

Matikan pesan dalam aplikasi dari Intercom.

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

await CapgoIntercom.hideInAppMessages();

displayCarousel

Tampilkan carousel Intercom tertentu.

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

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

displayArticle

Tampilkan artikel Intercom tertentu.

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

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

displaySurvey

Tampilkan survei Intercom tertentu.

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

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

setUserHash

Setel HMAC untuk verifikasi identitas.

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

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

setUserJwt

Set JWT untuk autentikasi pesan messenger yang aman.

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

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

setBottomPadding

Set jarak bawah untuk antarmuka UI messenger Intercom.

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

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

sendPushTokenToIntercom

Kirimkan token notifikasi push ke Intercom.

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

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

receivePush

Penerima notifikasi push dari Intercom.

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

await CapgoIntercom.receivePush({});

getUnreadConversationCount

Peroleh jumlah percakapan yang belum dibaca untuk pengguna saat ini.

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

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

Referensi Tipe

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;
}

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.tsRe-run sinkronisasi ketika API publik berubah di atas

Lanjutkan dari Getting Started

Jika Anda menggunakan Mulai Berjalan untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-intercom untuk kemampuan asli di Menggunakan @capgo/capacitor-intercom, Ringkasan API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API, dan Perangkat Untuk detail implementasi di Perangkat.