Getting Started

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

다음 명령어를 사용하여 다음 프롬프트를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-contacts` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래에 플랫폼에 따라 설명된 지침을 따르세요:

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

__CAPGO_KEEP_2__

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

await CapacitorContacts.deleteContactById({} as DeleteContactByIdOptions);

deleteGroupById

__CAPGO_KEEP_2__

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

__CAPGO_KEEP_7__

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

기기에 있는 모든 연락처를 가져옵니다.

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

__CAPGO_KEEP_2__ 현재 플랫폼에서 플러그인을 지원하는지 확인합니다.

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

await CapacitorContacts.isSupported();

openSettings

__CAPGO_KEEP_2__

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

await CapacitorContacts.openSettings();

pickContact

__CAPGO_KEEP_3__

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

await CapacitorContacts.pickContact();

pickContacts

__CAPGO_KEEP_4__

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

await CapacitorContacts.pickContacts();

updateContactById

__CAPGO_KEEP_5__

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

await CapacitorContacts.updateContactById({} as UpdateContactByIdOptions);

checkPermissions

__CAPGO_KEEP_2__

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

await CapacitorContacts.checkPermissions();

requestPermissions

__CAPGO_KEEP_3__

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

await CapacitorContacts.requestPermissions();

__CAPGO_KEEP_4__

CountContactsResult

__CAPGO_KEEP_6__

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

native 연락처 만들기 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

native 연락처 업데이트 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[];
}

Source Of Truth

이 페이지는 플러그인의 src/definitions.ts. upstream의 API이 변경될 때 다시 동기화 하세요.

Getting Started에서 계속

Capacitor를 사용하는 경우 Getting Started 대시보드 및 API 운영을 계획하려면 Capacitor를 사용하는 경우 @capgo/capacitor-contacts Capacitor를 사용하는 경우 @capgo/capacitor-contacts의 네이티브 기능 API 개요 API 개요의 구현 세부 정보 소개 소개의 구현 세부 정보 API 키 implementation 세부 사항에 대한 API 키 장치 implementation 세부 사항에 대한 장치.