Panduan
Cara menggunakan Intercom di Capacitor
Menggunakan @capgo/capacitor-intercom
Plugin Intercom Capacitor.
Instal
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { CapgoIntercom } from '@capgo/capacitor-intercom';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
loadWithKeys |
Inisialisasi Intercom dengan kunci API saat runtime. Gunakan ini jika Anda tidak ingin mengonfigurasi kunci di capacitor.config. |
registerIdentifiedUser |
Daftarkan user yang dikenal ke Intercom. Setidaknya salah satu dari userId atau email harus diisi. |
registerUnidentifiedUser |
Daftarkan user anonim ke Intercom. |
updateUser |
Perbarui atribut user di Intercom. |
logout |
Logout user dari Intercom. |
logEvent |
Log custom event di Intercom. |
displayMessenger |
Buka messenger Intercom. |
displayMessageComposer |
Buka composer pesan dengan pesan yang sudah terisi. |
displayHelpCenter |
Buka help center Intercom. |
hideMessenger |
Sembunyikan messenger Intercom. |
displayLauncher |
Tampilkan tombol launcher Intercom. |
hideLauncher |
Sembunyikan tombol launcher Intercom. |
displayInAppMessages |
Aktifkan pesan in-app dari Intercom. |
hideInAppMessages |
Nonaktifkan pesan in-app dari Intercom. |
displayCarousel |
Tampilkan carousel Intercom tertentu. |
displayArticle |
Tampilkan artikel Intercom tertentu. |
displaySurvey |
Tampilkan survei Intercom tertentu. |
setUserHash |
Atur HMAC untuk verifikasi identitas. |
setUserJwt |
Atur JWT untuk autentikasi messenger yang aman. |
setBottomPadding |
Atur padding bawah untuk UI messenger Intercom. |
sendPushTokenToIntercom |
Kirim token push notification ke Intercom. |
receivePush |
Tangani push notification Intercom yang diterima. |
getUnreadConversationCount |
Dapatkan jumlah percakapan belum terbaca untuk pengguna saat ini. |
Contoh
loadWithKeys()
Inisialisasi Intercom dengan kunci API saat runtime. Gunakan ini jika Anda tidak ingin 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()
Daftarkan user yang dikenal ke Intercom. Setidaknya salah satu dari userId atau email harus diisi.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Daftarkan user anonim ke Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Perbarui atribut user di Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Logout user dari Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Log custom event di Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
Tabel di atas mencantumkan 23 metode inti. Helper listener, versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.
Mendengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() saat layar di-unmount, atau CapgoIntercom.removeAllListeners() untuk menghapus semua listener.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-intercom
Jika Anda menggunakan Menggunakan @capgo/capacitor-intercom untuk merencanakan pekerjaan plugin native, hubungkan dengan @capgo/capacitor-intercom untuk detail implementasi di @capgo/capacitor-intercom, Panduan Memulai untuk detail implementasi di Getting Started, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh Capgo, dan Menambahkan atau Memperbarui Plugin untuk detail implementasi di bagian Menambahkan atau Memperbarui Plugin.