アドレス帳 - SuperApp - Alibaba Cloud ドキュメントセンター

このトピックでは、WVContacts の JavaScript API について説明します。 HTML5 アプリまたはミニアプリを作成する際に、このトピックを参照できます。 WVContacts の JavaScript API は、アドレス帳に関連する機能を提供します。

WVContacts.askAuth

説明

この API は WindVane iOS でのみ使用できます。

アドレス帳へのアクセスをリクエストします。

入力パラメーター

入力パラメーターはありません。

コールバックパラメーター

コールバックパラメーターはコールバックメソッドに渡されます。使用している iOS のバージョンが iOS 6 より前の場合、アドレス帳へのアクセスをリクエストする必要はなく、コールバックは呼び出されません。使用している iOS のバージョンが iOS 6 以降の場合、success コールバックが常に呼び出されます。

[int]isAuthed: アプリがアドレス帳にアクセスできるかどうかを示します。有効な値：0 および 1。

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

WVContacts.authStatus

アドレス帳の現在のアクセス状態を取得します。

入力パラメーター

入力パラメーターはありません。

コールバックパラメーター

コールバックパラメーターはコールバックメソッドに渡されます。この API は常に success コールバックを呼び出します。

[boolean]isAuthed: アプリがアドレス帳にアクセスできるかどうかを示します。有効な値：0 および 1。
[int]status: 特定のアクセス状態。このパラメーターは WindVane iOS でのみ使用できます。有効な値：
- 0: 未決定。
- 1: 制限付き。
- 2: 拒否。
- 3: 承認済み。

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

WVContacts.choose

アドレス帳の連絡先を表示します。ユーザーが連絡先を選択すると、連絡先の名前と電話番号が関連する HTML5 ページに返されます。

入力パラメーター

入力パラメーターはありません。

コールバックパラメーター

コールバックパラメーターはコールバックメソッドに渡されます。ユーザーが連絡先を選択すると、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 プロパティの値を含む連絡先、または電話番号が phone プロパティの値を含む連絡先が返されます。

コールバックパラメーター

コールバックパラメーターはコールバックメソッドに渡されます。この API は常に success コールバックを呼び出します。

[array]contacts: フィルター条件を満たす連絡先のリスト。配列の各項目には、次のプロパティが含まれています。
- [string]name: フィルター条件を満たす連絡先の名前。
- [string]phone: フィルター条件を満たす連絡先の電話番号。

var params = {
        // 連絡先フィルター
        filter: {
                // 指定された名前の連絡先を検索します。
                name: 'Jack',
                // 指定された電話番号の連絡先を検索します。
                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))
});