联系方式 Capacitor 插件

使用 @capgo/capacitor-contacts

用于管理设备联系人的 Capacitor Contacts 插件接口。

安装

bun add @capgo/capacitor-contacts
bunx cap sync

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

导入

import { CapacitorContacts } from '@capgo/capacitor-contacts';

API 概览

方法	描述
countContacts	统计设备上的联系人总数。
createContact	以编程方式创建新联系人。
createGroup	创建一个新的联系人分组。
deleteContactById	根据 ID 删除联系人。
deleteGroupById	根据 ID 删除分组。
displayContactById	使用原生联系人查看器显示联系人。
displayCreateContact	调起原生的创建联系人界面。
displayUpdateContactById	为特定联系人显示原生更新联系人界面。
getAccounts	获取设备上所有可用的账户。
getContactById	按 ID 获取指定联系人。
getContacts	获取设备上的所有联系人。
getGroupById	按 ID 获取指定分组。
getGroups	获取所有联系人分组。
isAvailable	检查设备上联系人功能是否可用。
isSupported	检查当前平台是否支持该插件。
openSettings	打开设备的联系人设置。
pickContact	使用原生联系人选择器选择单个联系人。
pickContacts	使用原生联系人选择器选择一个或多个联系人。
updateContactById	按 ID 更新现有联系人。
checkPermissions	检查当前的联系人权限状态。
requestPermissions	请求访问联系人的权限。

示例

countContacts()

统计设备上的联系人总数。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.countContacts();
console.log(result);

createContact()

以编程方式创建新联系人。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);

createGroup()

创建一个新的联系人分组。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);

deleteContactById()

根据 ID 删除联系人。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteContactById({ id: 'id-123' });

deleteGroupById()

根据 ID 删除分组。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteGroupById({ id: 'id-123' });

displayContactById()

使用原生联系人查看器显示联系人。

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.displayContactById({ id: 'id-123' });

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

完整参考文档

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

从“使用 @capgo/capacitor-contacts”继续

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