시작하기

설치

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

__CAPGO_KEEP_2__

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

await CapacitorContacts.createGroup({} as CreateGroupOptions);

deleteContactById

__CAPGO_KEEP_3__

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

await CapacitorContacts.deleteContactById({} as DeleteContactByIdOptions);

deleteGroupById

__CAPGO_KEEP_4__

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

await CapacitorContacts.deleteGroupById({} as DeleteGroupByIdOptions);

displayContactById

__CAPGO_KEEP_5__

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

await CapacitorContacts.displayContactById({} as DisplayContactByIdOptions);

displayCreateContact

특정 연락처를 생성하는 데 사용되는 기기 내의 원시 UI를 표시합니다.

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

await CapacitorContacts.displayCreateContact();

displayUpdateContactById

특정 연락처를 업데이트하는 데 사용되는 기기 내의 원시 UI를 표시합니다.

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

__CAPGO_KEEP_2__ (__CAPGO_KEEP_2__)

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

await CapacitorContacts.getContacts();

getGroupById

__CAPGO_KEEP_2__ (ID를 통해 특정 그룹을 가져옵니다.)

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

await CapacitorContacts.getGroupById({} as GetGroupByIdOptions);

getGroups

__CAPGO_KEEP_2__ (모든 연락처 그룹을 가져옵니다.)

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

await CapacitorContacts.getGroups();

isAvailable

__CAPGO_KEEP_2__ (연락처가 장치에 사용 가능한지 확인합니다.)

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

isSupported 섹션

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. upstream에서 변경된 경우 public API이 다시 동기화될 때까지 동기화 다시 실행하세요.