@capgo/capacitor-contacts

概览

封装原生通讯录功能，提供权限辅助工具以及用于邀请和推荐的选取流程。

平台支持

平台	支持	备注
iOS	是	Contacts 框架
Android	是	ContactsContract
Web 端	否	没有 Contacts API 封装；浏览器联系人选择器属于独立的集成方式

核心功能

• countContacts - 统计设备上的联系人总数。
• createContact - 通过代码创建新联系人。
• createGroup - 创建新的联系人分组。
• deleteContactById - 根据 ID 删除联系人。

公开 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	请求访问联系人的权限。
getPluginVersion	获取原生 Capacitor 插件版本。

单一事实来源

此参考文档同步自 src/definitions.ts 中的 capacitor-contacts.

继续探索 @capgo/capacitor-contacts

如果你正在使用 @capgo/capacitor-contacts 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-contacts 在使用 @capgo/capacitor-contacts 时，获取原生能力的方法： API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。