通訊錄 - SuperApp

本文介紹通訊錄類WVContacts相關的JS API，供您建立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))
});