Contacts（联系人）

在 交往 对象提供对设备的访问联系人数据库。

方法

? ?

contacts.create contacts.find

参数

? ? ? ?

contactFields contactSuccess contactError contactFindOptions

对象

? ? ? ? ? ? ?

Contact ContactName ContactField ContactAddress ContactOrganization ContactFindOptions ContactError

contacts.create

返回一个新的 联系 对象。

var contact = navigator.service.contacts.create(properties);

说明

contacts.create 是一个同步函数，返回一个新的 联系 对象。

这种方法不存在的 联系 对象到设备联系人数据库。 要坚持的 联系 对象到设备，调用 联系 。保

存 方法。

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

var myContact = navigator.service.contacts.create({\: \});

完整的例子

\

Example

Create Contact

contacts.find

查询设备联系人数据库，并返回一个或多个 联系 对象，每个包含字段中指定。

navigator.service.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions); 说明

contacts.find 是一个异步函数，查询设备联系人数据库，并返回一个数组的 联系 对象。 由此产生的对象被传递给 contactSuccess 回调函数指定 contactSuccess 参数。 用户必须指定联系人字段是作为限定在搜索 contactFields 参数。 只有在字段中指

定 contactFields 参数将返回的属性作为 联系的对象传递给 contactSuccess 回调函数。 一个零长度 contactFields 参数将导致数组 联系 的对象，只有 身份证 填充属性。

该 contactFindOptions 。过滤 字符串可以被用来作为搜索过滤器时，查询联系人数据库。 如果提供，不区分大小写，部分值匹配应用到指定的每个字段 contactFields 参数。 如果匹配是一个比较发现 任何 指定的领域，接触被返回。

参数

? ? ? ?

contactFields ： 联系人 字段用作搜索预选赛。 只有这些领域将有结果值的 联系 对象。 （DOMString []） [必需的]

contactSuccess ： 成功回调函数，从数据库调用的接触与交往返回。 [必需的] contactError ： 错误回调函数。 发生错误时调用。 [可选] contactFindOptions ： 搜索选项来过滤接触。 [可选]

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

function onSuccess(contacts) {

alert('Found ' + contacts.length + ' contacts.'); };

function onError() { alert('onError!'); };

// find all contacts with 'Bob' in any name field var options = new ContactFindOptions(); options.filter=\;

var fields = [\, \];

navigator.service.contacts.find(fields, onSuccess, onError, options);

完整的例子

\

Example

Find Contacts

iOS怪癖

?

iOS中返回数组属性没有结果无效，其他平台返回一个空数组。

Contact

包含的属性描述一接触，如用户的个人或商业联系。

属性

? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?

id： 一个全局唯一标识符。 （DOMString）

displayname： 该 名称 本 联系 合适的显示给最终用户。， （DOMString） name ： 一个对象，它包含一个人所有组件的 名称 。 （ ContactName ） Nickname： 一个偶然 的名称 ，以解决联系的。 （DOMString）

Phonenumbers： 一个数字的数组的所有联系人的电话。 （ ContactField []） Emails： 一个地址的数组的所有联系人的电子邮件。 （ ContactField []） Addresses： 地址数组的所有联系人。 （ContactAddresses []） Ims： 一个地址的数组的所有联系人的聊天室。 （ ContactField []）

Organizations： 一个组织的数组的所有联系人。 （ ContactOrganization []） Revision： 最后日期接触进行了修订。 （DOMString） Birthday： 接触寿辰。 （日期） Gender： 性别的接触。 （DOMString） Note： 一个联系注意到有关。 （DOMString）

Photos： 照片阵列中的一个联系人。 （ ContactField []）

Categories： 一个用户的所有联系人的数组定义的类别。 （ ContactField []） Urls： 数组。接触到相关网页 （ ContactField []） Timezone： 时区的conact的。 （DOMString）

方法

?

