call-screen
Version:
Capacitor plugin for full-screen call UI with Accept/Reject buttons, OneSignal integration, and cross-platform support
161 lines • 4.07 kB
JSON
{
"api": {
"name": "CallScreenPlugin",
"slug": "callscreenplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "showCallScreen",
"signature": "(options: { username: string; callId?: string; roomName?: string; }) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "{ username: string; callId?: string | undefined; roomName?: string | undefined; }"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "showcallscreen"
},
{
"name": "handleIncomingCall",
"signature": "(options: { username: string; callId?: string; roomName?: string; }) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "{ username: string; callId?: string | undefined; roomName?: string | undefined; }"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "handleincomingcall"
},
{
"name": "stopCall",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "stopcall"
},
{
"name": "isCallActive",
"signature": "() => Promise<{ isActive: boolean; }>",
"parameters": [],
"returns": "Promise<{ isActive: boolean; }>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "iscallactive"
},
{
"name": "addListener",
"signature": "(eventName: 'callAction', listenerFunc: (event: CallActionEvent) => void) => Promise<PluginListenerHandle>",
"parameters": [
{
"name": "eventName",
"docs": "",
"type": "'callAction'"
},
{
"name": "listenerFunc",
"docs": "",
"type": "(event: CallActionEvent) => void"
}
],
"returns": "Promise<PluginListenerHandle>",
"tags": [],
"docs": "",
"complexTypes": [
"PluginListenerHandle",
"CallActionEvent"
],
"slug": "addlistenercallaction-"
},
{
"name": "removeAllListeners",
"signature": "(eventName: 'callAction') => Promise<void>",
"parameters": [
{
"name": "eventName",
"docs": "",
"type": "'callAction'"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "removealllisteners"
}
],
"properties": []
},
"interfaces": [
{
"name": "PluginListenerHandle",
"slug": "pluginlistenerhandle",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "remove",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "() => Promise<void>"
}
]
},
{
"name": "CallActionEvent",
"slug": "callactionevent",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "action",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'accepted' | 'rejected'"
},
{
"name": "username",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "callId",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "roomName",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}