harmony 鸿蒙@ohos.contact (联系人)

2022-08-09 浏览 (993)

@ohos.contact (联系人)

本模块提供联系人管理能力，包括添加联系人、删除联系人、更新联系人等

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import contact from '@ohos.contact';

contact.addContact10+

addContact(context: Context, contact: Contact, callback: AsyncCallback<number>): void

添加联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
contactContact是联系人信息。
callbackAsyncCallback<number>是回调函数，返回添加的联系人id。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.addContact(
    globalThis.context as Context,
    {name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
    }, (err, data) => {
      if (err) {
        console.log(`addContact callback: err->${JSON.stringify(err)}`);
        return;
      }
      console.log(`addContact callback: success data->${JSON.stringify(data)}`);
  });

contact.addContact(deprecated)7+

addContact(contact:Contact, callback:AsyncCallback<number>): void

添加联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用addContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contactContact是联系人信息。
callbackAsyncCallback<number>是回调函数，返回添加的联系人id。

示例：

// 当前示例代码仅适用于js源文件
contact.addContact({
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err, data) => {
    if (err) {
        console.log(`addContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`addContact callback: success data->${JSON.stringify(data)}`);
});

contact.addContact10+

addContact(context: Context, contact: Contact): Promise<number>

添加联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
contactContact是联系人信息。

返回值：

类型说明
Promise<number>以Promise形式返回结果，返回添加的联系人id。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.addContact(
    globalThis.context as Context,
    {name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  });
  promise.then((data) => {
    console.log(`addContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
    console.error(`addContact fail: err->${JSON.stringify(err)}`);
  });

contact.addContact(deprecated)7+

addContact(contact: Contact): Promise<number>

添加联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用addContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contactContact是联系人信息。

返回值：

类型说明
Promise<number>以Promise形式返回结果，返回添加的联系人id。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.addContact({
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
});
promise.then((data) => {
    console.log(`addContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`addContact fail: err->${JSON.stringify(err)}`);
});

contact.deleteContact10+

deleteContact(context: Context, key: string, callback: AsyncCallback<void>): void

删除联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人key值，一个联系人对应一个key。
callbackAsyncCallback<void>是异步删除联系人之后的回调。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }  
  contact.deleteContact(globalThis.context as Context, 'xxx', (err) => {
      if (err) {
          console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log('deleteContact success');
  });

contact.deleteContact(deprecated)7+

deleteContact(key: string, callback: AsyncCallback<void>): void

删除联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用deleteContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人key值，一个联系人对应一个key。
callbackAsyncCallback<void>是异步删除联系人之后的回调。

示例：

// 当前示例代码仅适用于js源文件
contact.deleteContact('xxx', (err) => {
    if (err) {
        console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('deleteContact success');
});

contact.deleteContact10+

deleteContact(context: Context, key: string): Promise<void>

删除联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。

返回值：

类型说明
Promise<void>返回一个Promise对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.deleteContact(globalThis.context as Context, 'xxx');
promise.then(() => {
    console.log(`deleteContact success`);
}).catch((err) => {
    console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
});

contact.deleteContact(deprecated)7+

deleteContact(key: string): Promise<void>

删除联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用deleteContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。

返回值：

类型说明
Promise<void>返回一个Promise对象。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.deleteContact('xxx');
promise.then(() => {
    console.log(`deleteContact success`);
}).catch((err) => {
    console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
});

contact.updateContact10+

updateContact(context: Context, contact: Contact, callback: AsyncCallback<void>): void

更新联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
contactContact是联系人信息。
callbackAsyncCallback<void>是异步更新联系人之后的回调。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.updateContact(globalThis.context as Context, {
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact(deprecated)7+

updateContact(contact: Contact, callback: AsyncCallback<void>): void

更新联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contactContact是联系人信息。
callbackAsyncCallback<void>是异步更新联系人之后的回调。

示例：

// 当前示例代码仅适用于js源文件
contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact10+

updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void

更新联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
contactContact是联系人信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<void>是异步更新联系人之后的回调。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.updateContact(globalThis.context as Context, {
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact(deprecated)7+

updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void

更新联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contactContact是联系人信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<void>是异步更新联系人之后的回调。

示例：

// 当前示例代码仅适用于js源文件
contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact10+

updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise<void>

更新联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
contactContact是联系人信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<void>返回一个Promise对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.updateContact(globalThis.context as Context, {
      id: 1,
      name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then(() => {
      console.log('updateContact success');
  }).catch((err) => {
      console.error(`updateContact fail: err->${JSON.stringify(err)}`);
  });

contact.updateContact(deprecated)7+

updateContact(contact: Contact, attrs?: ContactAttributes): Promise<void>

更新联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contactContact是联系人信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<void>返回一个Promise对象。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then(() => {
    console.log('updateContact success');
}).catch((err) => {
    console.error(`updateContact fail: err->${JSON.stringify(err)}`);
});

contact.isLocalContact10+

isLocalContact(context: Context, id: number, callback: AsyncCallback<boolean>): void

判断当前联系人id是否在电话簿中，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性，一个联系人对应一个id。
callbackAsyncCallback<boolean>是回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.isLocalContact(globalThis.context as Context, /*id*/1, (err, data) => {
    if (err) {
        console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
});

contact.isLocalContact(deprecated)7+

isLocalContact(id: number, callback: AsyncCallback<boolean>): void

判断当前联系人id是否在电话簿中，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isLocalContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性，一个联系人对应一个id。
callbackAsyncCallback<boolean>是回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

示例：

// 当前示例代码仅适用于js源文件
contact.isLocalContact(/*id*/1, (err, data) => {
    if (err) {
        console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
});

contact.isLocalContact10+

isLocalContact(context: Context, id: number): Promise<boolean>

判断当前联系人id是否在电话簿中，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性，一个联系人对应一个id。

返回值：

类型说明
Promise<boolean>以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.isLocalContact(globalThis.context as Context, /*id*/1);
  promise.then((data) => {
      console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
  });

contact.isLocalContact(deprecated)7+

isLocalContact(id: number): Promise<boolean>

判断当前联系人id是否在电话簿中，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isLocalContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性，一个联系人对应一个id。

返回值：

类型说明
Promise<boolean>以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.isLocalContact(/*id*/1);
promise.then((data) => {
    console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
});

contact.isMyCard10+

isMyCard(context: Context, id: number, callback: AsyncCallback<boolean>): void

判断是否为“我的名片”，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性。
callbackAsyncCallback<boolean>是回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.isMyCard(globalThis.context as Context, /*id*/1, (err, data) => {
      if (err) {
          console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.isMyCard(deprecated)7+

isMyCard(id: number, callback: AsyncCallback<boolean>): void

判断是否为“我的名片”，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性。
callbackAsyncCallback<boolean>是回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

示例：

// 当前示例代码仅适用于js源文件
contact.isMyCard(/*id*/1, (err, data) => {
    if (err) {
        console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.isMyCard10+

isMyCard(context: Context, id: number): Promise<boolean>

判断是否为“我的名片”，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性。

返回值：

类型说明
Promise<boolean>以Promise形式返回结果，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.isMyCard(globalThis.context as Context, /*id*/1);
  promise.then((data) => {
      console.log(`isMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
  });

contact.isMyCard(deprecated)7+

isMyCard(id: number): Promise<boolean>

判断是否为“我的名片”，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性。

返回值：

类型说明
Promise<boolean>以Promise形式返回结果，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.isMyCard(/*id*/1);
promise.then((data) => {
    console.log(`isMyCard success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
});

contact.queryMyCard10+

queryMyCard(context: Context, callback: AsyncCallback<Contact>): void

查询“我的名片”，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
callbackAsyncCallback<Contact>是回调函数，返回“我的名片”信息。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryMyCard(globalThis.context as Context, (err, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.queryMyCard(deprecated)7+

queryMyCard(callback: AsyncCallback<Contact>): void

查询“我的名片”，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
callbackAsyncCallback<Contact>是回调函数，返回“我的名片”信息。

示例：

// 当前示例代码仅适用于js源文件
contact.queryMyCard((err, data) => {
    if (err) {
        console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.queryMyCard10+

queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

查询“我的名片”，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回“我的名片”信息。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryMyCard(globalThis.context as Context, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.queryMyCard(deprecated)7+

queryMyCard(attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

查询“我的名片”，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回“我的名片”信息。

示例：

// 当前示例代码仅适用于js源文件
contact.queryMyCard({
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.queryMyCard10+

queryMyCard(context: Context, attrs?: ContactAttributes): Promise<Contact>

查询“我的名片”，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Contact>以Promise形式返回结果，返回“我的名片”信息。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.queryMyCard(globalThis.context as Context, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then((data) => {
      console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
  });

contact.queryMyCard(deprecated)7+

queryMyCard(attrs?: ContactAttributes): Promise<Contact>

查询“我的名片”，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Contact>以Promise形式返回结果，返回“我的名片”信息。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryMyCard({
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
});

contact.selectContact(deprecated)7+

selectContact(callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用selectContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.Contacts

参数：

参数名类型必填说明
callbackAsyncCallback<Array<Contact>>是回调函数，返回选择的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.selectContact((err, data) => {
    if (err) {
        console.log(`selectContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
});

contact.selectContact(deprecated)7+

selectContact(): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用selectContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.Contacts

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回选择的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.selectContact();
promise.then((data) => {
    console.log(`selectContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});

contact.selectContacts10+

selectContacts(callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

参数：

参数名类型必填说明
callbackAsyncCallback<Array<Contact>>是回调函数，返回选择的联系人对象数组。

错误码：

错误码ID错误信息
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
contact.selectContacts((err, data) => {
    if (err) {
        console.log(`selectContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
});

contact.selectContacts10+

selectContacts(): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回选择的联系人对象数组。

错误码：

错误码ID错误信息
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.selectContacts();
promise.then((data) => {
    console.log(`selectContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});

contact.selectContacts10+

selectContacts(options: ContactSelectionOptions, callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

参数：

参数名类型必填说明
optionsContactSelectionOptions是选择联系人时的筛选条件
callbackAsyncCallback<Array<Contact>>是回调函数，返回选择的联系人对象数组。

错误码：

错误码ID错误信息
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
contact.selectContacts({
  isMultiSelect:false
}, (err, data) => {
    if (err) {
        console.log(`selectContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
});

contact.selectContacts10+

selectContacts(options: ContactSelectionOptions): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

返回值：

类型说明
optionsContactSelectionOptions
Promise<Array<Contact>>以Promise形式返回结果，返回选择的联系人对象数组。

错误码：

错误码ID错误信息
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.selectContacts({isMultiSelect:false});
promise.then((data) => {
    console.log(`selectContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});

contact.queryContact10+

queryContact(context: Context, key: string, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContact(globalThis.context as Context, 'xxx', (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)7+

queryContact(key: string, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContact('xxx', (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact10+

queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContact(globalThis.context as Context, 'xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)7+

queryContact(key: string, holder: Holder, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContact('xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact10+

queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContact(globalThis.context as Context, 'xxx', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)7+

queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContact('xxx', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact10+

queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

  // 当前示例代码仅适用于js源文件
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryContact(globalThis.context as Context, 'xxx', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });

contact.queryContact(deprecated)7+

queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

根据key查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Contact>是回调函数，返回查询的联系人对象。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContact('xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact10+

queryContact(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>

根据key查询联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
keystring是联系人的key值，一个联系人对应一个key。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Contact>以Promise形式返回结果，返回查询到的联系人对象。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryContact(globalThis.context as Context, 'xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContact fail: err->${JSON.stringify(err)}`);
});

contact.queryContact(deprecated)7+

queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>

根据key查询联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
keystring是联系人的key值，一个联系人对应一个key。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Contact>以Promise形式返回结果，返回查询到的联系人对象。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryContact('xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContact fail: err->${JSON.stringify(err)}`);
});

contact.queryContacts10+

queryContacts(context: Context, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContacts(globalThis.context as Context, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)7+

queryContacts(callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContacts((err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts10+

queryContacts(context: Context, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContacts(globalThis.context as Context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)7+

queryContacts(holder: Holder, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContacts({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts10+

queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContacts(globalThis.context as Context, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)7+

queryContacts(attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContacts({
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts10+

queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContacts(globalThis.context as Context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)7+

queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

查询所有联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContacts({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts10+

queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

查询所有联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryContacts(globalThis.context as Context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContacts success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
});

contact.queryContacts(deprecated)7+

queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

查询所有联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

  // 当前示例代码仅适用于js源文件
  let promise = contact.queryContacts({
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then((data) => {
      console.log(`queryContacts success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
  });

contact.queryContactsByPhoneNumber10+

queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
phoneNumberstring是联系人的电话号码。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)7+

queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
phoneNumberstring是联系人的电话号码。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber10+

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
phoneNumberstring是联系人的电话号码。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)7+

queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
phoneNumberstring是联系人的电话号码。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber10+

queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
phoneNumberstring是联系人的电话号码。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)7+

queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
phoneNumberstring是联系人的电话号码。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber10+

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
phoneNumberstring是联系人的电话号码。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)7+

queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据电话号码查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
phoneNumberstring是联系人的电话号码。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber10+

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

根据电话号码查询联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
phoneNumberstring是联系人的电话号码。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByPhoneNumber(deprecated)7+

queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

根据电话号码查询联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
phoneNumberstring是联系人的电话号码。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByEmail10+

queryContactsByEmail(context: Context, email: string, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
emailstring是联系人的邮箱地址。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)7+

queryContactsByEmail(email: string, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
emailstring是联系人的邮箱地址。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByEmail('xxx@email.com', (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail10+

queryContactsByEmail(context: Context, email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
emailstring是联系人的邮箱地址。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)7+

queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
emailstring是联系人的邮箱地址。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByEmail('xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail10+

queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
emailstring是联系人的邮箱地址。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)7+

queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
emailstring是联系人的邮箱地址。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByEmail('xxx@email.com', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail10+

queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
emailstring是联系人的邮箱地址。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)7+

queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

根据email查询联系人，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
emailstring是联系人的邮箱地址。
holderHolder是创建联系人的应用信息。
attrsContactAttributes是联系人的属性列表。
callbackAsyncCallback<Array<Contact>>是回调函数，返回查询到联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryContactsByEmail('xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail10+

queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

根据email查询联系人，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
emailstring是联系人的邮箱地址。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByEmail(deprecated)7+

queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

根据email查询联系人，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
emailstring是联系人的邮箱地址。
holderHolder否创建联系人的应用信息。
attrsContactAttributes否联系人的属性列表。

返回值：

类型说明
Promise<Array<Contact>>以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryContactsByEmail('xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});

contact.queryGroups10+

queryGroups(context: Context, callback: AsyncCallback<Array<Group>>): void

查询联系人的所有群组，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
callbackAsyncCallback<Array<Group>>是回调函数，返回查询到的群组对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryGroups(globalThis.context as Context, (err, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups(deprecated)7+

queryGroups(callback: AsyncCallback<Array<Group>>): void

查询联系人的所有群组，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
callbackAsyncCallback<Array<Group>>是回调函数，返回查询到的群组对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryGroups((err, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups10+

queryGroups(context: Context, holder: Holder, callback: AsyncCallback<Array<Group>>): void

查询联系人的所有群组，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Group>>是回调函数，返回查询到的群组对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryGroups(globalThis.context as Context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups(deprecated)7+

queryGroups(holder: Holder, callback: AsyncCallback<Array<Group>>): void

查询联系人的所有群组，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<Array<Group>>是回调函数，返回查询到的群组对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryGroups({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups10+

queryGroups(context: Context, holder?: Holder): Promise<Array<Group>>

查询联系人的所有群组，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
holderHolder否创建联系人的应用信息。

返回值：

类型说明
Promise<Array<Group>>以Promise形式返回结果，返回查询到的群组对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryGroups(globalThis.context as Context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});

contact.queryGroups(deprecated)7+

queryGroups(holder?: Holder): Promise<Array<Group>>

查询联系人的所有群组，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
holderHolder否创建联系人的应用信息。

返回值：

类型说明
Promise<Array<Group>>以Promise形式返回结果，返回查询到的群组对象数组。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryGroups({
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});

contact.queryHolders10+

queryHolders(context: Context, callback: AsyncCallback<Array<Holder>>): void

查询所有创建联系人的应用信息，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
callbackAsyncCallback<Array<Holder>>是回调函数，返回查询到的创建联系人应用信息的对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryHolders(globalThis.context as Context, (err, data) => {
    if (err) {
        console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});

contact.queryHolders(deprecated)7+

queryHolders(callback: AsyncCallback<Array<Holder>>): void

查询所有创建联系人的应用信息，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryHolders

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
callbackAsyncCallback<Array<Holder>>是回调函数，返回查询到的创建联系人应用信息的对象数组。

示例：

// 当前示例代码仅适用于js源文件
contact.queryHolders((err, data) => {
    if (err) {
        console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});

contact.queryHolders10+

queryHolders(context: Context): Promise<Array<Holder>>

查询所有创建联系人的应用信息，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。

返回值：

类型说明
Promise<Array<Holder>>以Promise形式返回结果，返回查询到的创建联系人应用信息的对象数组。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryHolders(globalThis.context as Context);
promise.then((data) => {
    console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});

contact.queryHolders(deprecated)7+

queryHolders(): Promise<Array<Holder>>

查询所有创建联系人的应用信息，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryHolders

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

返回值：

类型说明
Promise<Array<Holder>>以Promise形式返回结果，返回查询到的创建联系人应用信息的对象数组。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryHolders();
promise.then((data) => {
    console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});

contact.queryKey10+

queryKey(context: Context, id: number, callback: AsyncCallback<string>): void

根据联系人的id查询联系人的key，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性。
callbackAsyncCallback<string>是回调函数，返回查询到的联系人对应的key。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryKey(globalThis.context as Context, /*id*/1, (err, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey(deprecated)7+

queryKey(id: number, callback: AsyncCallback<string>): void

根据联系人的id查询联系人的key，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性。
callbackAsyncCallback<string>是回调函数，返回查询到的联系人对应的key。

示例：

// 当前示例代码仅适用于js源文件
contact.queryKey(/*id*/1, (err, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey10+

queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback<string>): void

根据联系人的id查询联系人的key，使用callback方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<string>是回调函数，返回查询到的联系人对应的key。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.queryKey(globalThis.context as Context, /*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey(deprecated)7+

queryKey(id: number, holder: Holder, callback: AsyncCallback<string>): void

根据联系人的id查询联系人的key，使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性。
holderHolder是创建联系人的应用信息。
callbackAsyncCallback<string>是回调函数，返回查询到的联系人对应的key。

示例：

// 当前示例代码仅适用于js源文件
contact.queryKey(/*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey10+

queryKey(context: Context, id: number, holder?: Holder): Promise<string>

根据联系人的id查询联系人的key，使用Promise方式作为异步方法。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
contextContext是应用上下文Context，Stage模型的应用Context定义见Context。
idnumber是联系人对象的id属性。
holderHolder否创建联系人的应用信息。

返回值：

类型说明
Promise<string>以Promise形式返回结果，返回查询到的联系人对应的key。

错误码：

错误码ID错误信息
201Permission denied.
401Parameter error.

示例：

// 当前示例代码仅适用于js源文件
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
let promise = contact.queryKey(globalThis.context as Context, /*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryKey success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryKey fail: err->${JSON.stringify(err)}`);
});

contact.queryKey(deprecated)7+

queryKey(id: number, holder?: Holder): Promise<string>

根据联系人的id查询联系人的key，使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名类型必填说明
idnumber是联系人对象的id属性。
holderHolder否创建联系人的应用信息。

返回值：

类型说明
Promise<string>以Promise形式返回结果，返回查询到的联系人对应的key。

示例：

// 当前示例代码仅适用于js源文件
let promise = contact.queryKey(/*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryKey success: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`queryKey fail: err->${JSON.stringify(err)}`);
});

ContactSelectionOptions10+

选择联系人条件。

系统能力：SystemCapability.Applications.Contacts

名称类型必填说明
isMultiSelect 10+boolean否是否为多选

Contact

联系人对象类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
INVALID_CONTACT_ID-1默认联系人的id。

属性

名称类型可读可写说明
idnumber是否联系人的id。
keystring是否联系人的key。
contactAttributesContactAttributes是是联系人的属性列表。
emailsEmail[]是是联系人的邮箱地址列表。
eventsEvent[]是是联系人的生日、周年纪念等重要日期列表。
groupsGroup[]是是联系人的群组列表。
imAddressesImAddress[]是是联系人的即时消息地址列表。
phoneNumbersPhoneNumber[]是是联系人的电话号码列表。
portraitPortrait是是联系人的头像。
postalAddressesPostalAddress[]是是联系人的邮政地址列表。
relationsRelation[]是是联系人的关系列表。
sipAddressesSipAddress[]是是联系人的会话发起协议（SIP）地址列表。
websitesWebsite[]是是联系人的网站列表。
nameName是是联系人的姓名。
nickNameNickName是是联系人的昵称。
noteNote是是联系人的备注。
organizationOrganization是是联系人的组织信息。

对象创建示例：

使用JSON格式创建联系人数据：

// 当前示例代码仅适用于js源文件
let myContact = {
    phoneNumbers: [{
        phoneNumber: "138xxxxxxxx"
    }],
    name: {
        fullName: "fullName",
        namePrefix: "namePrefix"
    },
    nickName: {
        nickName: "nickName"
    }
};

或使用new一个Contact对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let myContact = new contact.Contact();
let name = new contact.Name();
name.fullName = "fullName";
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
myContact.name = name;
myContact.phoneNumbers = [phoneNumber];

ContactAttributes

联系人属性列表，一般作为入参用来标识希望查询的联系人属性。 当传入为null时，默认查询全部属性。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
attributesAttribute[]是是联系人属性列表。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let contactAttributes = {
    attributes: [
        contact.Attribute.ATTR_EMAIL,
        contact.Attribute.ATTR_NAME,
        contact.Attribute.ATTR_PHONE
    ]
};

或使用new一个ContactAttributes对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let contactAttributes = new contact.ContactAttributes();
contactAttributes.attributes = [contact.Attribute.ATTR_EMAIL];

Attribute

枚举，联系人属性列表。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称说明
ATTR_CONTACT_EVENT联系人的生日、周年纪念等重要日期。
ATTR_EMAIL联系人的邮箱地址。
ATTR_GROUP_MEMBERSHIP联系人的群组。
ATTR_IM联系人的即时消息地址。
ATTR_NAME联系人的姓名。
ATTR_NICKNAME联系人的昵称。
ATTR_NOTE联系人的备注。
ATTR_ORGANIZATION联系人的组织信息。
ATTR_PHONE联系人的电话号码。
ATTR_PORTRAIT联系人的头像。
ATTR_POSTAL_ADDRESS联系人的邮政地址。
ATTR_RELATION联系人的关系。
ATTR_SIP_ADDRESS联系人的会话发起协议（SIP）地址。
ATTR_WEBSITE联系人的网站。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let attributes = [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE];

Email

联系人的邮箱。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义邮箱类型。
EMAIL_HOME1家庭邮箱类型。
EMAIL_WORK2工作邮箱类型。
EMAIL_OTHER3其它邮箱类型。
INVALID_LABEL_ID-1无效邮箱类型。

属性

名称类型可读可写说明
emailstring是是邮箱地址。
labelNamestring是是邮箱的类型名称。
displayNamestring是是邮箱的显示名称。
labelIdnumber是是邮箱的类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let email = {
    email: "xxx@email.com",
    displayName: "displayName"
}

或使用new一个Email对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let email = new contact.Email();
email.email = "xxx@email.com";

Holder

创建联系人的应用信息类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
bundleNamestring是否Bundle名称。
displayNamestring是否应用名称。
holderIdnumber是是应用ID。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let holder = {
  holderId: 0
};

或使用new一个Holder对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let holder = new contact.Holder();
holder.holderId = 0;

Event

联系人事件类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义事件类型。
EVENT_ANNIVERSARY1周年纪念事件类型。
EVENT_OTHER2其它事件类型。
EVENT_BIRTHDAY3生日事件类型。
INVALID_LABEL_ID-1无效事件类型。

属性

名称类型可读可写说明
eventDatestring是是事件的日期。
labelNamestring是是事件类型名称。
labelIdnumber是是事件类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let event = {
    eventDate: "xxxxxx"
};

或使用new一个Event对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let event = new contact.Event();
event.eventDate = "xxxxxx";

Group

联系人的群组类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
groupIdnumber是是联系人群组的id。
titlestring是是联系人群组的名称。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let group = {
    groupId: 1,
    title: "title"
};

或使用new一个Group对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let group = new contact.Group();
group.title = "title";

ImAddress

联系人的即时消息地址。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL-1自定义即时消息类型。
IM_AIM0AIM即时消息类型。
IM_MSN1MSN即时消息类型。
IM_YAHOO2YAHOO即时消息类型。
IM_SKYPE3SKYPE即时消息类型。
IM_QQ4QQ即时消息类型。
IM_ICQ6ICQ即时消息类型。
IM_JABBER7JABBER即时消息类型。
INVALID_LABEL_ID-2无效的即时消息类型。

属性

名称类型可读可写说明
imAddressstring是是即时消息地址。
labelNamestring是是即时消息类型名称。
labelIdnumber是是即时消息类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let imAddress = {
    imAddress: "imAddress",
    labelName: "labelName"
};

或使用new一个ImAddress对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let imAddress = new contact.ImAddress();
imAddress.imAddress = "imAddress";

Name

联系人的名字类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
familyNamestring是是联系人的家庭姓名。
familyNamePhoneticstring是是联系人的家庭姓名拼音。
fullNamestring是是联系人的全名。
givenNamestring是是联系人的名称（firstName）。
givenNamePhoneticstring是是联系人的名称拼音。
middleNamestring是是联系人的中间名。
middleNamePhoneticstring是是联系人的中间名拼音。
namePrefixstring是是联系人的姓名前缀。
nameSuffixstring是是联系人的姓名后缀。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let name = {
    familyName: "familyName",
    fullName: "fullName"
};

或使用new一个name对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let name = new contact.Name();
name.familyName = "familyName";
name.fullName = "fullName";

NickName

联系人的昵称类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
nickNamestring是是联系人的昵称。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let nickName = {
    nickName: "nickName"
};

或使用new一个NickName对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let nickName = new contact.NickName();
nickName.nickName = "nickName";

Note

联系人的备注类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
noteContentstring是是联系人的备注内容。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let note = {
    noteContent: "noteContent"
};

或使用new一个Note对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let note = new contact.Note();
note.noteContent = "noteContent";

Organization

联系人的组织类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
namestring是是组织名称。
titlestring是是组织标题。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let organization = {
    name: "name",
    title: "title"
};

或使用new一个Organization对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let organization = new contact.Organization();
organization.name = "name";
organization.title = "title";

PhoneNumber

联系人电话号码类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义电话类型。
NUM_HOME1家庭电话类型。
NUM_MOBILE2移动电话类型。
NUM_WORK3工作电话类型。
NUM_FAX_WORK4工作传真电话类型。
NUM_FAX_HOME5家庭传真电话类型。
NUM_PAGER6寻呼机电话类型。
NUM_OTHER7其它电话类型。
NUM_CALLBACK8回呼电话类型。
NUM_CAR9车机电话类型。
NUM_COMPANY_MAIN10公司电话类型。
NUM_ISDN11综合业务数字网（ISDN）电话类型。
NUM_MAIN12主电话类型。
NUM_OTHER_FAX13其它传真类型。
NUM_RADIO14无线电话类型。
NUM_TELEX15电传电话类型。
NUM_TTY_TDD16电传打字机（TTY）或测试驱动开发（TDD）电话类型。
NUM_WORK_MOBILE17工作移动电话类型。
NUM_WORK_PAGER18工作寻呼机电话类型。
NUM_ASSISTANT19助理电话类型。
NUM_MMS20彩信电话类型。
INVALID_LABEL_ID-1无效电话类型。

属性

名称类型可读可写说明
labelNamestring是是电话号码类型名称。
phoneNumberstring是是电话号码。
labelIdnumber是是电话号码类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let phoneNumber = {
    phoneNumber: "138xxxxxxxx",
    labelId: contact.PhoneNumber.NUM_HOME
};

或使用new一个PhoneNumber对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";

Portrait

联系人的头像类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
uristring是是联系人的头像。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let portrait = {
    uri: "uri"
};

或使用new一个Portrait对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let portrait = new contact.Portrait();
portrait.uri = "uri";

PostalAddress

联系人的邮政地址类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义邮政地址类型。
ADDR_HOME1家庭地址类型。
ADDR_WORK2工作地址类型。
ADDR_OTHER3其它地址类型。
INVALID_LABEL_ID-1无效地址类型。

属性

名称类型可读可写说明
citystring是是联系人所在的城市。
countrystring是是联系人所在的国家。
labelNamestring是是邮政地址类型名称。
neighborhoodstring是是联系人的邻居。
poboxstring是是联系人的邮箱。
postalAddressstring是是联系人的邮政地址。
postcodestring是是联系人所在区域的邮政编码。
regionstring是是联系人所在的区域。
streetstring是是联系人所在的街道。
labelIdnumber是是邮政地址类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let postalAddress = {
    city: "city"
};

或使用new一个PostalAddress对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let postalAddress = new contact.PostalAddress();
postalAddress.city = "city";

Relation

联系人的关系类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义关系类型。
RELATION_ASSISTANT1助手关系类型。
RELATION_BROTHER2兄弟关系类型。
RELATION_CHILD3子女关系类型。
RELATION_DOMESTIC_PARTNER4同居同伴关系类型。
RELATION_FATHER5父亲关系类型。
RELATION_FRIEND6朋友关系类型。
RELATION_MANAGER7管理者关系类型。
RELATION_MOTHER8母亲关系类型。
RELATION_PARENT9父母关系类型。
RELATION_PARTNER10合作伙伴关系类型。
RELATION_REFERRED_BY11推荐人关系类型。
RELATION_RELATIVE12亲属关系类型。
RELATION_SISTER13姐妹关系类型。
RELATION_SPOUSE14配偶关系类型。
INVALID_LABEL_ID-1无效的关系类型。

属性

名称类型可读可写说明
labelNamestring是是关系类型名称。
relationNamestring是是关系名称。
labelIdnumber是是关系类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let relation = {
    relationName: "relationName",
    labelId: contact.Relation.RELATION_ASSISTANT
};

或使用new一个Relation对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let relation = new contact.Relation();
relation.relationName = "relationName";
relation.labelId = contact.Relation.RELATION_ASSISTANT;

SipAddress

联系人的会话发起协议（SIP）地址类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

常量

名称值说明
CUSTOM_LABEL0自定义会话发起协议（SIP）地址类型。
SIP_HOME1家庭会话发起协议（SIP）地址类型。
SIP_WORK2工作会话发起协议（SIP）地址类型。
SIP_OTHER3其它会话发起协议（SIP）地址类型。
INVALID_LABEL_ID-1无效会话发起协议（SIP）地址类型。

属性

名称类型可读可写说明
labelNamestring是是会话发起协议（SIP）地址类型名称。
sipAddressstring是是会话发起协议（SIP）地址。
labelIdnumber是是会话发起协议（SIP）地址类型。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
var sipAddress = {
    sipAddress: "sipAddress"
};

或使用new一个SipAddress对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let sipAddress = new contact.SipAddress();
sipAddress.sipAddress = "sipAddress";

Website

联系人的网站信息类。

系统能力：以下各项对应的系统能力均为SystemCapability.Applications.ContactsData。

名称类型可读可写说明
websitestring是是联系人的网站信息。

对象创建示例：

使用JSON格式创建数据：

// 当前示例代码仅适用于js源文件
let website = {
    website: "website"
};

或使用new一个Website对象的方式创建数据：

// 当前示例代码仅适用于js源文件
let website = new contact.Website();
website.website = "website";

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/301db67f8c9d4583a13680514f8dbd0c