Cone ：返回一个新的 联系 对象，它是调用对象的深层副本到，ID属性设定为 空 。remove：删除数据库与从设备联系人。 错误回调被称为一个 ContactError 对象如果去除是不成功的。 ?

Seve：保存一个新的联系人到设备上的联系人数据库，或更新现有的联系，如果同一个接触 的ID 已经存在。

详情

在 联系 对象表示用户的联系。 联系人 可以创建，保存，或数据库中删除从设备接触。 联系 ，也可以检索到散装）从数据库（个别或通过调用 contacts.find 方法。

注意：并非所有上述领域的接触是每一个支持的 设备平台 。 请检查每个平台的怪癖信息部分有关的字段都支持。

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

保存快速范例

function onSuccess(contacts) { alert(\); };

function onError(contactError) {

alert(\ + contactError.code); };

// create a new contact object

var contact = navigator.service.contacts.create(); contact.displayName = \;

contact.nickname = \; //specify both to support all devices

// populate some fields var name = new ContactName(); name.givenName = \; name.familyName = \; contact.name = name;

// save to device

contact.save(onSuccess,onError);

克隆快速范例

/ /克隆对象的接触

// clone the contact object var clone = contact.clone(); clone.name.givenName = \;

console.log(\ + contact.name.givenName); console.log(\ + clone.name.givenName);

删除快速范例

function onSuccess() {

alert(\); };

function onError(contactError) {

alert(\ + contactError.code); };

// remove the contact from the device contact.remove(onSuccess,onError);

完整的例子

\

Example

Find Contacts

Android的2.X的怪癖

? ? ? ?

revision： 不支持此属性是由Android 2.x的设备，而且将永远是为返回 空 。 gender： 不支持此属性是由Android 2.x的设备，而且将永远是为返回 空 。 categories： 不支持此属性是由Android 2.x的设备，而且将永远是为返回 空 。 timezone： 不支持此属性是由Android 2.x的设备，而且将永远是为返回 空 。

Android的1.X的怪癖

? ? ? ? ? ? ? ? ?

name： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Nickname： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Revision： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Birthday： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Gender： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Photos： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Categories： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Urls： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。 Timezone： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

? ? ? ?

Id： 支持。 设备分配时接触被保存。

Displayname： 支持。 存储在黑莓 user1的 领域。 Nickname： 此属性是不支持，而且将永远是为返回 空 。 Phonenumbers： 部分支持。 电话号码字段中存储将在BlackBerry homePhone1 和 homePhone2 如果 类型 是'家'，

workPhone1 和 workPhone2 如果 类型 是'工作'， 手机 如果 类型 是'移动

'， faxPhone 如果 类型 是'真'， pagerPhone如果 类型 是'寻呼机'和 otherPhone 如果 类型 是上面没有的。 ? ? ? ? ? ? ?

Emails： 部分支持。 前三个电子邮件地址将被存储在BlackBerry email1 ， email2 和 email3 领域，分别为。

Addresses： 部分支持。 第一和第二地址将存储在黑莓 是homeAddress 和 招聘人数 等领域，分别为。

IMS： 这个属性是不支持，而且将永远是为返回 空 。

Organizations： 部分支持。 的 名称 和 标题 的第一个组织都存储在黑莓 公司 和 标题 字段，分别为。

Revision： 此属性是不支持，而且将永远是为返回 空 。 Gender： 不支持此属性，而且将永远是为返回 空 。

Photos： -部分支持。 单一缩略图大小的照片的支持。 要设置一个联系人的照片，无论是传递一个Base64编码的图像，或者一个URL指向图像。 图像将被保存之前缩小到BlackBerry联系人数据库。 接触照片的形式返回Base64编码的图像。 ?

Categories： 部分支持。 只有'商'和'个人'类别的支持。

? ?

Urls： 部分支持。 第一个URL存储在黑莓 网页 领域。 Timezone： 此属性是不支持，而且将永远是为返回 空 。

