`
samwong
  • 浏览: 288926 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

PhoneGap API帮助文档翻译—Contacts(通讯录) PhoneGap API帮助文档翻译—Contacts(通讯录)

 
阅读更多

PhoneGap API帮助文档翻译—Contacts(通讯录)

contacts对象提供对设备通讯录数据库的访问。
方法:
  • contacts.create
  • contacts.find
参数:
  • contactFields
  • contactSuccess
  • contactError
  • contactFindOptions
对象:
  • Contact
  • ContactName
  • ContactField
  • ContactAddress
  • ContactOrganization
  • ContactFindOptions
  • ContactError
contacts.create
返回一个新的Contact对象。
说明:
contacts.create是用于创建并返回一个新Contact对象的同步函数。
该方法不会将新创建的Contact对象持久化到设备的通讯录数据库。可通过调用Contact.save方法将新建的Contact对象持久化到设备。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
contacts.find
查询设备通讯录数据库,并返回包含指定字段的一个或多个Contact对象。
说明:
contacts.find是一个查询设备通讯录数据库并返回Contact对象数组的同步函数。返回的对象会被传递给contactSuccess回调函数的contactSuccess参数。
用户必须在contactFields参数中指定联系人的字段作为搜索限定符。系统传递给contactSuccess回调函数的Contact对象属性只会包含在contactFields参数中定义的字段。如果定义0长度的contactFields参数会导致返回的Contact对象只填充了id属性。
contactFindOptions.filter字符串可以用来作为查询通讯录数据库时的搜索过滤器。如果设定了该参数,系统会对通讯录数据库中所有联系人按照contactFields参数中指定的每个字段进行不区分大小写的部分值匹配。任何指定的字段符合过滤器所要求的内容的联系人数据都会被返回。
属性:
  • contactFields:Contact字段,用作搜索限定符。在返回的Contact对象中只有这些字段有值。(DOMString[]类型)[必填]
  • contactSuccess:通讯录获取成功时调用的回调函数,将从通讯录数据库获取的联系人作为参数。[必填]
  • contactError:错误回调函数,当发生错误的时候被调用。[可选]
  • contactFindOptions:用于过滤通讯录的搜索选项。[可选]
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Contact
包含描述联系人的属性,比如用户的个人或者商务联系方式。
属性:
  • id:全局唯一标识符。(DOMString类型)
  • displayname:联系人显示名称,适合向最终用户展示的联系人名称。(DOMString类型)
  • name:联系人姓名所有部分的对象。(CantactName类型)
  • nickname:昵称,对联系人的非正式称呼。(DOMString类型)
  • phoneNumbers:联系人所有联系电话的数组。(ContactField[]类型)
  • emails:联系人所有email地址的数组。(ContactField[]类型)
  • addrsses:联系人所有联系地址的数组。(ContactAddresses[]类型)
  • ims:联系人所有IM地址的数组。(ContactField[]类型)
  • organizations:联系人所属所有组织的数组。(ContactOrganization[]类型)
  • birthday:联系人的生日。(日期类型)
  • note:联系人的注释信息。(DOMString类型)
  • photos:联系人所有照片的数组.(ContactField[]类型)
  • categories:联系人所属的所有用户自定义类别的数组。(ContactField[]类型)
  • urls:与联系人相关网页的数组。(ContactField[]类型)
方法:
  • clone:返回一个新的Contact对象,它是调用对象的深度拷贝,其id属性被设为null。
  • remove:从通讯录数据库中删除联系人。当删除不成功的时候,触发以ContactError对象为参数的错误处理回调函数。
  • save:将一个新联系人存储到通讯录数据库,如果通讯录数据库中已经包含与其ID相同的记录,则更新该已有记录。
详述:
Contact对象代表一个用户联系人。Contacts可以在设备通讯录数据库中被创建,存储或者删除,同样也可以使用 contacts.find方法从数据库中进行检索。
备注:并不是所有的设备平台都支持以上列出的所有联系人字段。请通过查看每个平台的特异情况描述部分,了解每个平台分别支持哪些字段。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
Save 简单的范例:
Clone 简单的范例:
Remove 简单的范例:
完整的范例:
Android 2.X的特异情况:
  • categories:Android2.X设备上不支持该属性,返回值总是null。
Android 1.X的特异情况:
  • name:Android1.x设备上不支持该属性,返回值总是null。
  • nickname:Android1.x设备上不支持该属性,返回值总是null。
  • birthday: Android1.x设备上不支持该属性,返回值总是null。
  • photos:Android1.x设备上不支持该属性,返回值总是null。
  • categories:Android1.x设备上不支持该属性,返回值总是null。
  • urls:Android1.x设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • id:支持,系统在存储联系人记录时自动分配。
  • displayname:支持,存储到BlackBerry的user1字段。
  • nickname:不支持该属性,返回值总是null。
  • phoneNumber:部分支持,类型为“home”的电话号码将被存储到BlackBerry的homePhone1homePhone2字段;类型为“work”将被存储到workPhone1workPhone2字段;类型为“mobile”将被存储到mobilePhone;类型为“fax”将被存储到faxPhone字段;类型为“pager”将被存储到pagerPhone;如果电话号码不属于以上类型则被存储到otherPhone字段。
  • emails:部分支持,前三个邮件地址将被分别存储到BlackBerry的email1email2email3这三个字段。
  • addresses:部分支持,第一和第二个地址将被分别存储到BlackBerry的homeAddress以及workAddress字段。
  • ims: 不支持该属性,返回值总是null。
  • organizations:部分支持,第一个组织的名称和职务将被分别存储到BlackBerry的companytitle字段。
  • photos:部分支持,只支持一个缩略图大小的照片。要设置一个联系人照片的话,可以通过传递一个Base64编码的图片或一个指向图片的URL,该图片在存储到联系人数据库之前会被缩小。联系人照片会以Base64编码形式的图片返回。
  • categories:部分支持,只支持“Business”和“Personal”这两个类别。
  • urls:部分支持,第一个url将被存储到BlackBerry的webpage字段。
iOS的特异情况:
  • displayName:iOS不支持该属性。除非没有给联系人指定ContactName,否则该字段返回值总是null。如果没有指定ContactName,系统会根据有无设定值的情况依次返回composite name,nickename或空字符串。
  • birthday:对于输入而言,必须为其提供一个JavaScript日期对象。同样其返回值也是JavaScript日期对象。
  • photos:传回的照片存储在应用程序的临时目录,同时返回指向该照片的文件URL。临时目录在应用程序退出后被删除。
  • categories:目前不支持该属性,返回值总是null。
ContactAddress
包含Contact对象的地址属性。
属性:
  • pref:如果该ContactAddress包含用户的首选值,则设置为true。(布尔类型)
  • type:用来标示该地址对应的类型的字符串(例如:“home”)。(DOMString类型)
  • formatted:完整的地址显示格式。(DOMString格式)
  • streeAddress:完整的街道地址。(DOMString格式)
  • locality:城市或地区。(DOMString格式)
  • region:州或省份。(DOMString格式)
  • postalCode:邮政编码。(DOMString格式)
  • country:国家名称。(DOMString格式)
详述:
ContactAddress对象存储一个联系人的单个地址。一个Contact对象可以拥有一个或多个地址,这些地址存储在一个ContactAddress[]数组中。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 2.X 的特异情况
  • pref:Android2.X设备上不支持该属性,返回值总是false。
Android 1.X 的特异情况:
  • pref:Android1.X设备上不支持该属性,返回值总是false。
  • type:Android1.X设备上不支持该属性,返回值总是null。
  • streetAddress:Android1.X设备上不支持该属性,返回值总是null。
  • locality:Android1.X设备上不支持该属性,返回值总是null。
  • region:Android1.X设备上不支持该属性,返回值总是null。
  • postalCode:Android1.X设备上不支持该属性,返回值总是null。
  • country:Android1.X设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • pref:BlackBerry设备上不支持该属性,返回值总是false。
  • type:部分支持,对于一个联系人对象只能分别存储一个“Work”和一个“Home”类型的地址。
  • formatted:部分支持,将返回所有BlackBerry 地址字段的串联。
  • streetAddress:支持,将返回BlackBerry address1address2两个地址字段的串联。
  • locality:支持,存储到BlackBerry city字段。
  • region:支持,存储到BlackBerry stateProvince字段。
  • postalCode:支持,存储到BlackBerry zipPostal字段。
  • country:支持。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
  • formatted:目前不支持。
ContactField
Contact对象中支持的通用字段类型,存储为ContactField对象的属性包括:email addresses、phone numbers和urls等。
属性:
  • type:说明当前字段类型的字符串(例如:“home”)。(DOMString类型)
  • value:字段的值(例如:电话号码或邮件地址)。(DOMString类型)
  • pref:如果当前ContactField包含用户的首选项,则设置为true。(布尔类型)
详述:
ContactField对象是一个可重用的组件,用于支持通用方式的联系人字段。每个ContactField对象都包含一个值属性、一个类型属性和一个首选项属性。一个Contact对象将多个属性分别存储到多个ContactField[]数组中,例如电话号码与邮件地址等。
在大多数情况下,ContactField对象中的type属性并没有事先确定值。例如,一个电话号码的type属性值可以是:“home”、“work”、“mobile”、“iPhone”或其他相应特定设备平台的联系人数据库所支持的值。然而对于Contact对象的photos字段,PhoneGap使用type字段来表示返回的图像格式。如果value属性包含的是一个指向照片图像的URL,PhoneGap对于type会返回“url”;如果value属性包含的是图像的Base64编码字符串,PhoneGap对于type会返回“base64”。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 的特异情况:
  • pref:Android设备上不支持该属性,返回值总是false。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • type:部分支持,用于电话号码。
  • value:支持。
  • pref:不支持该属性,返回值总是false。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
ContactFindOptions
包含用于contacts.find操作对所有联系人进行过滤的属性。
属性:
  • filter:用于查找联系人的搜索字符串。(DOMString类型) (默认值为空字符串)
  • multiple:决定查收操作是否可以返回多条联系人记录。(布尔类型) (默认值为false)
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
ContactName
包含Contact对象的名称属性。
属性:
  • formatted:联系人的全名。(DOMString类型)
  • familyName:联系人的姓氏。 (DOMString类型)
  • givenName:联系人的名字。(DOMString类型)
  • middleName:联系人的中间名。(DOMString类型)
  • honorificPrefix:敬语前缀。(例如:Mr.或Dr.)(DOMString类型)
  • honorificSuffix:敬语后缀。(例如:Esq.)(DOMString)
详述:
ContactName对象存储联系人的name属性。
支持的平台:
  • Android 2.X
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 的特异情况:
  • formatted:部分支持,将返回honorificPrefix、givenName、middleName、familyName和honorificSuffix的串联结果,但不会单独存储。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • formatted:部分支持,将返回BlackBerry firstNamelastName两个字段的串联结果。
  • familyName:支持,存放到BlackBerry 的lastName字段。
  • givenName:支持,存储到BlackBerry 的firstName字段。
  • middleName:不支持该属性,返回值总是null。
  • honorificPrefix:不支持该属性,返回值总是null。
  • honorificSuffix:不支持该属性,返回值总是null。
iOS的特异情况:
  • formatted:部分支持,将返回iOS的Composite Name,但不会单独存储。
ContactOrganization
包含Contact对象的所属组织属性。
属性:
  • pref:如果该ContactOrganization包含用户的首选值,则设置为true。(布尔类型)
  • type:用来标示该所属组织对应的类型的字符串(例如:“home”)。(DOMString类型)
  • name:组织的名称。(DOMString类型)
  • department:联系人工作的部门。(DOMString类型)
  • title:联系人在所属组织内的职务。(DOMString类型)
详述:
ContactOrganization对象存储联系人的所属组织属性,Contact对象通过一个数组存储一个或多个ContactOrganization对象。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 2.X 的特异情况:
  • pref:Android2.X设备上不支持该属性,返回值总是false。
Android 1.X 的特异情况:
  • pref:Android1.X设备上不支持该属性,返回值总是false。
  • type:Android1.X设备上不支持该属性,返回值总是null。
  • title:Android1.X设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • pref:BlackBerry设备上不支持该属性,返回值总是false。
  • type:BlackBerry设备上不支持该属性,返回值总是null。
  • name:部分支持,第一个组织名称将被存储到BlackBerry 的company字段。
  • department:不支持该属性,返回值总是null。
  • title:部分支持,第一个组织职务将被存储到BlackBerry 的jobTitle字段。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
  • type:iOS设备上不支持该属性,返回值总是null。
  • name:部分支持,第一个组织名称将被存放到iOS的kABPersonOrganizationProperty字段。
  • department:部分支持,第一个部门名字将被存放到iOS的kABPersonDepartmentProperty字段。
  • title:部分支持,第一个组织职务将被存放到iOS的kABPersonJobTitleProperty字段。
ContactError
当有错误发生时,一个ContactError对象会传递给contactError回调函数。
属性:
  • code:一个在下面常量中定义好的错误代码。
常量:
  • ContactError.UNKNOWN_ERROR:未知错误类型
  • ContactError.INVALID_ARGUMENT_ERROR:无效参数错误类型
  • ContactError.TIMEOUT_ERROR:请求超时错误类型
  • ContactError.PENDING_OPERATION_ERROR:挂起操作错误类型
  • ContactError.IO_ERROR:输入输出错误类型
  • ContactError.NOT_SUPPORTED_ERROR:平台不支持错误类型
  • ContactError.PERMISSION_DENIED_ERROR:权限被拒绝错误类型
说明:
当有错误发生时,ContactError对象会通过contactError回调函数返回给用户。
contactSuccess
contacts.find操作成功时调用的回调函数,同时返回查找到的Contact数组。
简单的范例:
参数:
  • contacts:查找操作返回的联系人数组。(Contact[]类型)
范例:
contactError
操作联系人出错时的回调函数。
contactFields
contacts.find方法的必填参数,该参数定义了查找操作返回的Contact对象中应该包含哪些字段。
contactFindOptions
contats.find方法的可选参数,通过该参数从通讯录数据库中筛选联系人。
选项:
  • filter:用于查找联系人的搜索字符串。(DOMString类型) (默认值为空字符串)
  • multiple:决定查找操作是否可以返回多条联系人记录。(布尔类型) (默认值为false)


contacts对象提供对设备通讯录数据库的访问。
方法:
  • contacts.create
  • contacts.find
参数:
  • contactFields
  • contactSuccess
  • contactError
  • contactFindOptions
对象:
  • Contact
  • ContactName
  • ContactField
  • ContactAddress
  • ContactOrganization
  • ContactFindOptions
  • ContactError
contacts.create
返回一个新的Contact对象。
说明:
contacts.create是用于创建并返回一个新Contact对象的同步函数。
该方法不会将新创建的Contact对象持久化到设备的通讯录数据库。可通过调用Contact.save方法将新建的Contact对象持久化到设备。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
contacts.find
查询设备通讯录数据库,并返回包含指定字段的一个或多个Contact对象。
说明:
contacts.find是一个查询设备通讯录数据库并返回Contact对象数组的同步函数。返回的对象会被传递给contactSuccess回调函数的contactSuccess参数。
用户必须在contactFields参数中指定联系人的字段作为搜索限定符。系统传递给contactSuccess回调函数的Contact对象属性只会包含在contactFields参数中定义的字段。如果定义0长度的contactFields参数会导致返回的Contact对象只填充了id属性。
contactFindOptions.filter字符串可以用来作为查询通讯录数据库时的搜索过滤器。如果设定了该参数,系统会对通讯录数据库中所有联系人按照contactFields参数中指定的每个字段进行不区分大小写的部分值匹配。任何指定的字段符合过滤器所要求的内容的联系人数据都会被返回。
属性:
  • contactFields:Contact字段,用作搜索限定符。在返回的Contact对象中只有这些字段有值。(DOMString[]类型)[必填]
  • contactSuccess:通讯录获取成功时调用的回调函数,将从通讯录数据库获取的联系人作为参数。[必填]
  • contactError:错误回调函数,当发生错误的时候被调用。[可选]
  • contactFindOptions:用于过滤通讯录的搜索选项。[可选]
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Contact
包含描述联系人的属性,比如用户的个人或者商务联系方式。
属性:
  • id:全局唯一标识符。(DOMString类型)
  • displayname:联系人显示名称,适合向最终用户展示的联系人名称。(DOMString类型)
  • name:联系人姓名所有部分的对象。(CantactName类型)
  • nickname:昵称,对联系人的非正式称呼。(DOMString类型)
  • phoneNumbers:联系人所有联系电话的数组。(ContactField[]类型)
  • emails:联系人所有email地址的数组。(ContactField[]类型)
  • addrsses:联系人所有联系地址的数组。(ContactAddresses[]类型)
  • ims:联系人所有IM地址的数组。(ContactField[]类型)
  • organizations:联系人所属所有组织的数组。(ContactOrganization[]类型)
  • birthday:联系人的生日。(日期类型)
  • note:联系人的注释信息。(DOMString类型)
  • photos:联系人所有照片的数组.(ContactField[]类型)
  • categories:联系人所属的所有用户自定义类别的数组。(ContactField[]类型)
  • urls:与联系人相关网页的数组。(ContactField[]类型)
方法:
  • clone:返回一个新的Contact对象,它是调用对象的深度拷贝,其id属性被设为null。
  • remove:从通讯录数据库中删除联系人。当删除不成功的时候,触发以ContactError对象为参数的错误处理回调函数。
  • save:将一个新联系人存储到通讯录数据库,如果通讯录数据库中已经包含与其ID相同的记录,则更新该已有记录。
详述:
Contact对象代表一个用户联系人。Contacts可以在设备通讯录数据库中被创建,存储或者删除,同样也可以使用 contacts.find方法从数据库中进行检索。
备注:并不是所有的设备平台都支持以上列出的所有联系人字段。请通过查看每个平台的特异情况描述部分,了解每个平台分别支持哪些字段。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
Save 简单的范例:
Clone 简单的范例:
Remove 简单的范例:
完整的范例:
Android 2.X的特异情况:
  • categories:Android2.X设备上不支持该属性,返回值总是null。
Android 1.X的特异情况:
  • name:Android1.x设备上不支持该属性,返回值总是null。
  • nickname:Android1.x设备上不支持该属性,返回值总是null。
  • birthday: Android1.x设备上不支持该属性,返回值总是null。
  • photos:Android1.x设备上不支持该属性,返回值总是null。
  • categories:Android1.x设备上不支持该属性,返回值总是null。
  • urls:Android1.x设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • id:支持,系统在存储联系人记录时自动分配。
  • displayname:支持,存储到BlackBerry的user1字段。
  • nickname:不支持该属性,返回值总是null。
  • phoneNumber:部分支持,类型为“home”的电话号码将被存储到BlackBerry的homePhone1homePhone2字段;类型为“work”将被存储到workPhone1workPhone2字段;类型为“mobile”将被存储到mobilePhone;类型为“fax”将被存储到faxPhone字段;类型为“pager”将被存储到pagerPhone;如果电话号码不属于以上类型则被存储到otherPhone字段。
  • emails:部分支持,前三个邮件地址将被分别存储到BlackBerry的email1email2email3这三个字段。
  • addresses:部分支持,第一和第二个地址将被分别存储到BlackBerry的homeAddress以及workAddress字段。
  • ims: 不支持该属性,返回值总是null。
  • organizations:部分支持,第一个组织的名称和职务将被分别存储到BlackBerry的companytitle字段。
  • photos:部分支持,只支持一个缩略图大小的照片。要设置一个联系人照片的话,可以通过传递一个Base64编码的图片或一个指向图片的URL,该图片在存储到联系人数据库之前会被缩小。联系人照片会以Base64编码形式的图片返回。
  • categories:部分支持,只支持“Business”和“Personal”这两个类别。
  • urls:部分支持,第一个url将被存储到BlackBerry的webpage字段。
iOS的特异情况:
  • displayName:iOS不支持该属性。除非没有给联系人指定ContactName,否则该字段返回值总是null。如果没有指定ContactName,系统会根据有无设定值的情况依次返回composite name,nickename或空字符串。
  • birthday:对于输入而言,必须为其提供一个JavaScript日期对象。同样其返回值也是JavaScript日期对象。
  • photos:传回的照片存储在应用程序的临时目录,同时返回指向该照片的文件URL。临时目录在应用程序退出后被删除。
  • categories:目前不支持该属性,返回值总是null。
ContactAddress
包含Contact对象的地址属性。
属性:
  • pref:如果该ContactAddress包含用户的首选值,则设置为true。(布尔类型)
  • type:用来标示该地址对应的类型的字符串(例如:“home”)。(DOMString类型)
  • formatted:完整的地址显示格式。(DOMString格式)
  • streeAddress:完整的街道地址。(DOMString格式)
  • locality:城市或地区。(DOMString格式)
  • region:州或省份。(DOMString格式)
  • postalCode:邮政编码。(DOMString格式)
  • country:国家名称。(DOMString格式)
详述:
ContactAddress对象存储一个联系人的单个地址。一个Contact对象可以拥有一个或多个地址,这些地址存储在一个ContactAddress[]数组中。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 2.X 的特异情况
  • pref:Android2.X设备上不支持该属性,返回值总是false。
Android 1.X 的特异情况:
  • pref:Android1.X设备上不支持该属性,返回值总是false。
  • type:Android1.X设备上不支持该属性,返回值总是null。
  • streetAddress:Android1.X设备上不支持该属性,返回值总是null。
  • locality:Android1.X设备上不支持该属性,返回值总是null。
  • region:Android1.X设备上不支持该属性,返回值总是null。
  • postalCode:Android1.X设备上不支持该属性,返回值总是null。
  • country:Android1.X设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • pref:BlackBerry设备上不支持该属性,返回值总是false。
  • type:部分支持,对于一个联系人对象只能分别存储一个“Work”和一个“Home”类型的地址。
  • formatted:部分支持,将返回所有BlackBerry 地址字段的串联。
  • streetAddress:支持,将返回BlackBerry address1address2两个地址字段的串联。
  • locality:支持,存储到BlackBerry city字段。
  • region:支持,存储到BlackBerry stateProvince字段。
  • postalCode:支持,存储到BlackBerry zipPostal字段。
  • country:支持。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
  • formatted:目前不支持。
ContactField
Contact对象中支持的通用字段类型,存储为ContactField对象的属性包括:email addresses、phone numbers和urls等。
属性:
  • type:说明当前字段类型的字符串(例如:“home”)。(DOMString类型)
  • value:字段的值(例如:电话号码或邮件地址)。(DOMString类型)
  • pref:如果当前ContactField包含用户的首选项,则设置为true。(布尔类型)
详述:
ContactField对象是一个可重用的组件,用于支持通用方式的联系人字段。每个ContactField对象都包含一个值属性、一个类型属性和一个首选项属性。一个Contact对象将多个属性分别存储到多个ContactField[]数组中,例如电话号码与邮件地址等。
在大多数情况下,ContactField对象中的type属性并没有事先确定值。例如,一个电话号码的type属性值可以是:“home”、“work”、“mobile”、“iPhone”或其他相应特定设备平台的联系人数据库所支持的值。然而对于Contact对象的photos字段,PhoneGap使用type字段来表示返回的图像格式。如果value属性包含的是一个指向照片图像的URL,PhoneGap对于type会返回“url”;如果value属性包含的是图像的Base64编码字符串,PhoneGap对于type会返回“base64”。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 的特异情况:
  • pref:Android设备上不支持该属性,返回值总是false。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • type:部分支持,用于电话号码。
  • value:支持。
  • pref:不支持该属性,返回值总是false。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
ContactFindOptions
包含用于contacts.find操作对所有联系人进行过滤的属性。
属性:
  • filter:用于查找联系人的搜索字符串。(DOMString类型) (默认值为空字符串)
  • multiple:决定查收操作是否可以返回多条联系人记录。(布尔类型) (默认值为false)
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
ContactName
包含Contact对象的名称属性。
属性:
  • formatted:联系人的全名。(DOMString类型)
  • familyName:联系人的姓氏。 (DOMString类型)
  • givenName:联系人的名字。(DOMString类型)
  • middleName:联系人的中间名。(DOMString类型)
  • honorificPrefix:敬语前缀。(例如:Mr.或Dr.)(DOMString类型)
  • honorificSuffix:敬语后缀。(例如:Esq.)(DOMString)
详述:
ContactName对象存储联系人的name属性。
支持的平台:
  • Android 2.X
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 的特异情况:
  • formatted:部分支持,将返回honorificPrefix、givenName、middleName、familyName和honorificSuffix的串联结果,但不会单独存储。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • formatted:部分支持,将返回BlackBerry firstNamelastName两个字段的串联结果。
  • familyName:支持,存放到BlackBerry 的lastName字段。
  • givenName:支持,存储到BlackBerry 的firstName字段。
  • middleName:不支持该属性,返回值总是null。
  • honorificPrefix:不支持该属性,返回值总是null。
  • honorificSuffix:不支持该属性,返回值总是null。
iOS的特异情况:
  • formatted:部分支持,将返回iOS的Composite Name,但不会单独存储。
ContactOrganization
包含Contact对象的所属组织属性。
属性:
  • pref:如果该ContactOrganization包含用户的首选值,则设置为true。(布尔类型)
  • type:用来标示该所属组织对应的类型的字符串(例如:“home”)。(DOMString类型)
  • name:组织的名称。(DOMString类型)
  • department:联系人工作的部门。(DOMString类型)
  • title:联系人在所属组织内的职务。(DOMString类型)
详述:
ContactOrganization对象存储联系人的所属组织属性,Contact对象通过一个数组存储一个或多个ContactOrganization对象。
支持的平台:
  • Android
  • BlackBerry WebWorks (OS 5.0或更高版本)
  • iOS
简单的范例:
完整的范例:
Android 2.X 的特异情况:
  • pref:Android2.X设备上不支持该属性,返回值总是false。
Android 1.X 的特异情况:
  • pref:Android1.X设备上不支持该属性,返回值总是false。
  • type:Android1.X设备上不支持该属性,返回值总是null。
  • title:Android1.X设备上不支持该属性,返回值总是null。
BlackBerry WebWorks (OS 5.0或更高版本)的特异情况:
  • pref:BlackBerry设备上不支持该属性,返回值总是false。
  • type:BlackBerry设备上不支持该属性,返回值总是null。
  • name:部分支持,第一个组织名称将被存储到BlackBerry 的company字段。
  • department:不支持该属性,返回值总是null。
  • title:部分支持,第一个组织职务将被存储到BlackBerry 的jobTitle字段。
iOS的特异情况:
  • pref:iOS设备上不支持该属性,返回值总是false。
  • type:iOS设备上不支持该属性,返回值总是null。
  • name:部分支持,第一个组织名称将被存放到iOS的kABPersonOrganizationProperty字段。
  • department:部分支持,第一个部门名字将被存放到iOS的kABPersonDepartmentProperty字段。
  • title:部分支持,第一个组织职务将被存放到iOS的kABPersonJobTitleProperty字段。
ContactError
当有错误发生时,一个ContactError对象会传递给contactError回调函数。
属性:
  • code:一个在下面常量中定义好的错误代码。
常量:
  • ContactError.UNKNOWN_ERROR:未知错误类型
  • ContactError.INVALID_ARGUMENT_ERROR:无效参数错误类型
  • ContactError.TIMEOUT_ERROR:请求超时错误类型
  • ContactError.PENDING_OPERATION_ERROR:挂起操作错误类型
  • ContactError.IO_ERROR:输入输出错误类型
  • ContactError.NOT_SUPPORTED_ERROR:平台不支持错误类型
  • ContactError.PERMISSION_DENIED_ERROR:权限被拒绝错误类型
说明:
当有错误发生时,ContactError对象会通过contactError回调函数返回给用户。
contactSuccess
contacts.find操作成功时调用的回调函数,同时返回查找到的Contact数组。
简单的范例:
参数:
  • contacts:查找操作返回的联系人数组。(Contact[]类型)
范例:
contactError
操作联系人出错时的回调函数。
contactFields
contacts.find方法的必填参数,该参数定义了查找操作返回的Contact对象中应该包含哪些字段。
contactFindOptions
contats.find方法的可选参数,通过该参数从通讯录数据库中筛选联系人。
选项:
  • filter:用于查找联系人的搜索字符串。(DOMString类型) (默认值为空字符串)
  • multiple:决定查找操作是否可以返回多条联系人记录。(布尔类型) (默认值为false)


分享到:
评论

相关推荐

    PhoneGap,API帮助文档翻译整理6-Contacts(通讯录)

    **Contacts API** 是PhoneGap提供的一组用于读取和操作设备通讯录的功能。通过这个API,开发者可以在iOS、Android等不同平台上实现一致的通讯录访问体验。 #### 三、Contacts API主要功能及方法 **1. contacts....

    PhoneGap,API帮助文档翻译整理6-Contacts(通讯录).pdf

    在本文中,我们将围绕PhoneGap框架的API文档进行探讨,特别是在处理移动设备上的通讯录(Contacts)数据时所使用的一系列方法。根据提供的文件信息,我们将会详细解释如何使用PhoneGap API来创建和查找通讯录中的...

    PhoneGap,API帮助文档.zip

    这个"PhoneGap API帮助文档.zip"压缩包显然包含了关于如何使用PhoneGap API的详细指南,对于开发者来说是非常宝贵的资源。下面我们将深入探讨PhoneGap API中的关键组件及其功能。 1. **加速度计(Accelerometer)**...

    PhoneGap的API组件及使用方法

    PhoneGap是一种跨平台的移动应用开发框架,它允许开发者使用HTML、CSS和JavaScript来构建原生的移动应用程序。...理解并熟练使用这些API,结合Android平台的具体实践,能够帮助你构建出功能完善的移动应用。

    phonegap api中文手册

    本手册为PhoneGap API的中文版指南,旨在为开发者提供全面、详细的API使用指导,帮助其利用PhoneGap框架开发跨平台移动应用。PhoneGap是一款基于HTML、CSS和JavaScript的技术栈,允许开发者构建适用于多个移动操作...

    html5框架PhoneGap API详解笔记(ppt及word版)

    10. **联系人API(Contacts API)**:读取、创建、更新和删除设备的联系人信息。 11. **振动API(Vibration API)**:控制设备的振动功能。 **PhoneGap开发流程** 使用PhoneGap开发应用通常包括以下几个步骤: 1....

    iOS phonegap/Cordova实现打开通讯录添加联系人插件

    PhoneGap/Cordova的核心理念是通过WebView将Web应用与设备的原生功能相结合,提供了丰富的插件系统来访问如摄像头、GPS、存储等设备API。在本项目中,我们关注的是“通讯录”这一特定功能,它涉及到如何集成和使用...

    phonegap 遍历联系人

    PhoneGap的核心理念是通过Web技术来桥接移动设备的原生功能,如访问联系人、相机、GPS等,为开发者提供了一个统一的API接口,使得开发者无需学习多种平台的原生开发语言即可开发多平台的应用。 在“phonegap 遍历...

    【DOC】PhoneGap_API

    6. Contacts:联系人API允许读取、创建、更新和删除设备上的联系人信息。在Moto2.3.7上支持,但Samsung2.3.3上的支持情况未知,可能需要进一步测试。 7. Device:设备API提供了关于运行应用的设备的基本信息,如...

    PhoneGap - API 中文说明

    PhoneGap - API 中文说明 Accelerometer 加速度计 Camera 相机 Capture 捕捉 Compass 指南针 Contacts 联系人 Device 设备 Events 活动 File 文件 Geolocation 地理位置 Media 媒体 Network 网络 Notification 通知...

    PhoneGap - API 中文说明.rar )

    PhoneGap - API 中文说明 Accelerometer 加速度计 Camera 相机 Capture 捕捉 Compass 指南针 Contacts 联系人 Device 设备 Events 活动 File 文件 Geolocation 地理位置 Media 媒体 Network 网络 Notification 通知...

    基于phonegap的android电话本源码

    总的来说,这个基于PhoneGap的Android电话本源码涵盖了移动应用开发中的多个重要知识点,包括PhoneGap框架的使用、Android系统的Contacts API、JavaScript与原生API的交互、以及数据备份策略。对于想要学习PhoneGap...

    Phonegap获取全部联系人 操作联系人

    Phonegap 获取 所有联系人 此版本是cordova 3.4的 调用系统的API 经过修改 迭代出所有联系人 贴上完整代码 我的博客:http://blog.csdn.net/aaawqqq?viewmode=list

    使用jquery-mobile+html5实现android本地通讯录

    4. **调用PhoneGap Contacts API**:在JavaScript中,通过`navigator.contacts`对象来操作通讯录。例如,`navigator.contacts.find`用于获取所有联系人,`navigator.contacts.create`用于新建联系人,`navigator....

    phonegap入门经典源码

    6. 网络状态检测:PhoneGap的网络连接API(`navigator.connection`)可以帮助开发者检测设备的网络状态,如在线、离线,甚至区分不同类型的网络连接。这部分可能解释如何使用`navigator.connection.type`。 7. 位置...

    PhoneGap 例子程序

    PhoneGap提供了一系列的JavaScript库,如Accelerometer(加速度计)、Battery Status(电池状态)、Camera(相机)、Contacts(联系人)、Device(设备信息)、File(文件系统)、Geolocation(地理位置)等,这些都...

    关于html5开发框架PhoneGap的移动开发调研

    PhoneGap通过JavaScript接口提供了一种统一的方式来调用不同平台的设备API。例如,开发者可以通过JavaScript访问重力感应器(ACCELEROMETER)、摄像头(CAMERA)、指南针(COMPASS)、联系人(CONTACTS)、文件系统...

    phonegap 1.4.1

    6. **社区支持**:PhoneGap有一个庞大的开发者社区,提供了丰富的插件和教程资源,帮助开发者扩展其功能或解决开发过程中遇到的问题。 7. **更新迭代**:尽管1.4.1版本较旧,但PhoneGap后续版本不断演进,增加了更...

    PhoneGap例子

    PhoneGap将Web应用程序封装在一个移动设备的浏览器内核(如iOS的UIWebView或Android的WebView)中,通过JavaScript API与设备的原生功能进行通信。这些API是Cordova提供的,它们作为桥梁,使得JavaScript代码能够...

Global site tag (gtag.js) - Google Analytics