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 AI Bantu 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
Judul bagian “Bagaimana integrasi ini berfungsi bersama”Plugin ini hanya mengelola presentasi panggilan masuk native. Aplikasi Anda masih mengelola transportasi, autentikasi, dan sesi media yang sebenarnya.
Polanya produksi yang umum adalah:
- Backend Anda atau SDK panggilan memancarkan event ring.
- Aplikasi Anda memanggil
showIncomingCall(). - Plugin menampilkan UI panggilan masuk native.
callAcceptedmenginformasikan aplikasi Anda untuk bergabung dengan ruang yang sebenarnya atau sesi VoIP.callDeclined,callEndedataucallTimedOutmenginformasikan aplikasi Anda untuk membersihkan status remote.
Integrasi minimal
Judul bagian “Integrasi 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 digunakan kembali kemudian denganendCall()timeoutMs: waktu tunggu tidak jelas yang berusaha menjawabextra: JSON acak ditampilkan kembali dalam pesan pendengarandroid.channelIddanandroid.channelName: pengaturan saluran peringatan Androidandroid.showFullScreen: meminta aktivitas panggilan masuk Android penuh layarios.handleType: pilihgeneric,phoneNumber,emailAddressatau
Menangani panggilan aktif
Judul bagian “Menangani panggilan aktif”const { calls } = await IncomingCallKit.getActiveCalls();
await IncomingCallKit.endCall({ callId: 'call-42', reason: 'remote-ended',});
await IncomingCallKit.endAllCalls({ reason: 'session-reset',});Model event
Judul bagian “Model event”incomingCallDisplayed: UI native ditampilkan dengan suksescallAccepted: pengguna menerima dari UI nativecallDeclined: pengguna menolak sebelum bergabungcallEnded: aplikasi Anda atau platform mengakhiri panggilan yang dilacakcallTimedOut: panggilan tetap tidak dijawab sampaitimeoutMs
Setiap event membawa payload yang dinormalisasi call dan data asli Anda extra objek.
Catatan Platform
Judul bagian “Catatan Platform”- 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.
Teruskan dari Getting Started
Judul bagian “Teruskan dari Getting Started”Jika Anda menggunakan Mulai untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-kit-panggilan-masuk untuk kemampuan asli dalam Menggunakan @capgo/capacitor-kit-panggilan-masuk, 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 di Perangkat.