iOS怪癖

?

Displayname： 不支持此属性是由内部监督办公室，将作为返回 空 ，除非没有 联系人姓名 指定。 如果没有 联系人姓名 ，然后复合 名称 ， nickame 或“”是返回 的displayName 分别。 ? ? ? ? ?

Revision： 此属性是只输出，不能修改。 它返回为一个JavaScript Date对象。 Birthday： 对于输入，此属性必须提供一个JavaScript Date对象。 它返回为一个JavaScript Date对象。

Gender： 不支持此属性是内部监督办公室的设备，而且将永远是为返回 空 。 Photos： 返回的照片是存储在应用程序的临时目录和 文件 的URL照片返回。 临时文件夹是应用程序退出时删除。

Categories： 这个属性是目前不支持，将永远被视为返回 空 。

ContactAddress

包含地址的属性为 Contact 对象。

属性

? ? ? ? ? ?

Formatted： 完整的地址显示格式为。 （DOMString） streetAddress： 完整的街道地址。 （DOMString） locality： 城市或地区。 （DOMString） region： 国家或地区。 （DOMString）

postalCode： 的邮政编码或邮政编码。 （DOMString） country： 这个国家 的名字 。 （DOMString）

详情

该 ContactAddress 对象存储联系人的属性地址的一个。 一个 联系 对象可以有一个或更多的是解决了 ContactAddress [] 数组。

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

/ /显示所有联系人的地址信息

function onSuccess(contacts) {

for (var i=0; i

for (var j=0; j

alert(\ + contacts[i].addresses[j].formatted + \ + \ + contacts[i].addresses[j].streetAddress + \ +

\ + contacts[i].addresses[j].locality + \ + \ + contacts[i].addresses[j].region + \ +

\ + contacts[i].addresses[j].postalCode + \ + \ + contacts[i].addresses[j].country); } } };

function onError() { alert('onError!'); };

// find all contacts

var options = new ContactFindOptions(); options.filter=\;

var filter = [\,\];

navigator.service.contacts.find(filter, onSuccess, onError, options);

完整的例子

\

Example

Find Contacts

Android的1.X的怪癖

? ? ? ? ?

streetAddress： 不支持此属性是由Android 1.x设备，将总是返回 空 。 locality： 不支持此属性是由Android 1.x设备，将总是返回 空 。 region： 不支持此属性是由Android 1.x设备，将总是返回 空 。 postalCode： 不支持此属性是由Android 1.x设备，将总是返回 空 。 country： 不支持此属性是由Android 1.x设备，将总是返回 空 。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

? ? ? ? ? ?

formatted： 部分支持。 将返回所有的字段连接黑莓地址。

streetAddress： 支持。 黑莓连接将返回的 地址 和 地址2 地址字段。 locality： 支持。 存储在BlackBerry 城市 地址字段。

region： 支持。 存储在BlackBerry stateProvince 地址字段。 psstalCode： 支持。 存储在BlackBerry zipPostal 地址字段。 country： 支持。

iOS怪癖

?

fromatted： 目前不支持。

ContactField

支持在通用领域的 Contact 对象。 有些作为属性存储的是 ContactField 对象包括电子邮件地址，电话号码和网址。

属性

? ? ?

type： 一个字符串，它告诉你什么类型的本场为例：'家'）。（ （DOMString） value： 该）值的字段（如电话号码或电子邮件地址。 （DOMString） pref： 设置为 真 如果这 ContactField 用户的首选值。包含 （布尔）

详情

该 ContactField 对象是一个可重复使用的组件，用于支持通用的方式在一个联系人字段。 每个 ContactField 对象包含一个值的属性，类型属性和一个县的财产。 一个 跟 在对象存储的几个性质 ContactField [] 数组的地址，如电话号码和电子邮件。

