utilises a brand new iOS 10 framework CallKit and Android ConnectionService to make the life easier for VoIP developers using Capacitor
npm install callkeep
npx cap sync
echo(options: { value: string; }) => Promise<{ value: string; }>
Param |
Type |
options |
{ value: string; } |
Returns: Promise<{ value: string; }>
register() => Promise<void>
addListener('registration', ...)
addListener(eventName: 'registration', listenerFunc: (token: CallToken) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param |
Type |
eventName |
'registration' |
listenerFunc |
(token: CallToken) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
addListener('callAnswered', ...)
addListener(eventName: 'callAnswered', listenerFunc: (callData: CallData) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param |
Type |
eventName |
'callAnswered' |
listenerFunc |
(callData: CallData) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
addListener('callStarted', ...)
addListener(eventName: 'callStarted', listenerFunc: (callData: CallData) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param |
Type |
eventName |
'callStarted' |
listenerFunc |
(callData: CallData) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
addListener('callEnded', ...)
addListener(eventName: 'callEnded', listenerFunc: (callData: CallData) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Param |
Type |
eventName |
'callEnded' |
listenerFunc |
(callData: CallData) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Prop |
Type |
remove |
() => Promise<void> |
Prop |
Type |
Description |
value |
string |
VOIP Token |
Prop |
Type |
Description |
id |
string |
Call ID |
media |
CallType |
Call Type |
name |
string |
Call Display name |
duration |
string |
Call duration |
Prop |
Type |
type |
'message' |
callbackId |
string |
pluginId |
string |
methodName |
string |
options |
any |
Prop |
Type |
type |
'js.error' |
error |
{ message: string; url: string; line: number; col: number; errorObject: string; } |
'video' | 'audio'
MessageCallData | ErrorCallData