이 플러그인 장치 연락처 데이터베이스에 대 한 액세스를 제공 하는 글로벌 navigator.contacts 개체를 정의 합니다.
개체 navigator 글로벌 범위 첨부 아니에요 때까지 사용할 수 있는 deviceready 이벤트 후.
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(navigator.contacts);
}
경고: 중요 한 개인 정보 보호 문제를 제기 하는 연락처 데이터의 수집 및 사용 합니다. 응용 프로그램의 개인 정보 보호 정책 응용 프로그램 연락처 데이터를 사용 하는 방법 및 다른 당사자와 함께 공유 하는 여부를 토론 해야 한다. 연락처 정보 누구와 통신 하는 사람이 사람들 보여 때문에 민감한으로 간주 됩니다. 따라서, 애플 리 케이 션의 개인 정보 보호 정책 뿐만 아니라 강력 하 게 고려해 야 장치 운영 체제는 이렇게 이미 하지 않는 경우 응용 프로그램 액세스 또는 연락처 데이터를 사용 하기 전에 그냥--시간 통지를 제공 합니다. 그 통지는 (예를 들어, 확인 및 아니오 선택 제시) 하 여 사용자의 허가 취득 뿐만 아니라, 위에서 언급 된 동일한 정보를 제공 해야 합니다. Note 일부 애플 리 케이 션 장 터 그냥--시간 공지 및 연락처 데이터에 액세스 하기 전에 사용자의 허가 받아야 응용 프로그램에 필요할 수 있습니다. 연락처 데이터는 사용자의 혼동을 방지할 수의 사용 및 연락처 데이터의 인식된 오용 명확 하 고 이해 하기 쉬운 사용자 경험. 자세한 내용은 개인 정보 보호 가이드를 참조 하십시오.
cordova plugin add cordova-plugin-contacts
참고 문서에 설명 된 대로 www/manifest.webapp를 만듭니다. 관련 부여할 추가 합니다. 참고 문서에 “privileged”-webapp 유형을 변경 하려면 필요가 하다. 경고: 모든 훌륭한 애플 리 케이 션 인라인 스크립트를 금지 하는 콘텐츠 보안 정책을 적용 합니다. 다른 방법으로 응용 프로그램을 초기화 합니다.
"type": "privileged",
"permissions": {
"contacts": {
"access": "readwrite",
"description": "Describe why there is a need for such permission"
}
}
find 및 pickContact 메서드에서 반환 하는 모든 연락처는 읽기 전용 응용 프로그램을 수정할 수 없습니다. 찾을 방법은 Windows Phone 8.1 장치에만 사용할 수 있습니다.
윈도우 8 연락처는 읽기 전용입니다. 코르 도우 바 API 연락처를 통해 하지 쿼리/검색할 수 있습니다, 사용자 알려 ‘사람’ 애플 리 케이 션을 열 것 이다 contacts.pickContact에 대 한 호출으로 연락처를 선택 하 여 사용자 연락처를 선택 해야 합니다. 반환 된 연락처는 읽기 전용 응용 프로그램을 수정할 수 없습니다.
navigator.contacts.create 메서드는 동기적 및 새 연락처 개체를 반환 합니다.
이 메서드는 Contact.save 메서드를 호출 해야 장치 연락처 데이터베이스에 연락처 개체를 유지 하지 않습니다.
var myContact = navigator.contacts.create({"displayName": "Test User"});
장치 연락처 데이터베이스 쿼리 및 Contact 개체의 배열을 반환 navigator.contacts.find 메서드를 비동기적으로 실행 합니다. 결과 개체는 contactSuccess 매개 변수에서 지정한 contactSuccess 콜백 함수에 전달 됩니다.
contactFields 매개 변수는 검색 한정자로 사용할 필드를 지정 합니다. 길이가 0 인 contactFields 매개 변수가 유효 하 고 ContactError.INVALID_ARGUMENT_ERROR에서 결과. contactFields 값 "*" 모든 연락처 필드를 검색 합니다.
contactFindOptions.filter 문자열 연락처 데이터베이스를 쿼리할 때 검색 필터로 사용할 수 있습니다. 제공 된, 대/소문자, 부분 값 일치 contactFields 매개 변수에 지정 된 각 필드에 적용 됩니다. 모든 지정 된 필드의 일치 하는 경우 연락처 반환 됩니다. 사용 하 여 contactFindOptions.desiredFields 매개 변수 속성 문의 제어를 다시 반환 해야 합니다.
contactFields: 검색 한정자로 사용 하는 필드에 문의. (DOMString[]) [Required]
contactSuccess: 연락처 개체의 배열에 표시 되는 성공 콜백 함수는 데이터베이스에서 반환 된. [Required]
contactError: 오류 콜백 함수에 오류가 발생할 때 호출 됩니다. [선택 사항]
contactFindOptions: navigator.contacts 필터링 옵션을 검색 합니다. [Optional]
키 다음과 같습니다.
filter: 검색 문자열 navigator.contacts를 찾는 데 사용 합니다. (DOMString) (기본: "")
multiple: 여러 navigator.contacts 찾기 작업을 반환 합니다 경우 결정 합니다. (부울) (기본값: false)
Contact 기능 값만이 필드 개체입니다. (DOMString[]) [Optional]function onSuccess(contacts) {
alert('Found ' + contacts.length + ' contacts.');
};
function onError(contactError) {
alert('onError!');
};
// find all contacts with 'Bob' in any name field
var options = new ContactFindOptions();
options.filter = "Bob";
options.multiple = true;
options.desiredFields = [navigator.contacts.fieldType.id];
var fields = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name];
navigator.contacts.find(fields, onSuccess, onError, options);
__contactFields__지원 되지 않으며 무시 됩니다. find메서드가 항상 이름, 이메일 주소 또는 연락처의 전화 번호를 일치 하도록 시도 합니다.navigator.contacts.pickContact 메서드를 사용 하면 단일 연락처 선택 문의 선택 시작 합니다. 결과 개체는 contactSuccess 매개 변수에서 지정한 contactSuccess 콜백 함수에 전달 됩니다.
contactSuccess: 단일 연락처 개체와 호출 되는 성공 콜백 함수. [필수]
contactError: 오류 콜백 함수에 오류가 발생할 때 호출 됩니다. [선택 사항]
navigator.contacts.pickContact(function(contact){
console.log('The following contact has been selected:' + JSON.stringify(contact));
},function(err){
console.log('Error: ' + err);
});
Contact 개체는 사용자의 연락처를 나타냅니다. 연락처 생성 수, 저장 또는 장치 연락처 데이터베이스에서 제거 합니다. 연락처도 검색할 수 있습니다 (개별적으로 또는 일괄적으로) 데이터베이스에서 navigator.contacts.find 메서드를 호출 하 여.
참고: 모든 연락처 필드 위에 나열 된 모든 장치 플랫폼에서 지원 됩니다. 자세한 내용은 각 플랫폼의 단점이 섹션을 확인 하시기 바랍니다.
id: 글로벌 고유 식별자. (DOMString)
displayName: 최종 사용자에 게 표시에 적합이 연락처의 이름. (DOMString)
이름: 사람 이름의 모든 구성 요소를 포함 하는 개체. (담당자 이름)
별명: 캐주얼 이름 연락처 주소입니다. (DOMString)
phoneNumbers: 모든 연락처의 전화 번호의 배열. (ContactField[])
이메일: 모든 연락처의 전자 메일 주소의 배열. (ContactField[])
주소: 모든 연락처의 주소 배열. (ContactAddress[])
ims: 모든 연락처의 IM 주소 배열. (ContactField[])
조직: 다양 한 모든 연락처의 조직. (ContactOrganization[])
생일: 연락처의 생일. (날짜)
참고: 연락처에 대 한 참고. (DOMString)
사진: 연락처의 사진을 배열. (ContactField[])
카테고리: 모든 사용자 정의 범주 연락처에 연결 된 배열. (ContactField[])
url: 연락처에 연결 된 웹 페이지의 배열. (ContactField[])
복제: 새로운 반환 합니다 Contact 으로 호출 하는 개체의 전체 복사본은 개체는 id 속성으로 설정null.
제거: 장치 연락처 데이터베이스에서 연락처를 제거 합니다, 그렇지 않으면와 오류 콜백을 실행 한 ContactError 개체.
저장: 장치 연락처 데이터베이스를 새 연락처를 저장 또는 동일한 id 를 가진 연락처가 이미 있는 경우 기존 연락처를 업데이트 합니다.
function onSuccess(contact) {
alert("Save Success");
};
function onError(contactError) {
alert("Error = " + contactError.code);
};
// create a new contact object
var contact = navigator.contacts.create();
contact.displayName = "Plumber";
contact.nickname = "Plumber"; // specify both to support all devices
// populate some fields
var name = new ContactName();
name.givenName = "Jane";
name.familyName = "Doe";
contact.name = name;
// save to device
contact.save(onSuccess,onError);
// clone the contact object
var clone = contact.clone();
clone.name.givenName = "John";
console.log("Original contact name = " + contact.name.givenName);
console.log("Cloned contact name = " + clone.name.givenName);
function onSuccess() {
alert("Removal Success");
};
function onError(contactError) {
alert("Error = " + contactError.code);
};
// remove the contact from the device
contact.remove(onSuccess,onError);
null.카테고리: 부분적으로 지원 합니다. 필드 pref 및 형식 반환null
ims: 지원 되지 않음
사진: 지원 되지 않음
displayName: 반환 iOS에서 지원 되지 않는 null 가 아무 ContactName 지정 된,이 경우 복합 이름, 닉네임 을 반환 합니다 또는 "" , 각각.
생일: 자바 스크립트로 입력 해야 합니다 Date 개체를 같은 방식으로 반환 됩니다.
사진: 응용 프로그램의 임시 디렉터리에 저장 된 이미지 파일 URL을 반환 합니다. 응용 프로그램이 종료 될 때 임시 디렉터리의 내용은 제거 됩니다.
카테고리:이 속성은 현재 지원 되지 않습니다, 반환null.
displayName: 연락처를 만들 때 표시 이름에서 표시 이름 매개 변수 다릅니다 제공 값 검색 연락처를 찾을 때.
url: 연락처를 만들 때 사용자가 입력을 하나 이상의 웹 주소를 저장 하지만 하나만 사용할 수 있는 연락처를 검색할 때.
phoneNumbers: pref 옵션이 지원 되지 않습니다. 형식 찾기 작업에서 지원 되지 않습니다. 단 하나 phoneNumber 각 형식 에 대 한 허용.
이메일: pref 옵션이 지원 되지 않습니다. 가정 및 개인 동일한 이메일 항목 참조. 각 형식 에 대 한 항목이 하나만 허용.
주소: 직장, 및 가정/개인 유형을 지원 합니다. 가정 및 개인 유형 동일한 주소 항목 참조. 각 형식 에 대 한 항목이 하나만 허용.
조직: 하나만 허용 되 고 pref, 유형및 부서 특성을 지원 하지 않습니다.
참고: 지원 되지 않는 반환null.
ims: 지원 되지 않는 반환null.
생일: 지원 되지 않는 반환null.
카테고리: 지원 되지 않는 반환null.
사진: 응용 프로그램의 임시 디렉터리에 저장 된 이미지 파일 URL을 반환 합니다.
생일: 지원 되지 않는 반환null.
카테고리: 지원 되지 않는 반환null.
ContactAddress 개체는 연락처의 단일 주소 속성을 저장합니다. 연락처 개체는 ContactAddress 배열에 있는 하나 이상의 주소를 포함할 수 있습니다.
pref: 설정 true 이 경우 ContactAddress 사용자의 기본 설정된 값이 포함 됩니다. (부울)
유형: 예를 들어 필드, 홈 의 어떤 종류를 나타내는 문자열. (DOMString)
포맷: 전체 주소 표시를 위해 서식이 지정 된. (DOMString)
streetAddress: 전체 주소. (DOMString)
지역: 구, 군 또는 도시. (DOMString)
지역: 상태 또는 지역. (DOMString)
postalCode: 우편 번호 또는 우편 번호. (DOMString)
국가: 국가 이름. (DOMString)
// display the address information for all contacts
function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
for (var j = 0; j < contacts[i].addresses.length; j++) {
alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
"Type: " + contacts[i].addresses[j].type + "\n" +
"Formatted: " + contacts[i].addresses[j].formatted + "\n" +
"Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
"Locality: " + contacts[i].addresses[j].locality + "\n" +
"Region: " + contacts[i].addresses[j].region + "\n" +
"Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
"Country: " + contacts[i].addresses[j].country);
}
}
};
function onError(contactError) {
alert('onError!');
};
// find all contacts
var options = new ContactFindOptions();
options.filter = "";
var filter = ["displayName", "addresses"];
navigator.contacts.find(filter, onSuccess, onError, options);
false 안 드 로이드 2.X 장치에.pref: 반환 BlackBerry 장치에서 지원 되지 않습니다false.
유형: 부분적으로 지원 합니다. 작업 및 홈 형식 주소 각 단 하나 접촉 당 저장할 수 있습니다.
포맷: 부분적으로 지원 합니다. 모든 검은 딸기 주소 필드의 연결을 반환합니다.
streetAddress: 지원. 블랙베리 address1 주소 2 의 연결 주소 필드를 반환합니다.
지역: 지원. 블랙베리 시 주소 필드에 저장 합니다.
지역: 지원. 블랙베리 stateProvince 주소 필드에 저장 합니다.
postalCode: 지원. 블랙베리 zipPostal 주소 필드에 저장 합니다.
국가: 지원.
pref: 반환 하는 iOS 장치에서 지원 되지 않습니다false.
포맷: 현재 지원 되지 않습니다.
ContactError 개체는 오류가 발생 하면 contactError 콜백 함수를 통해 사용자에 게 반환 됩니다.
ContactError.UNKNOWN_ERROR (code 0)ContactError.INVALID_ARGUMENT_ERROR (code 1)ContactError.TIMEOUT_ERROR (code 2)ContactError.PENDING_OPERATION_ERROR (code 3)ContactError.IO_ERROR (code 4)ContactError.NOT_SUPPORTED_ERROR (code 5)ContactError.PERMISSION_DENIED_ERROR (code 20)ContactField 개체는 재사용 가능한 구성 요소를 나타내는 필드를 일반적으로 문의입니다. 각 ContactField 개체에는 value, type 및 pref 속성을 포함 되어 있습니다. Contact 개체는 전화 번호 및 이메일 주소와 같은 ContactField 배열에서 몇 가지 속성을 저장합니다.
대부분의 경우에서는 ContactField 개체의 type 속성에 대 한 미리 정해진된 값이 없습니다. 예를 들어 전화 번호 홈, 작품, 모바일, 아이폰 또는 특정 장치 플랫폼의 연락처 데이터베이스에서 지원 되는 다른 값의 유형 값을 지정할 수 있습니다. 그러나, 연락처 사진 필드 유형 필드 나타냅니다 반환 된 이미지 형식: url 값 특성 값 이미지 base64 인코딩된 문자열을 포함 하는 경우 사진 이미지 또는 base64 URL이 포함 된 경우.
유형: 예를 들어 필드, 홈 의 어떤 종류를 나타내는 문자열입니다. (DOMString)
값: 전화 번호 또는 이메일 주소와 같은 필드 값. (DOMString)
pref: 설정 true 이 경우 ContactField 사용자의 기본 설정된 값이 포함 됩니다. (부울)
// create a new contact
var contact = navigator.contacts.create();
// store contact phone numbers in ContactField[]
var phoneNumbers = [];
phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
contact.phoneNumbers = phoneNumbers;
// save the contact
contact.save();
false.유형: 부분적으로 지원 합니다. 전화 번호에 대 한 사용.
값: 지원.
pref: 지원 되지 않는 반환false.
false.false.false.여러 종류의 Contact 개체의 이름에 대 한 정보를 포함합니다.
포맷: 연락처의 전체 이름. (DOMString)
familyName: 연락처의 성. (DOMString)
givenName: 연락처의 이름. (DOMString)
middleName: 연락처의 중간 이름을. (DOMString)
honorificPrefix: 연락처의 접두사 (예: 미스터 또는 닥터) (DOMString)
honorificSuffix: 연락처의 접미사 ( *esq.*예). (DOMString)
function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
alert("Formatted: " + contacts[i].name.formatted + "\n" +
"Family Name: " + contacts[i].name.familyName + "\n" +
"Given Name: " + contacts[i].name.givenName + "\n" +
"Middle Name: " + contacts[i].name.middleName + "\n" +
"Suffix: " + contacts[i].name.honorificSuffix + "\n" +
"Prefix: " + contacts[i].name.honorificSuffix);
}
};
function onError(contactError) {
alert('onError!');
};
var options = new ContactFindOptions();
options.filter = "";
filter = ["displayName", "name"];
navigator.contacts.find(filter, onSuccess, onError, options);
honorificPrefix , givenName , middleName , familyName , 그리고honorificSuffix.포맷: 부분적으로 지원 합니다. 블랙베리 firstName 및 lastName 필드의 연결을 반환합니다.
familyName: 지원. 블랙베리 lastName 필드에 저장 합니다.
givenName: 지원. 블랙베리 firstName 필드에 저장 합니다.
middleName: 지원 되지 않는 반환null.
honorificPrefix: 지원 되지 않는 반환null.
honorificSuffix: 지원 되지 않는 반환null.
honorificPrefix , givenName , middleName , familyName , 그리고honorificSuffix.형식: 이것은 유일한 속성 이름과 동일 하다 displayName , 및nickname
familyName: 지원 되지 않음
givenName: 지원 되지 않음
middleName: 지원 되지 않음
honorificPrefix: 지원 되지 않음
honorificSuffix: 지원 되지 않음
displayNameContactOrganization 개체는 연락처의 조직 속성을 저장합니다. Contact 개체 배열에 하나 이상의 ContactOrganization 개체를 저장합니다.
pref: 설정 true 이 경우 ContactOrganization 사용자의 기본 설정된 값이 포함 됩니다. (부울)
유형: 예를 들어 필드, 홈 의 어떤 종류를 나타내는 문자열입니다. _(DOMString)
이름: 조직 이름. (DOMString)
부서: 계약을 위해 일 하는 부서. (DOMString)
제목: 조직에서 연락처의 제목. (DOMString)
function onSuccess(contacts) {
for (var i = 0; i < contacts.length; i++) {
for (var j = 0; j < contacts[i].organizations.length; j++) {
alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
"Type: " + contacts[i].organizations[j].type + "\n" +
"Name: " + contacts[i].organizations[j].name + "\n" +
"Department: " + contacts[i].organizations[j].department + "\n" +
"Title: " + contacts[i].organizations[j].title);
}
}
};
function onError(contactError) {
alert('onError!');
};
var options = new ContactFindOptions();
options.filter = "";
filter = ["displayName", "organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);
false.pref: 반환 블랙베리 장치에 의해 지원 되지 않습니다false.
유형: 반환 블랙베리 장치에 의해 지원 되지 않습니다null.
이름: 부분적으로 지원 합니다. 첫 번째 조직 이름 블랙베리 회사 필드에 저장 됩니다.
부서: 지원 되지 않는 반환null.
제목: 부분적으로 지원 합니다. 첫 번째 조직 제목 블랙베리 jobTitle 필드에 저장 됩니다.
pref: 지원 되지 않음
형식: 지원 되지 않음
부서: 지원 되지 않음
필드 이름 및 제목 org 및 jobTitle 에 저장.
pref: 반환 하는 iOS 장치에서 지원 되지 않습니다false.
유형: 반환 하는 iOS 장치에서 지원 되지 않습니다null.
이름: 부분적으로 지원 합니다. 첫 번째 조직 이름은 iOS kABPersonOrganizationProperty 필드에 저장 됩니다.
부서: 부분적으로 지원 합니다. 첫 번째 부서 이름은 iOS kABPersonDepartmentProperty 필드에 저장 됩니다.
제목: 부분적으로 지원 합니다. 첫 번째 타이틀 iOS kABPersonJobTitleProperty 필드에 저장 됩니다.
pref: 지원 되지 않는 반환false.
형식: 지원 되지 않는 반환null.