在大多数情况下，有确定的值，可以不预先 输入 一个属性 ContactField 对象。 例如，一个电话号码可以有 类型 的值'家'，'工作'，'移动'，'iPhone'，或任何其他值是由接触数据库支持在特定 设备平台 。 然而，在该案件 联系 照片 领域，PhoneGap使得利用 类型 字段来指示图像的格式返回。 PhoneGap将返回 类型：'url'的 当 值 属性包含一个或URL的照片图像， 类型：'Base64的'时，返回 值 属性包含一个字符串的Base64编码的图像。

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

/ /创建一个新的联系人

var contact = navigator.service.contacts.create();

// store contact phone numbers in ContactField[] var phoneNumbers = [3];

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();

完整的例子

\

Example

Find Contacts

Android的怪癖

?

县： 不支持此属性是由Android设备，将总是返回 假 。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

? ? ?

Type： 部分支持。 用于电话号码。 Value： 支持。

Pref： 不支持此属性，将总是返回 假 。

iOS怪癖

?

Pref： 不支持此属性是内部监督办公室的设备和将总是返回 假 。

ContactFindOptions

包含一个属性，可以用来过滤结果 contacts.find 操作。

属性

? ? ?

Filter： 搜索字符串用于查找联系人。 （DOMString） （ 默认：“”） Multiple： 确定是否查找操作应该返回多个联系人。 （布尔） （默认：真） updatedSince： 只有指定日期更新了，因为接触。 （日期） （默认：“”）

支持的平台

? ? ?

Android

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

/ /成功回调

