본문으로 건너뛰기

연락처 (Contacts)

기기에 저장된 연락처 목록을 조회하는 모듈입니다.

개요​

appify.contacts는 연락처 접근 권한을 확인하고 기기의 연락처 목록을 가져오는 기능을 제공합니다. checkPermission은 권한이 없을 경우 사용자에게 요청 다이얼로그를 표시하며, 권한이 허용된 이후에 getContacts를 호출하여 연락처 데이터를 가져올 수 있습니다.

API​

checkPermission(): Promise<boolean>​

연락처 접근 권한을 확인하고, 권한이 없으면 요청합니다.

매개변수

없음

반환값: Promise<boolean> - 권한 허용 여부 (true: 허용됨, false: 거부됨)

예제

import { appify } from '@nolraunsoft/appify-sdk';

const isAllowed = await appify.contacts.checkPermission();
if (!isAllowed) {
console.log('연락처 접근 권한이 거부되었습니다.');
}

getContacts(): Promise<Contact[]>​

기기에 저장된 연락처 목록을 가져옵니다.

매개변수

없음

반환값: Promise<Contact[]> - 연락처 객체 배열

Contact 타입:

필드타입설명
namestring연락처 이름
labelstring연락처 레이블
phonestring전화번호

예제

import { appify } from '@nolraunsoft/appify-sdk';

async function fetchContacts() {
const isAllowed = await appify.contacts.checkPermission();
if (!isAllowed) return;

const contacts = await appify.contacts.getContacts();
console.log(`${contacts.length}개의 연락처를 찾았습니다.`);
}

플랫폼별 참고사항​

  • iOS: NSContactsUsageDescription 키가 Info.plist에 등록되어 있어야 합니다.
  • Android: READ_CONTACTS 권한이 AndroidManifest.xml에 선언되어 있어야 합니다.
  • 권한이 거부된 경우 getContacts는 빈 배열을 반환하거나 예외를 발생시킬 수 있습니다.

관련 문서​