このドキュメントでは、H5 アプリケーションおよびミニプログラムで連絡先の権限を管理するメソッドを提供する WVContacts JS API について説明します。
WVContacts.askAuth
この API は WindVane for iOS でのみ利用可能です。
このメソッドは、デバイスの連絡先へのアクセス権限をリクエストします。
パラメーター
このメソッドにはパラメーターはありません。
コールバックパラメーター
デバイスが iOS 6 より前のバージョンを実行している場合、このメソッドは権限をリクエストせず、コールバックもトリガーされません。それ以外の場合、success コールバックは常に権限付与ステータスとともにトリガーされます。
[
int] isAuthed: 連絡先へのアクセス権限が付与されたかどうかを指定します。0は権限が付与されていないこと、1は権限が付与されたことを示します。
window.WindVane.call('WVContacts', 'askAuth', {}, function(e) {
alert(JSON.stringify(e));
});
WVContacts.authStatus
このメソッドは、連絡先へのアクセスの現在の権限ステータスを取得します。
パラメーター
このメソッドにはパラメーターはありません。
コールバックパラメーター
コールバックパラメーターはコールバックメソッドに渡されます。success コールバックは常にトリガーされます。
[
int] isAuthed: 連絡先へのアクセス権限が付与されているかどうかを指定します。0は権限が付与されていないこと、1は権限が付与されたことを示します。[
int] status: (iOS のみ) iOS でのより詳細な権限ステータスを提供します：0：未決定。1：制限付き。2：拒否。3：承認済み。
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 の両方が指定された場合、検索は論理 AND 演算を実行し、両方の基準を満たす連絡先のみを照合します。連絡先に複数の電話番号がある場合、一致する各番号は結果リスト内でその連絡先の個別のエントリとして表示されます。
iOS では、このメソッドは部分一致を実行し、名前に name 文字列が含まれる連絡先を検索します。同じロジックが電話番号にも適用されます。
コールバックパラメーター
コールバックパラメーターはコールバックメソッドに渡されます。success コールバックは常にトリガーされます。
[
array] contacts: フィルター基準に一致する連絡先のリスト。配列内の各項目には、次のプロパティが含まれます：[
string] name: 連絡先の名前。[
string] phone: 連絡先の電話番号。
var params = {
// 連絡先フィルター。
filter: {
// 指定された名前の連絡先を検索します。
name: 'John',
// 指定された電話番号の連絡先を検索します。
phone: '123456'
}
}
window.WindVane.call('WVContacts', 'find', params, function(e) {
alert(JSON.stringify(e));
});
WVContacts.addPhoneContact
この API は WindVane for 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('失敗: ' + JSON.stringify(e))
});