来电界面 (Incoming Call Kit) Capacitor 插件

使用 @capgo/capacitor-incoming-call-kit

Capacitor API，用于展示原生来电界面。

安装

bun add @capgo/capacitor-incoming-call-kit
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

API 概览

方法	描述
showIncomingCall	显示原生来电 UI。
endCall	结束特定的追踪通话。
endAllCalls	结束所有追踪通话。
getActiveCalls	返回当前正在追踪的通话。
checkPermissions	返回通知和全屏意图 (full-screen intents) 的当前权限状态。
requestPermissions	在平台支持时请求通知权限。
requestFullScreenIntentPermission	在可用时打开 Android 14+ 的全屏意图设置页面。

示例

showIncomingCall()

显示原生来电 UI。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.showIncomingCall({
  callId: 'call-id-123',
  callerName: 'caller',
});
console.log(result);

endCall()

结束特定的追踪通话。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.endCall({ callId: 'call-id-123' });
console.log(result);

endAllCalls()

结束所有追踪通话。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.endAllCalls();
console.log(result);

getActiveCalls()

返回当前正在追踪的通话。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.getActiveCalls();
console.log(result);

checkPermissions()

返回通知和全屏意图（full-screen intents）的当前权限状态。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.checkPermissions();
console.log(result);

requestPermissions()

在平台支持时请求通知权限。

import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';

const result = await IncomingCallKit.requestPermissions();
console.log(result);

上表列出了 7 个核心方法。监听器、版本辅助函数以及每个方法的完整契约，请参阅 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时，或者调用 IncomingCallKit.removeAllListeners() 以清除所有监听器。

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

继续阅读：使用 @capgo/capacitor-incoming-call-kit

如果你正在使用 使用 @capgo/capacitor-incoming-call-kit 要规划 dashboard 和 API 操作，请将其连接到 @capgo/capacitor-incoming-call-kit 有关 @capgo/capacitor-incoming-call-kit 的实现细节， 快速入门 有关“入门指南”中的实现细节， API 概览 关于 API Overview 中的实现细节， 简介 关于简介中的实现细节，以及 API 密钥 关于 API Keys 中的实现细节。