指南
如何使用Capacitor中的联系人
使用@capgo/capacitor-contacts
Capacitor联系人插件接口,用于管理设备联系人
安装
bun add @capgo/capacitor-contacts
bunx cap sync
bunx cap sync 将插件的本机code复制到您的本机项目中。每次升级插件后都重新运行它。
导入
import { CapacitorContacts } from '@capgo/capacitor-contacts';
API概览
| 方法 | 描述 |
|---|---|
countContacts |
统计设备上的联系人总数 |
createContact |
程序创建新联系人 |
createGroup |
创建新联系人组 |
deleteContactById |
删除一个联系人。 |
deleteGroupById |
删除一个群组。 |
displayContactById |
使用原生联系人查看器显示一个联系人。 |
displayCreateContact |
显示原生创建联系人界面。 |
displayUpdateContactById |
显示原生更新联系人界面。 |
getAccounts |
获取设备上的所有账户。 |
getContactById |
获取一个特定的联系人。 |
getContacts |
获取设备上的所有联系人。 |
getGroupById |
获取一个特定的群组。 |
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个核心方法。监听器和版本帮助,以及每个方法的完整契约,均在__CAPGO_KEEP_0__仓库中文档化。 GitHub全局参考.
全局参考
继续使用@capgo/capacitor-contacts
如果您正在使用@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-contacts 以计划仪表板和capgo操作为目的,连接它与@capgo/capacitor-contacts 使用@API/__CAPGO_KEEP_1__-contacts 如果您正在使用@capgo/capacitor-contacts Capacitor 通讯录插件的实现细节在 @capgo/capacitor-contacts 中。 开始使用 Capacitor 通讯录插件的实现细节在 开始使用 中。 API 介绍 Capacitor 通讯录插件的实现细节在 API 介绍 中, Introduction 在本页面 API 键 为API中的实现细节。