通讯录类WVContacts有哪些JSAPI_移动研发平台-阿里云帮助中心

本文介绍通讯录类WVContacts相关的JS API，供您在通过跨平台DevOps创建H5端应用或者小程序时参考。通讯录类WVContacts的JS API提供通讯录权限的相关能力。

WVContacts.askAuth

说明

该API仅适用于WindVane iOS。

请求访问通讯录的权限。

输入参数

无输入参数。

回调参数

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

[int] isAuthed：是否获得了访问通讯录的权限，0表示没有权限，1表示有权限。

window.WindVane.call('WVContacts', 'askAuth', {}, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.authStatus

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

输入参数

无输入参数。

回调参数

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

[boolean] isAuthed：是否获得了访问通讯录的权限，0表示没有权限，1表示有权限。
[int] status：（仅限 WindVane iOS）对于iOS平台，会有更详细的状态信息：
- 0：Not Determined。
- 1：Restricted。
- 2：Denied。
- 3：Authorized。

window.WindVane.call('WVContacts', 'authStatus', {}, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.choose

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

输入参数

无输入参数。

回调参数

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

[string] name：选择的联系人的姓名。
[string] phone：选择的联系人的电话号码。

window.WindVane.call('WVContacts', 'choose', {}, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e))
});

WVContacts.find

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

输入参数

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

如果phone 和name都存在则表示关联查找（同时满足两个条件）。若某个联系人有多个电话号码，会在结果列表中显示为多条记录。

说明

在iOS平台下，只要联系人姓名中包含name，就认为该联系人满足条件，电话号码也同理。

回调参数

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

[array]contacts：满足过滤条件的联系人列表，每一项包含以下属性：
- [string] name：联系人的姓名。
- [string] phone：联系人的电话号码。

var params = {
        // 联系人的过滤器
        filter: {
                // 查找具有指定姓名的联系人
                name: '张三',
                // 查找具有指定电话号码的联系人
                phone: '123456'
        }
}
window.WindVane.call('WVContacts', 'find', params, function(e) {
        alert(JSON.stringify(e));
});

WVContacts.addPhoneContact

说明

该API只在Windvane Android 1.0.3.4以上版本有效。

添加联系人。

输入参数

[string] lastName：姓。
[string] firstName：名。
[string] middleName：可选，中间名。
[string] nickName：可选，昵称。
[string] remark：可选，备注。
[string] mobilePhoneNumber：可选，移动电话。
[string] hostNumber：可选，公司/住址电话。
[string] address：可选，地址。
[string] email：可选，邮件。
[string] organization：可选。
[string] title：可选，职位。
[string] photoPath：可选，头像本地文件路径。

回调参数

成功回调参数：

无回调参数。

失败回调参数：

[string] msg：错误消息。

var params = {
  lastName: 'xxx',
  firstName: 'xxx',
  middleName:'xxx',
  nickName: 'xxx',
  remark: 'xxx',
  mobilePhoneNumber: '+86 12345',
  hostNumber: '12345',
  address: 'Beijing Chaoyang',
  email: 'xxx@xxx.com',
  organization: 'xxx',
  title: 'xxx',
  photoPath: '/storage/emulated/0/DCIM/Camera/xxx.jpg
}

window.WindVane.call('WVContacts', 'addPhoneContact', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e))
});