capacitor-incoming-call-kit

A Capacitor plugin to show incoming call in your Capacitor app(Custom for Android/Callkit for iOS)

This plugin is a modification of the Flutter plugin: flutter_callkit_incoming to suite a capacitor app so all credits goes to hiennguyen92

The plugin is has @capacitor/push-notifications version 6.0.1 integrated

Install

npm install capacitor-incoming-call-kit
npx cap sync

API

• onMethod(...)
• Interfaces
• Type Aliases

onMethod(...)

onMethod(options: { options: string; methodName: MethodNames; parsedOptions: CallKitParams; }) => Promise<Responses>

| Param | Type | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | options | { options: string; methodName: MethodNames; parsedOptions: CallKitParams; } |

Returns: Promise<Responses>

Interfaces

CallKitParams

| Prop | Type | | ------------------------------------- | ----------------------------------------------------------------- | | id | string | | nameCaller | string | | appName | string | | avatar | string | | handle | string | | type | number | | isOnHold | boolean | | normalHandle | number | | duration | number | | textAccept | string | | textDecline | string | | textMissedCall | string | | textCallback | string | | rationaleMessagePermission | string | | postNotificationMessageRequired | string | | missedCallNotification | NotificationParams | | extra | { [key: string]: any; } | | headers | { [key: string]: any; } | | android | AndroidParams | | ios | IOSParams |

NotificationParams

| Prop | Type | | ---------------------- | -------------------- | | id | number | | showNotification | boolean | | subtitle | string | | callbackText | string | | isShowCallback | boolean | | int | number |

AndroidParams

| Prop | Type | | ----------------------------------------- | -------------------- | | isCustomNotification | boolean | | isCustomSmallExNotification | boolean | | isShowLogo | boolean | | isShowCallID | boolean | | ringtonePath | string | | backgroundColor | string | | backgroundUrl | string | | actionColor | string | | textColor | string | | incomingCallNotificationChannelName | string | | missedCallNotificationChannelName | string | | isShowFullLockedScreen | boolean | | isImportant | boolean | | isBot | boolean |

IOSParams

| Prop | Type | | ------------------------------------------- | -------------------- | | iconName | string | | handleType | string | | supportsVideo | boolean | | maximumCallGroups | number | | maximumCallsPerCallGroup | number | | audioSessionMode | string | | audioSessionActive | boolean | | audioSessionPreferredSampleRate | number | | audioSessionPreferredIOBufferDuration | number | | configureAudioSession | boolean | | supportsDTMF | boolean | | supportsHolding | boolean | | supportsGrouping | boolean | | supportsUngrouping | boolean | | ringtonePath | string |

Type Aliases

Responses

void | { isMuted: boolean } | { calls: CallKitParams[] } | { isVersionOk: boolean } | { devicePushTokenVoIP: string }

MethodNames

'showCallkitIncoming' | 'checkIsVersionOk' | 'sendPendingAcceptEvent' | 'showCallkitIncomingSilently' | 'showMissCallNotification' | 'startCall' | 'muteCall' | 'holdCall' | 'isMuted' | 'endCall' | 'callConnected' | 'endAllCalls' | 'activeCalls' | 'getDevicePushTokenVoIP' | 'silenceEvents' | 'requestNotificationPermission' | 'requestFullIntentPermission' | 'hideCallkitIncoming' | 'endNativeSubsystemOnly' | 'setAudioRoute'