跳过主要内容

联系人 Capacitor插件

读取和写入设备联系人

安装

bun add @capgo/capacitor-contacts bunx cap sync
npm、pnpm或yarn
  • npm install @capgo/capacitor-contacts
  • pnpm add @capgo/capacitor-contacts
  • yarn add @capgo/capacitor-contacts

指南

如何使用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中的实现细节。

FAQ

常见问题

如何在Capacitor应用中安装联系人插件?

Run "bun add @capgo/capacitor-contacts" (or "npm install @capgo/capacitor-contacts"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-contacts" in your app code.

是否@capgo/capacitor-contacts与React、Vue和Angular兼容?

Yes. Contacts is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

哪个 Capacitor 版本支持 @capgo/capacitor-contacts?

Capgo 插件遵循 Capacitor 的主要版本:使用与您的 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格中列出了维护的版本。

@capgo/capacitor-contacts 是否免费和开源?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-contacts/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在不经过 App Store 审核的情况下更新使用 Contacts 的 code?

安装或升级插件会改变本机 code,所以需要一个新的商店构建。之后,JavaScript、HTML 和 CSS 的更改可以立即通过 Capgo 实时更新发布。

一旦插件在您的商店构建中,__CAPGO_KEEP_0__实时更新将将您的JavaScript、HTML和CSS更改推送给用户,仅需几分钟

从Capgo开始

使用Capgo