Panduan
Cara menggunakan Intercom di Capacitor
Menggunakan @capgo/capacitor-intercom
Plugin Intercom Capacitor.
Pasang
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync Menggandakan kode native plugin code ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Impor
import { CapgoIntercom } from '@capgo/capacitor-intercom';
Pandangan singkat API
| Metode | Deskripsi |
|---|---|
loadWithKeys |
Mulai Intercom dengan API kunci pada waktu runtime. Gunakan ini jika Anda lebih suka tidak mengonfigurasi kunci di capacitor.config. |
registerIdentifiedUser |
Daftarkan pengguna yang diketahui dengan Intercom. Setidaknya salah satu userId atau email harus disediakan. |
registerUnidentifiedUser |
Daftarkan pengguna anonim dengan Intercom. |
updateUser |
Perbarui atribut pengguna di Intercom. |
logout |
Keluar dari Intercom. |
logEvent |
Log acara kustom di Intercom. |
displayMessenger |
Buka pesan Intercom. |
displayMessageComposer |
Buka komposer pesan dengan pesan yang sudah diisi. |
displayHelpCenter |
Buka pusat bantuan Intercom. |
hideMessenger |
Tutup pesan Intercom. |
displayLauncher |
Tampilkan tombol peluncur Intercom. |
hideLauncher |
Tutup tombol peluncur Intercom. |
displayInAppMessages |
aktifkan pesan dalam aplikasi dari Intercom. |
hideInAppMessages |
nonaktifkan pesan dalam aplikasi 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 pesan aman. |
setBottomPadding |
atur jarak bawah untuk antarmuka UI pesan Intercom. |
sendPushTokenToIntercom |
Kirimkan token notifikasi push ke Intercom. |
receivePush |
proses notifikasi push yang diterima dari Intercom. |
getUnreadConversationCount |
ambil jumlah percakapan yang belum dibaca untuk pengguna saat ini. |
Contoh-Contoh
loadWithKeys()
Mulai Intercom dengan API kunci pada waktu runtime. Gunakan ini jika Anda lebih suka tidak mengkonfigurasi 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 pengguna yang diketahui 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()
Daftarkan pengguna anonim dengan Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Perbarui atribut pengguna di Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Keluar dari Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Logkan acara kustom di Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
Tabel di atas menampilkan 23 metode inti. Bantuan listener dan versi, serta kontrak lengkap dari setiap metode, dapat dilihat dalam repository GitHub.
kembali sebuah handle. Panggil
addListener ketika layar dihapus, atau handle.remove() untuk menghapus setiap pendengar. CapgoIntercom.removeAllListeners() Menghapus semua pendengar.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-intercom
Jika Anda menggunakan Menggunakan @capgo/capacitor-intercom untuk merencanakan pekerjaan plugin native, hubungkannya dengan @capgo/capacitor-intercom untuk detail implementasi di @capgo/capacitor-intercom Mulai Menggunakan untuk detail implementasi di Mulai, Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, dan Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin.