capicitor-plugin-twiliovoice

twilio voice for ios call kit support

Install

npm install capicitor-plugin-twiliovoice
npx cap sync

API

• echo(...)
• initializeWithAccessToken(...)
• startCall(...)
• disconnectCall()
• unmuteCall()
• muteCall()
• setSpeaker(...)
• addListener('calldidconnect', ...)
• addListener('callDidDisconnect', ...)
• addListener('callInviteCanceled', ...)
• addListener('callInviteReceived', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

initializeWithAccessToken(...)

initializeWithAccessToken(options: InitOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------- | | options | InitOptions |

startCall(...)

startCall(options: CallReqest) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | CallReqest |

disconnectCall()

disconnectCall() => Promise<void>

unmuteCall()

unmuteCall() => Promise<void>

muteCall()

muteCall() => Promise<void>

setSpeaker(...)

setSpeaker(options: { value: boolean; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------- | | options | { value: boolean; } |

addListener('calldidconnect', ...)

addListener(eventName: 'calldidconnect', listenerFunc: (call: Call) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Listens for screen orientation changes.

| Param | Type | | ------------------ | -------------------------------------------------------- | | eventName | 'calldidconnect' | | listenerFunc | (call: Call) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('callDidDisconnect', ...)

addListener(eventName: 'callDidDisconnect', listenerFunc: (call: Call) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | -------------------------------------------------------- | | eventName | 'callDidDisconnect' | | listenerFunc | (call: Call) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('callInviteCanceled', ...)

addListener(eventName: 'callInviteCanceled', listenerFunc: (cancelledCall: CancelledCallInvite) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------- | | eventName | 'callInviteCanceled' | | listenerFunc | (cancelledCall: Call) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('callInviteReceived', ...)

addListener(eventName: 'callInviteReceived', listenerFunc: (inviteCall: CallInvite) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | -------------------------------------------------------------------------- | | eventName | 'callInviteReceived' | | listenerFunc | (inviteCall: CallInvite) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners

Interfaces

InitOptions

| Prop | Type | | ----------------- | ------------------- | | accessToken | string |

CallReqest

| Prop | Type | | -------- | ------------------- | | to | string |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

Call

| Prop | Type | | ---------- | ------------------- | | from | string | | to | string | | sid | string |

CallInvite

| Prop | Type | | ---------- | ------------------- | | uuid | string |

Type Aliases

CancelledCallInvite

Call