capacitor-plugin-vonage

opentok sdk capacitor plugin

Install

npm install capacitor-plugin-vonage
npx cap sync

API

• echo(...)
• openVideoCallWindow(...)
• endVideoCall()
• setPatientOnlineStatus(...)
• setSendNotificationStatus(...)
• addListener([eventName: 'VideoCallEnded', listenerFunc: (info: any) => void] | [eventName: 'SendNotification', listenerFunc: (info: any) => void] | [eventName: 'VideoCallStarted', listenerFunc: (info: any) => void], ...)
• Interfaces
• Type Aliases

echo(...)

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

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

Returns: Promise<{ value: string; }>

openVideoCallWindow(...)

openVideoCallWindow(options: Object) => Promise<{ value: any; }>

| Param | Type | | ------------- | ----------------------------------------- | | options | Object |

Returns: Promise<{ value: any; }>

endVideoCall()

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

Returns: Promise<{ value: string; }>

setPatientOnlineStatus(...)

setPatientOnlineStatus(options: Object) => Promise<{ value: any; }>

| Param | Type | | ------------- | ----------------------------------------- | | options | Object |

Returns: Promise<{ value: any; }>

setSendNotificationStatus(...)

setSendNotificationStatus(options: Object) => Promise<{ value: any; }>

| Param | Type | | ------------- | ----------------------------------------- | | options | Object |

Returns: Promise<{ value: any; }>

addListener([eventName: 'VideoCallEnded', listenerFunc: (info: any) => void] | [eventName: 'SendNotification', listenerFunc: (info: any) => void] | [eventName: 'VideoCallStarted', listenerFunc: (info: any) => void], ...)

addListener(...args: [eventName: "VideoCallEnded", listenerFunc: (info: any) => void] | [eventName: "SendNotification", listenerFunc: (info: any) => void] | [eventName: "VideoCallStarted", listenerFunc: (info: any) => void]) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | args | [eventName: 'VideoCallEnded', listenerFunc: (info: any) => void] | [eventName: 'SendNotification', listenerFunc: (info: any) => void] | [eventName: 'VideoCallStarted', listenerFunc: (info: any) => void] |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Interfaces

Object

Provides functionality common to all JavaScript objects.

| Prop | Type | Description | | ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | constructor | Function | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |

| Method | Signature | Description | | ------------------------ | --------------------------------------------------------- | ------------------------------------------------------------------------ | | toString | () => string | Returns a string representation of an object. | | toLocaleString | () => string | Returns a date converted to a string using the current locale. | | valueOf | () => Object | Returns the primitive value of the specified object. | | hasOwnProperty | (v: PropertyKey) => boolean | Determines whether an object has a property with the specified name. | | isPrototypeOf | (v: Object) => boolean | Determines whether an object exists in another object's prototype chain. | | propertyIsEnumerable | (v: PropertyKey) => boolean | Determines whether a specified property is enumerable. |

Function

Creates a new function.

| Prop | Type | | --------------- | --------------------------------------------- | | prototype | any | | length | number | | arguments | any | | caller | Function |

| Method | Signature | Description | | ------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | apply | (this: Function, thisArg: any, argArray?: any) => any | Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function. | | call | (this: Function, thisArg: any, ...argArray: any[]) => any | Calls a method of an object, substituting another object for the current object. | | bind | (this: Function, thisArg: any, ...argArray: any[]) => any | For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters. | | toString | () => string | Returns a string representation of a function. |

PluginListenerHandle

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

Type Aliases

PropertyKey

string | number | symbol