Getting Started
Salin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-incoming-call-kit`
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/incoming-call-kit/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.
Pemasangan
Bagian berjudul “Pemasangan”Anda dapat menggunakan Pengaturan Asisten AI kami 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-pluginsLalu gunakan prompt berikut:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-incoming-call-kit` plugin in my project.Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:
-
Pasang paket
Jendela Terminal bun add @capgo/capacitor-incoming-call-kit -
Sinkronkan proyek native
Jendela Terminal bunx cap sync -
Pilih sumber ring Anda Putuskan apakah event panggilan masuk berasal dari backend Anda, sebuah SDK seperti Twilio atau Stream, atau jalur push native seperti FCM atau PushKit.
Bagaimana integrasi ini berfungsi bersama-sama
Bagian berjudul “Bagaimana integrasi ini berfungsi bersama-sama”Plugin ini hanya mengelola presentasi panggilan masuk native. Aplikasi Anda masih mengelola transportasi, autentikasi, dan sesi media yang sebenarnya.
Polanya produksi umum adalah:
- Backend Anda atau panggilan SDK mengeluarkan event panggilan.
- Aplikasi Anda memanggil
showIncomingCall(). - Plugin menampilkan UI panggilan masuk native.
callAcceptedmenginformasikan aplikasi Anda untuk bergabung dengan ruang nyata atau sesi VoIP.callDeclined,callEnded, ataucallTimedOutmenginformasikan aplikasi Anda untuk membersihkan status remote.
Pengintegrasian minimal
Bab berjudul “Pengintegrasian minimal”import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';
await IncomingCallKit.requestPermissions();await IncomingCallKit.requestFullScreenIntentPermission();
await IncomingCallKit.addListener('callAccepted', async ({ call }) => { console.log('Accepted', call.callId, call.extra); // Start or join your real call session here.});
await IncomingCallKit.addListener('callDeclined', ({ call }) => { console.log('Declined', call.callId); // Tell your backend or SDK that the user declined.});
await IncomingCallKit.addListener('callTimedOut', ({ call }) => { console.log('Timed out', call.callId); // Clear ringing state in your backend or SDK.});
await IncomingCallKit.showIncomingCall({ callId: 'call-42', callerName: 'Ada Lovelace', handle: '+39 555 010 020', appName: 'Capgo Phone', hasVideo: true, timeoutMs: 45_000, extra: { roomId: 'room-42', callerUserId: 'user_ada', }, android: { channelId: 'calls', channelName: 'Incoming Calls', showFullScreen: true, }, ios: { handleType: 'phoneNumber', },});Pilihan penting
Bab berjudul “Pilihan penting”callId: identifikasi stabil yang digunakan kembali kemudian denganendCall()timeoutMs: waktu tunggu yang berusaha sebaik mungkin tetapi tidak dijawabextra: JSON acak yang dikembalikan dalam payload pendengarandroid.channelIddanandroid.channelName: pengaturan saluran notifikasi Androidandroid.showFullScreen: meminta aktivitas panggilan masuk penuh layar Androidios.handleType: pilihgeneric,phoneNumber, atauemailAddressuntuk CallKit
Pengelolaan panggilan aktif
Bab berjudul “Pengelolaan panggilan aktif”const { calls } = await IncomingCallKit.getActiveCalls();
await IncomingCallKit.endCall({ callId: 'call-42', reason: 'remote-ended',});
await IncomingCallKit.endAllCalls({ reason: 'session-reset',});Model Acara
Judul Bagian “Model Acara”incomingCallDisplayed: UI asli ditampilkan dengan suksescallAccepted: pengguna menerima dari UI aslicallDeclined: pengguna menolak sebelum bergabungcallEnded: aplikasi Anda atau platform mengakhiri panggilan yang sedang diikuticallTimedOut: panggilan tetap tidak dijawab hinggatimeoutMs
Setiap acara membawa payload yang dinormalisasi call dan objek asli Anda. extra Catatan Platform
Judul Bagian “Catatan Platform”
__CAPGO_KEEP_0__- Baca panduan iOS sebelum menghubungkan CallKit ke dalam aliran PushKit atau APNs.
- Baca panduan Android sebelum mengandalkan intent layar penuh pada Android 14 dan seterusnya.
- Web tidak didukung.
Lanjutkan dari Getting Started
Judul bagian “Lanjutkan dari Getting Started”Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-kit panggilan masuk asli untuk kemampuan asli dalam Menggunakan @capgo/capacitor-kit panggilan masuk asli API Ringkasan untuk detail implementasi dalam API Ringkasan Pendahuluan untuk detail implementasi dalam Pendahuluan API Kunci untuk detail implementasi dalam API Kunci, dan Perangkat untuk detail implementasi dalam Perangkat.