Getting Started

설치

플러그인을 설치하기 위해 우리의 AI-assisted 설정을 사용할 수 있습니다. 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

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

API 개요

countContacts

__CAPGO_KEEP_1__을 사용하여 기기에서 연락처의 총 수를 계산합니다.

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

await CapacitorContacts.countContacts();

createContact

__CAPGO_KEEP_2__을 사용하여 프로그램적으로 새로운 연락처를 생성합니다.

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

native 연락처 뷰어를 사용하여 연락처를 표시하세요.

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

await CapacitorContacts.displayContactById({} as DisplayContactByIdOptions);

displayCreateContact

__CAPGO_KEEP_0__을 원래 UI로 표시합니다.

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

await CapacitorContacts.displayCreateContact();

displayUpdateContactById

__CAPGO_KEEP_0__을 특정 연락처에 대해 원래 UI로 표시합니다.

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

await CapacitorContacts.displayUpdateContactById({} as DisplayUpdateContactByIdOptions);

getAccounts

__CAPGO_KEEP_0__을 기기에 있는 모든 계정 목록을 가져옵니다.

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

await CapacitorContacts.getAccounts();

getContactById

__CAPGO_KEEP_0__ ID를 사용하여 특정 연락처를 가져옵니다.

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

await CapacitorContacts.getContactById({} as GetContactByIdOptions);

getContacts

__CAPGO_KEEP_0__

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

await CapacitorContacts.getContacts();

getGroupById

__CAPGO_KEEP_3__

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

await CapacitorContacts.getGroupById({} as GetGroupByIdOptions);

getGroups

__CAPGO_KEEP_5__

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

await CapacitorContacts.getGroups();

isAvailable

__CAPGO_KEEP_7__

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

__CAPGO_KEEP_0__

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

await CapacitorContacts.updateContactById({} as UpdateContactByIdOptions);

checkPermissions

__CAPGO_KEEP_3__

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

await CapacitorContacts.checkPermissions();

requestPermissions

__CAPGO_KEEP_4__

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

await CapacitorContacts.requestPermissions();

__CAPGO_KEEP_5__

CountContactsResult

__CAPGO_KEEP_7__

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

CreateContactOptions

__CAPGO_KEEP_2__

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

CreateContactResult

__CAPGO_KEEP_3__

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

CreateGroupOptions

__CAPGO_KEEP_2__

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

CreateGroupResult

__CAPGO_KEEP_5__

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

DeleteContactByIdOptions

__CAPGO_KEEP_2__

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

DeleteGroupByIdOptions

__CAPGO_KEEP_3__

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

DisplayContactByIdOptions

__CAPGO_KEEP_4__

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

DisplayCreateContactOptions

__CAPGO_KEEP_5__

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

DisplayCreateContactResult

__CAPGO_KEEP_2__ (DisplayCreateContactResult)

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

__CAPGO_KEEP_2__ (DisplayUpdateContactByIdOptions)

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

GetAccountsResult

__CAPGO_KEEP_2__ (GetAccountsResult)

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

__CAPGO_KEEP_1__ (Source Of Truth)

이 페이지는 플러그인의 src/definitions.ts. upstream에서 API이 변경되었을 때 다시 싱크를 실행하세요.

Getting Started에서 계속하세요

Capacitor를 사용하는 경우 Getting Started Capacitor를 사용하여 대시보드와 API를 계획하고 운영하기 위해, API를 연결하세요. @capgo/capacitor-contacts를 사용하여 Native Capability @capgo/capacitor-contacts를 사용하여 Native Capability를 구현하는 데 사용하는 capgo Overview API Overview API Overview를 사용하여 구현하는 데 사용하는 API Overview 소개 소개에서 구현 세부 정보에 대해 API 키 소개에서 API 키의 구현 세부 정보, 및 장치 장치에서 구현 세부 정보에 대해