Skip to content

@capgo/capacitor-incoming-call-kit

Capacitor API for presenting a native incoming-call surface.

Capacitor API for presenting a native incoming-call surface.

  • showIncomingCall - Displays the native incoming call UI.
  • endCall - Ends a specific tracked call.
  • endAllCalls - Ends every tracked call.
  • getActiveCalls - Returns the currently tracked calls.
MethodDescription
showIncomingCallDisplays the native incoming call UI.
endCallEnds a specific tracked call.
endAllCallsEnds every tracked call.
getActiveCallsReturns the currently tracked calls.
checkPermissionsReturns the current permission state for notifications and full-screen intents.
requestPermissionsRequests the notification permission when the platform supports it.
requestFullScreenIntentPermissionOpens the Android 14+ full-screen intent settings page when available.
getPluginVersionReturns the native implementation version marker.
addListenerFired after the call has been handed to the native platform UI.
addListenerFired when the user accepts the call from native UI.
addListenerFired when the user declines the call from native UI.
addListenerFired when a call ends through the API or a platform action.
addListenerFired when an unanswered call reaches its configured timeout.
removeAllListenersRemoves every native listener registered by the plugin.

This reference is synced from src/definitions.ts in capacitor-incoming-call-kit.