全部产品
云市场

通讯录 WVContacts

更新时间:2019-01-14 16:37:39

WVContacts.askAuth

仅限 WindVane iOS

请求访问通讯录的权限。

输入参数

无输入参数。

回调参数

回调参数将会在回调方法中传递,如果 iOS 版本低于 iOS 6,则无需请求通讯录权限,不会进入任何回调,否则总是进入 success 回调。

  • [int] isAuthed - 是否获得了访问通讯录的权限,0 表示没有权限,1 表示有权限。
  1. window.WindVane.call('WVContacts', 'askAuth', {}, function(e) {
  2. alert(JSON.stringify(e));
  3. });

WVContacts.authStatus

获取当前对于通讯录的访问权限状态。

输入参数

无输入参数。

回调参数

回调参数将会在回调方法中传递,总是进入 success 回调。

  • [boolean] isAuthed - 是否获得了访问通讯录的权限,0 表示没有权限,1 表示有权限。
  • [int] status - (仅限 WindVane iOS)对于 iOS 平台,会有更详细的状态信息:
    • 0 - Not Determined。
    • 1 - Restricted。
    • 2 - Denied。
    • 3 - Authorized。
  1. window.WindVane.call('WVContacts', 'authStatus', {}, function(e) {
  2. alert(JSON.stringify(e));
  3. });

WVContacts.choose

拉起通讯录列表,用户选择一个联系人之后将联系人的名字和电话返回给 H5。

输入参数

无输入参数。

回调参数

回调参数将会在回调方法中传递,如果用户选择了联系人,则进入 success 回调,否则进入 failure 回调。

  • [string] name - 选择的联系人的姓名。
  • [string] phone - 选择的联系人的电话号码。
  1. window.WindVane.call('WVContacts', 'choose', {}, function(e) {
  2. alert('success: ' + JSON.stringify(e));
  3. }, function(e) {
  4. alert('failure: ' + JSON.stringify(e))
  5. });

WVContacts.find

通过指定的名字和电话号码查找通讯录。

输入参数

  • [object] filter - 联系人的过滤器,包含以下属性:
    • [string] name - 查找具有指定姓名的联系人。
    • [string] phone - 查找具有指定电话号码的联系人。

如果 phonename 都存在则表示关联查找(同时满足两个条件)。若某个联系人有多个电话号码,会在结果列表中显示为多条记录。

注意:在 iOS 平台下,只要联系人姓名中包含 name ,就认为该联系人满足条件,电话号码也同理。而在 Android 平台下,5.7.8 版本之前联系人姓名必须与 name 相同,才认为该联系人满足条件,5.7.8 版本及之后版本与 iOS 相同。

回调参数

回调参数将会在回调方法中传递,总是进入 success 回调。

  • [array] contacts - 满足过滤条件的联系人列表,每一项包含以下属性:
    • [string] name - 联系人的姓名。
    • [string] phone - 联系人的电话号码。
  1. var params = {
  2. // 联系人的过滤器
  3. filter: {
  4. // 查找具有指定姓名的联系人
  5. name: '张三',
  6. // 查找具有指定电话号码的联系人
  7. phone: '123456'
  8. }
  9. }
  10. window.WindVane.call('WVContacts', 'find', params, function(e) {
  11. alert(JSON.stringify(e));
  12. });