function onSuccess(contacts) {

for (var i=0; i

// error callback function onError() { alert('onError!'); };

// specify contact search criteria var options = new ContactFindOptions();

options.filter=\; // empty search string returns all contacts options.multiple=true; // return multiple results

filter = [\]; // return contact.displayName field

// find contacts

navigator.service.contacts.find(filter, onSuccess, onError, options);

完整的例子

\

Example

Find Contacts

Android的怪癖

?

updatedSince： 目前不支持。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

?

updatedSince： 目前不支持。

ContactName

包含 name的属性的 Contact 对象。

属性

? ? ? ? ? ?

formatted： 完整 名称 的联系。 （DOMString） familyName： 家庭的联系人 姓名 。 （DOMString） givenName： 联系人给出的 名字 。 （DOMString） middleName： 中间的联系人 姓名 。 （DOMString）

honorificPrefix： 前缀的联系人（例如先生或博士） （DOMString） honorificSuffix： 后缀的联系人（例如彼岸。）。 （DOMString）

详情

该 ContactName 对象存储 name 联系性质的。

支持的平台

? ? ?

Adnroid2.x

BlackBerry WebWorks（操作系统5.0和更高版本） iOS

简单的例子

function onSuccess(contacts) {

for (var i=0; i

alert(\ + contacts[i].name.formatted + \ + \ + contacts[i].name.familyName + \ + \ + contacts[i].name.givenName + \ + \ + contacts[i].name.middleName + \ +

\ + contacts[i].name.honorificSuffix + \ + \ + contacts[i].name.honorificSuffix); } };

function onError() { alert('onError!'); };

var options = new ContactFindOptions(); options.filter=\;

filter = [\,\];

navigator.service.contacts.find(filter, onSuccess, onError, options);

完整的例子

\

Example

Find Contacts

Android的怪癖

?

formatted： 部分支持。 将返回honorificSuffix串联的honorificPrefix，givenName，middleName，但不会familyName和存储。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

? ? ? ? ? ?

formatted： 部分支持。 黑莓连接将返回的 的firstName 和 lastName的 领域。 familyName： 支持。 存储在黑莓 的lastName 字段。 givenName： 支持。 存储在黑莓 的firstName 字段。 middleName： 不支持此属性，将总是返回 空 。 honorificPrefix： 不支持此属性，将总是返回 空 。 honorificSuffix： 不支持此属性，将总是返回 空 。

iOS怪癖

?

formatted： 部分支持。 将返回的iOS复合名称，但不会储存。

ContactOrganization

包含了一个组织属性 Contact 对象。

属性

? ? ?

name ： 该 名称 的组织。 （DOMString） Department： 部门的合约工程。 （DOMString） Title： 标题了本组织在接触。 （DOMString）

详情

该 ContactOrganization 对象存储联系人的组织属性。 一个 联系 对象存储的一个或多个 ContactOrganization 数组对象中。

支持的平台

? ? ?

Android

BlackBerryWebWorks（操作系统5.0和更高版本） iOS

简单的例子

function onSuccess(contacts) {

for (var i=0; i

for (var j=0; j

alert(\ + contacts[i].organizations[j].name + \ +

\ + contacts[i].organizations[j].department + \ +

\ + contacts[i].organizations[j].title); } } };

function onError() { alert('onError!'); };

var options = new ContactFindOptions(); options.filter=\;

filter = [\,\];

navigator.service.contacts.find(filter, onSuccess, onError, options);

完整的例子

\

Example

Find Contacts

Android的1.X的怪癖

?

title： 不支持此属性是由Android 1.x设备，而且将永远是为返回 空 。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

? ? ?

name ： 部分支持。 第一个组织 名称 将存储在BlackBerry 公司 领域。 Department： 这个属性是不支持，而且将永远是为返回 空 。

Title： 部分支持。 第一个组织名称将存储在BlackBerry jobTitle 领域。

的iOS怪癖

? ? ?

Name ： 部分支持。 第一个组织 名称 将存储在内部监督办公室 kABPersonOrganizationProperty 领域。

Department ：部分支持。 第一部 的名字 将被储存在内部监督办公室 kABPersonDepartmentProperty 领域。

Title ：部分支持。 第一个冠军将被存储在内部监督办公室 kABPersonJobTitleProperty 领域。

ContactError

一个 ContactError 对象被返回到 contactError 回调时发生错误。

属性

?

代码： 下面一个预定义列出的错误代码。

常数

? ? ? ? ? ? ? ?

ContactError 。UNKNOWN_ERROR

ContactError 。INVALID_ARGUMENT_ERROR ContactError 。NOT_FOUND_ERROR ContactError 。TIMEOUT_ERROR

ContactError 。PENDING_OPERATION_ERROR ContactError 。IO_ERROR

ContactError 。NOT_SUPPORTED_ERROR ContactError 。PERMISSION_DENIED_ERROR

说明

该 ContactError 对象被返回到用户通过 contactError 回调函数时发生错误。

contactSuccess

成功的回调函数，提供了 联系 阵列造成 contacts.find 操作。 function (contacts) { / /做什么 } 参数

?

contacts： 接触数组查找操作造成的。 （Contact ）

范例

function contactSuccess(contacts) {

for (var i=0; i

console.log(\ + contacts[i].displayName; }

contactError

误差函数回调函数的联系。

function (error) {

/ /处理错误

}

contactFields

需要的参数的 contacts.find 方法。 使用这个参数来指定哪些领域应该是包含在 联系 工作从对象产生一个发现。

[\, \, \]

contactFindOptions

可选参数的 contacts.find 方法。 使用这个参数来筛选联系人数据库上的触点回来。

{

filter: \, multiple: true, updatedSince: \ };

选项

? ? ?

filter： 搜索字符串用于过滤的接触。 （DOMString） （ 默认：“”） multiple： 确定是否查找操作应该返回多个联系人。 （布尔） （默认：真） updatedSince： 只有指定日期更新了，因为接触。 （日期） （默认：“”）

Android的怪癖

?

updatedSince： 目前不支持。

BlackBerry WebWorks（操作系统5.0和更高版本）怪癖

?

updatedSince： 目前不支持。

本文来源：https://www.bwwdw.com/article/nk38.html