내용으로 건너뛰기

Getting Started

GitHub

Capgo의 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 개요

API 개요

기기에서 연락처의 총 수를 계산합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.countContacts();

새로운 연락처를 프로그램적으로 생성합니다.

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

연락처 표시

ID로 연락처를 표시합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayContactById({} as DisplayContactByIdOptions);

displayCreateContact

제목: "displayCreateContact"

특정 연락처를 만들기 위해 기기에서 사용할 수 있는 native UI를 표시합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayCreateContact();

displayUpdateContactById

제목: "displayUpdateContactById"

특정 연락처를 업데이트하기 위해 기기에서 사용할 수 있는 native UI를 표시합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayUpdateContactById({} as DisplayUpdateContactByIdOptions);

기기에 사용할 수 있는 모든 계정을 가져옵니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.getAccounts();

특정 연락처를 ID로 가져옵니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.getContactById({} as GetContactByIdOptions);

장치에서 모든 연락처를 가져옵니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.getContacts();

특정 그룹 ID로 연락처를 가져옵니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.getGroupById({} as GetGroupByIdOptions);

장치의 모든 연락처 그룹을 가져옵니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.getGroups();

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

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.isAvailable();

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

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.isSupported();

장치의 연락처 설정을 열어줍니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.openSettings();

자연스러운 연락처 선택기를 사용하여 단일 연락처를 선택합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.pickContact();

자연스러운 연락처 선택기를 사용하여 하나 이상의 연락처를 선택합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.pickContacts();

ID로 존재하는 연락처를 업데이트합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.updateContactById({} as UpdateContactByIdOptions);

checkPermissions

권한 확인 섹션

연락처에 대한 현재 권한 상태를 확인합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.checkPermissions();

연락처에 접근하기 위해 권한을 요청합니다.

import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.requestPermissions();

CountContactsResult

CountContactsResult

연락처 수를 카운트한 결과입니다.

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

CreateContactOptions

CreateContactOptions

연락처를 생성하는 옵션입니다.

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

CreateContactResult

CreateContactResult

연락처를 생성한 결과입니다.

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

CreateGroupOptions

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로 삭제 옵션

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

DisplayCreateContactOptions

native 연락처 만들기 UI를 표시하는 옵션

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

DisplayCreateContactResult

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

DisplayUpdateContactByIdOptions

native 연락처 업데이트 UI를 표시하는 옵션

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

native 연락처 업데이트 UI를 표시한 결과

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

이 페이지는 플러그인의 src/definitions.ts공개 API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

이 플러그인을 사용하는 경우 Getting Started 계획 대시보드 및 API 운영을 위해 Getting Started을 사용하는 경우 Using @capgo/capacitor-contacts Using @capgo/capacitor-contacts를 사용하는 경우의 native capability API 개요 implementation 세부 정보를 위한 API 개요 소개 implementation 세부 정보를 위한 소개 API 키 implementation 세부 정보를 위한 API 키, 그리고 장치 implementation 세부 정보를 위한 장치