开始使用

安装

bun add @capgo/capacitor-contacts
bunx cap sync

导入

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

API概述

countContacts

复制到剪贴板

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

await CapacitorContacts.countContacts();

createContact

复制到剪贴板

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

await CapacitorContacts.createContact({} as CreateContactOptions);

createGroup

创建新联系人组。

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

await CapacitorContacts.createGroup({} as CreateGroupOptions);

deleteContactById

通过 ID 删除联系人。

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

await CapacitorContacts.deleteContactById({} as DeleteContactByIdOptions);

deleteGroupById

通过 ID 删除联系人组。

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

await CapacitorContacts.deleteGroupById({} as DeleteGroupByIdOptions);

displayContactById

使用本地联系人查看器显示联系人。

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

await CapacitorContacts.displayContactById({} as DisplayContactByIdOptions);

displayCreateContact

显示本地创建联系人界面。

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

await CapacitorContacts.displayCreateContact();

displayUpdateContactById

显示特定联系人的本地更新联系人界面。

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

await CapacitorContacts.displayUpdateContactById({} as DisplayUpdateContactByIdOptions);

getAccounts

获取设备上可用的所有账户。

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

await CapacitorContacts.getAccounts();

getContactById

获取特定联系人ID。

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

await CapacitorContacts.getContactById({} as GetContactByIdOptions);

getContacts

从设备获取所有联系人。

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

await CapacitorContacts.getContacts();

getGroupById

通过 ID 获取设备上的特定组。

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

await CapacitorContacts.getGroupById({} as GetGroupByIdOptions);

getGroups

从设备获取所有联系人组。

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

await CapacitorContacts.getGroups();

isAvailable

检查设备上的联系人是否可用。

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

await CapacitorContacts.isAvailable();

isSupported

检查插件是否在当前平台上支持。

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

await CapacitorContacts.isSupported();

openSettings

打开设备的联系人设置。

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

await CapacitorContacts.openSettings();

pickContact

使用本地联系人选择器选择一个联系人。

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

await CapacitorContacts.pickContact();

pickContacts

使用本地联系人选择器选择一个或多个联系人。

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

await CapacitorContacts.pickContacts();

updateContactById

更新已有联系人 ID.

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

await CapacitorContacts.updateContactById({} as UpdateContactByIdOptions);

checkPermissions

检查当前联系人权限状态.

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

await CapacitorContacts.checkPermissions();

requestPermissions

请求访问联系人权限.

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

await CapacitorContacts.requestPermissions();

类型参考

CountContactsResult

联系人计数结果

export interface CountContactsResult {
  /**
   * Total number of contacts.
   *
   * @since 1.0.0
   */
  count: number;
}

CreateContactOptions

创建联系人选项

export interface CreateContactOptions {
  /**
   * Contact information to create. The 'id' field will be generated automatically.
   *
   * @since 1.0.0
   */
  contact: Omit<Contact, 'id'>;
}

CreateContactResult

创建联系人结果

export interface CreateContactResult {
  /**
   * The ID of the newly created contact.
   *
   * @since 1.0.0
   */
  id: string;
}

CreateGroupOptions

创建群组选项

export interface CreateGroupOptions {
  /**
   * Group information to create. The 'id' field will be generated automatically.
   *
   * @since 1.0.0
   */
  group: Omit<Group, 'id'>;
}

CreateGroupResult

创建组的结果。

export interface CreateGroupResult {
  /**
   * The ID of the newly created group.
   *
   * @since 1.0.0
   */
  id: string;
}

DeleteContactByIdOptions

删除联系人ID的选项。

export interface DeleteContactByIdOptions {
  /**
   * The ID of the contact to delete.
   *
   * @since 1.0.0
   */
  id: string;
}

DeleteGroupByIdOptions

删除组ID的选项。

export interface DeleteGroupByIdOptions {
  /**
   * The ID of the group to delete.
   *
   * @since 1.0.0
   */
  id: string;
}

DisplayContactByIdOptions

显示联系人ID的选项。

export interface DisplayContactByIdOptions {
  /**
   * The ID of the contact to display.
   *
   * @since 1.0.0
   */
  id: string;
}

DisplayCreateContactOptions

显示原生创建联系人UI的选项

export interface DisplayCreateContactOptions {
  /**
   * Optional pre-filled contact information for the create UI.
   *
   * @since 1.0.0
   */
  contact?: Omit<Contact, 'id'>;
}

DisplayCreateContactResult

显示原生创建联系人UI的结果

export interface DisplayCreateContactResult {
  /**
   * The ID of the created contact, if one was created. Undefined if the user cancelled.
   *
   * @since 1.0.0
   */
  id?: string;
}

DisplayUpdateContactByIdOptions

显示原生更新联系人UI的选项

export interface DisplayUpdateContactByIdOptions {
  /**
   * The ID of the contact to update.
   *
   * @since 1.0.0
   */
  id: string;
}

GetAccountsResult

显示原生获取账户的结果

export interface GetAccountsResult {
  /**
   * List of accounts available on the device.
   *
   * @since 1.0.0
   */
  accounts: Account[];
}

真实来源

本页是根据插件生成的 src/definitions.ts当上游的公共 API 变更时，请重新同步。