# @ohos.contact (联系人)
本模块提供联系人管理能力，包括添加联系人、删除联系人、更新联系人等。
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import { contact } from '@kit.ContactsKit';
```
## contact.addContact10+
addContact(context: Context, contact: Contact, callback: AsyncCallback<number>): void
添加联系人，使用callback异步回调。
**原子化服务API**：从API version 12 开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| callback | AsyncCallback<number> | 是 | 回调函数。成功返回添加的联系人id；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.addContact(context, {
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to add Contact. Code:${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in adding Contact. data: ${JSON.stringify(data)}`);
});
```
## contact.addContact(deprecated)7+
addContact(contact: Contact, callback: AsyncCallback<number>): void
添加联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[addContact](#contactaddcontact10)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------------------------------- |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| callback | AsyncCallback<number> | 是 | 回调函数。成功返回添加的联系人id；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.addContact(context, {
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to add Contact. Code:${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in adding Contact. data: ${JSON.stringify(data)}`);
});
```
## contact.addContact10+
addContact(context: Context, contact: Contact): Promise**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.addContact(context, {
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
});
promise.then((data) => {
console.info(`Succeeded in adding Contact. data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to add Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.addContact(deprecated)7+
addContact(contact: Contact): Promise<number>
添加联系人，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[addContact](#contactaddcontact10-1)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | ------------ |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | --------------------------------- |
| Promise<number> | Promise对象，返回添加的联系人id。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.addContact({
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
});
promise.then((data) => {
console.info(`Succeeded in adding Contact. data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to add Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.deleteContact10+
deleteContact(context: Context, key: string, callback: AsyncCallback<void>): void
删除联系人，使用callback异步回调。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的唯一查询键key值，一个联系人对应一个key。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回删除的联系人id；失败返回失败的错误码。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.deleteContact(context, 'xxx', (err: BusinessError) => {
if (err) {
console.error(`Failed to delete Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in deleting Contact.');
});
```
## contact.deleteContact(deprecated)7+
deleteContact(key: string, callback: AsyncCallback<void>): void
删除联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[deleteContact](#contactdeletecontact10)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------ |
| key | string | 是 | 联系人的唯一查询键key值，一个联系人对应一个key。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回删除的联系人id；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.deleteContact('xxx', (err: BusinessError) => {
if (err) {
console.error(`Failed to delete Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in deleting Contact.');
});
```
## contact.deleteContact10+
deleteContact(context: Context, key: string): Promise<void>
删除联系人，使用Promise异步回调。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的唯一查询键key值，一个联系人对应一个key。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.deleteContact(context, 'xxx');
promise.then(() => {
console.info(`Succeeded in deleting Contact.`);
}).catch((err: BusinessError) => {
console.error(`Failed to delete Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.deleteContact(deprecated)7+
deleteContact(key: string): Promise<void>
删除联系人，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[deleteContact](#contactdeletecontact10-1)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- |
| key | string | 是 | 联系人的唯一查询键key值，一个联系人对应一个key。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.deleteContact('xxx');
promise.then(() => {
console.info(`Succeeded in deleting Contact.`);
}).catch((err: BusinessError) => {
console.error(`Failed to delete Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.updateContact10+
updateContact(context: Context, contact: Contact, callback: AsyncCallback<void>): void
更新联系人，使用callback异步回调。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回更新的联系人id；失败返回失败的错误码。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.updateContact(context, {
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, (err: BusinessError) => {
if (err) {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in updating Contact.');
});
```
## contact.updateContact(deprecated)7+
updateContact(contact: Contact, callback: AsyncCallback<void>): void
更新联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[updateContact](#contactupdatecontact10)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS和ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------ |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回更新的联系人id；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.updateContact(context, {
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, (err: BusinessError) => {
if (err) {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in updating Contact.');
});
```
## contact.updateContact10+
updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void
更新联系人，使用callback异步回调。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回更新的联系人id；失败返回失败的错误码。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.updateContact(context, {
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError) => {
if (err) {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in updating Contact.');
});
```
## contact.updateContact(deprecated)7+
updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void
更新联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[updateContact](#contactupdatecontact10-1)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS和ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------ |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。成功返回更新的联系人id；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.updateContact({
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError) => {
if (err) {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info('Succeeded in updating Contact.');
});
```
## contact.updateContact10+
updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise<void>
更新联系人，使用Promise异步回调。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.updateContact(context, {
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then(() => {
console.info('Succeeded in updating Contact.');
}).catch((err: BusinessError) => {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.updateContact(deprecated)7+
updateContact(contact: Contact, attrs?: ContactAttributes): Promise<void>
更新联系人，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[updateContact](#contactupdatecontact10-2)替代。
**需要权限**：ohos.permission.WRITE_CONTACTS和ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------ |
| contact | [Contact](#contact) | 是 | 联系人信息。id必填。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.updateContact({
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxxxx'
}]
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then(() => {
console.info('Succeeded in updating Contact.');
}).catch((err: BusinessError) => {
console.error(`Failed to update Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.isLocalContact10+
isLocalContact(context: Context, id: number, callback: AsyncCallback<boolean>): void
判断当前联系人id是否在电话簿中，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。成功返回布尔值，true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.isLocalContact(context, /*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to isLocalContact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in isLocalContact. data->${JSON.stringify(data)}`);
});
```
## contact.isLocalContact(deprecated)7+
isLocalContact(id: number, callback: AsyncCallback<boolean>): void
判断当前联系人id是否在电话簿中，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[isLocalContact](#contactislocalcontact10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。成功返回布尔值，true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.isLocalContact(/*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to isLocalContact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in isLocalContact. data->${JSON.stringify(data)}`);
});
```
## contact.isLocalContact10+
isLocalContact(context: Context, id: number): Promise<boolean>
判断当前联系人id是否在电话簿中，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise<boolean> | Promise对象。返回true表示联系人id在本地电话簿中，返回false表示联系人id不在本地电话簿中。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.isLocalContact(context, /*id*/1);
promise.then((data) => {
console.info(`Succeeded in isLocalContact. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to isLocalContact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.isLocalContact(deprecated)7+
isLocalContact(id: number): Promise<boolean>
判断当前联系人id是否在电话簿中，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[isLocalContact](#contactislocalcontact10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise<boolean> | Promise对象。返回true表示联系人id在本地电话簿中，返回false表示联系人id不在本地电话簿中。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.isLocalContact(/*id*/1);
promise.then((data) => {
console.info(`Succeeded in isLocalContact. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to isLocalContact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.isMyCard10+
isMyCard(context: Context, id: number, callback: AsyncCallback<boolean>): void
判断是否为“我的名片”，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 名片对象的id属性。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。成功返回是否为“我的名片”的布尔值。true代表的是“我的名片”，false则代表不是；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.isMyCard(context, /*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to isMyCard. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in isMyCard. data->${JSON.stringify(data)}`);
});
```
## contact.isMyCard(deprecated)7+
isMyCard(id: number, callback: AsyncCallback<boolean>): void
判断是否为“我的名片”，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[isMyCard](#contactismycard10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 名片对象的id属性。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。成功返回是否为“我的名片”的布尔值。true代表的是“我的名片”，false则代表不是；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.isMyCard(/*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to isMyCard. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in isMyCard. data->${JSON.stringify(data)}`);
});
```
## contact.isMyCard10+
isMyCard(context: Context, id: number): Promise<boolean>
判断是否为“我的名片”，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 名片对象的id属性。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ---------------------------------------------------------- |
| Promise<boolean> | Promise对象。返回true表示是“我的名片”，返回false表示不是。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.isMyCard(context, /*id*/1);
promise.then((data) => {
console.info(`Succeeded in isMyCard. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to isMyCard. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.isMyCard(deprecated)7+
isMyCard(id: number): Promise<boolean>
判断是否为“我的名片”，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[isMyCard](#contactismycard10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- |
| id | number | 是 | 名片对象的id属性。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ---------------------------------------------------------- |
| Promise<boolean> | Promise对象。返回true表示是“我的名片”，返回false表示不是。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.isMyCard(/*id*/1);
promise.then((data) => {
console.info(`Succeeded in isMyCard. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to isMyCard. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryMyCard10+
queryMyCard(context: Context, callback: AsyncCallback<Contact>): void
查询“我的名片”，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回“我的名片”信息；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryMyCard(context, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard(deprecated)7+
queryMyCard(callback: AsyncCallback<Contact>): void
查询“我的名片”，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------------------------- |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回“我的名片”信息；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryMyCard((err: BusinessError, data) => {
if (err) {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard10+
queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
查询“我的名片”，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回“我的名片”信息；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryMyCard(context, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard(deprecated)7+
queryMyCard(attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
查询“我的名片”，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------------------------- |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回“我的名片”信息；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryMyCard({
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard10+
queryMyCard(context: Context, attrs?: ContactAttributes): Promise<Contact>
查询“我的名片”，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | --------------------------------------- |
| Promise<[Contact](#contact)> | Promise对象。返回“我的名片”联系人对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryMyCard(context, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryMyCard(deprecated)7+
queryMyCard(attrs?: ContactAttributes): Promise<Contact>
查询“我的名片”，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ------------------ |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | --------------------------------------- |
| Promise<[Contact](#contact)> | Promise对象。返回“我的名片”联系人对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryMyCard({
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying My Card. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query My Card. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.selectContact(deprecated)7+
selectContact(callback: AsyncCallback<Array<Contact>>): void
调用选择联系人接口，打开选择联系人UI界面，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[selectContacts](#contactselectcontacts10)替代。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回选择的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.selectContact((err: BusinessError, data) => {
if (err) {
console.error(`Failed to select Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in selecting Contact. data->${JSON.stringify(data)}`);
});
```
## contact.selectContact(deprecated)7+
selectContact(): Promise<Array<Contact>>
调用选择联系人接口，打开选择联系人UI界面，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[selectContacts](#contactselectcontacts10-1)替代。
**系统能力**：SystemCapability.Applications.Contacts
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回选择的联系人数组对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.selectContact();
promise.then((data) => {
console.info(`Succeeded in selecting Contact. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to select Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.selectContacts10+
selectContacts(callback: AsyncCallback<Array<Contact>>): void
调用选择联系人接口，打开选择联系人UI界面，使用callback异步回调。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回选择的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.selectContacts((err: BusinessError, data) => {
if (err) {
console.error(`Failed to select Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in selecting Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.selectContacts10+
selectContacts(): Promise<Array<Contact>>
调用选择联系人接口，打开选择联系人UI界面，使用Promise异步回调。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回选择的联系人数组对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.selectContacts();
promise.then((data) => {
console.info(`Succeeded in selecting Contacts. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to select Contacts. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.selectContacts10+
selectContacts(options: ContactSelectionOptions, callback: AsyncCallback<Array<Contact>>): void
调用选择联系人接口，打开选择联系人UI界面，使用callback异步回调。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| options | [ContactSelectionOptions](#contactselectionoptions10) | 是 | 选择联系人时的筛选条件。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回选择的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.selectContacts({
isMultiSelect:false
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to select Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in selecting Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.selectContacts10+
selectContacts(options: ContactSelectionOptions): Promise<Array<Contact>>
调用选择联系人接口，打开选择联系人UI界面，使用Promise异步回调。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| options | [ContactSelectionOptions](#contactselectionoptions10) | 是 | 选择联系人时的筛选条件。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回选择的联系人数组对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.selectContacts({isMultiSelect:false});
promise.then((data) => {
console.info(`Succeeded in selecting Contacts. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to select Contacts. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContact10+
queryContact(context: Context, key: string, callback: AsyncCallback<Contact>): void
根据key查询联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContact(context, 'xxx', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact(deprecated)7+
queryContact(key: string, callback: AsyncCallback<Contact>): void
根据key查询联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContact](#contactquerycontact10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContact('xxx', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact10+
queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback<Contact>): void
根据key和holder查询联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContact(context, 'xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact(deprecated)7+
queryContact(key: string, holder: Holder, callback: AsyncCallback<Contact>): void
根据key和holder查询联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContact](#contactquerycontact10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContact('xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact10+
queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
根据key和attrs查询联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContact(context, 'xxx', {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact(deprecated)7+
queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
根据key和attrs查询联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContact](#contactquerycontact10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContact('xxx', {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact10+
queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
根据key、holder和attrs查询联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContact(context, 'xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact(deprecated)7+
queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void
根据key、holder和attrs查询联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContact](#contactquerycontact10-3)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<[Contact](#contact)> | 是 | 回调函数。成功返回查询的联系人对象；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContact('xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
});
```
## contact.queryContact10+
queryContact(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>
根据key、holder和attrs查询联系人，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ------------------------------------- |
| Promise<[Contact](#contact)> | Promise对象。返回查询到的联系人对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryContact(context, 'xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContact(deprecated)7+
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>
根据key、holder和attrs查询联系人，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContact](#contactquerycontact10-4)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ------------------------------------- |
| Promise<[Contact](#contact)> | Promise对象。返回查询到的联系人对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryContact('xxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contact. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contact. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContacts10+
queryContacts(context: Context, callback: AsyncCallback<Array<Contact>>): void
查询所有联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContacts(context, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)7+
queryContacts(callback: AsyncCallback<Array<Contact>>): void
查询所有联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContacts((err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts10+
queryContacts(context: Context, holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据holder查询所有联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContacts(context, {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)7+
queryContacts(holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据holder查询所有联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContacts({
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts10+
queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据attrs查询所有联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContacts(context, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)7+
queryContacts(attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据attrs查询所有联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContacts({
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts10+
queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据holder和attrs查询所有联系人，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContacts(context, {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)7+
queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据holder和attrs查询所有联系人，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10-3)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContacts({
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts10+
queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据holder和attrs查询所有联系人，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryContacts(context, {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts. data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContacts(deprecated)7+
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据holder和attrs查询所有联系人，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10-4)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryContacts({
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContactsByPhoneNumber10+
queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void
根据电话号码查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)7+
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void
根据电话号码查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByPhoneNumber('138xxxxxxxx', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber10+
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据电话号码和holder查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)7+
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据电话号码和holder查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber10+
queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据电话号码和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)7+
queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据电话号码和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber10+
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据电话号码、holder和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)7+
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据电话号码、holder和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10-3)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber10+
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据电话号码、holder和attrs查询联系人，使用Promise异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)7+
queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据电话号码、holder和attrs查询联系人，使用Promise异步回调。该接口仅返回联系人信息中的id、key、phoneNumbers属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10-4)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ---------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts By PhoneNumber. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts By PhoneNumber. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContactsByEmail10+
queryContactsByEmail(context: Context, email: string, callback: AsyncCallback<Array<Contact>>): void
根据email查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByEmail(context, 'xxx@email.com', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail(deprecated)7+
queryContactsByEmail(email: string, callback: AsyncCallback<Array<Contact>>): void
根据email查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByEmail('xxx@email.com', (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail10+
queryContactsByEmail(context: Context, email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据email和holder查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByEmail(context, 'xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail(deprecated)7+
queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void
根据email和holder查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByEmail('xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail10+
queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据email和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByEmail(context, 'xxx@email.com', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail(deprecated)7+
queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据email和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByEmail('xxx@email.com', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail10+
queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据email、holder和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryContactsByEmail(context, 'xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail(deprecated)7+
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void
根据email、holder和attrs查询联系人，使用callback异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10-3)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback<Array<[Contact](#contact)>> | 是 | 回调函数。成功返回查询到的联系人对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryContactsByEmail('xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail10+
queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据email、holder和attrs查询联系人，使用Promise异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryContactsByEmail(context, 'xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryContactsByEmail(deprecated)7+
queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>
根据email、holder和attrs查询联系人，使用Promise异步回调。该接口仅返回联系人信息中的id、key、Emails属性。如果要查询联系人的所有信息，建议使用[queryContact](#contactquerycontact10-3)接口，根据该接口返回的属性key查询。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10-4)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表，不传默认查询所有联系人属性。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ----------------------------------------- |
| Promise<Array<[Contact](#contact)>> | Promise对象。返回查询到的联系人数组对象。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryContactsByEmail('xxx@email.com', {
holderId: 1,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.info(`Succeeded in querying Contacts By Email. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Contacts By Email. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryGroups10+
queryGroups(context: Context, callback: AsyncCallback<Array<Group>>): void
查询联系人的所有群组，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| callback | AsyncCallback<Array<[Group](#group)>> | 是 | 回调函数。成功返回查询到的群组对象数组；失败返回失败的错误码。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryGroups(context, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Groups. data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups(deprecated)7+
queryGroups(callback: AsyncCallback<Array<Group>>): void
查询联系人的所有群组，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryGroups](#contactquerygroups10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[Group](#group)>> | 是 | 回调函数。成功返回查询到的群组对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryGroups((err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Groups.. data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups10+
queryGroups(context: Context, holder: Holder, callback: AsyncCallback<Array<Group>>): void
根据holder查询联系人的所有群组，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Group](#group)>> | 是 | 回调函数。成功返回查询到的群组对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryGroups(context, {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Groups. data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups(deprecated)7+
queryGroups(holder: Holder, callback: AsyncCallback<Array<Group>>): void
根据holder查询联系人的所有群组，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryGroups](#contactquerygroups10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<Array<[Group](#group)>> | 是 | 回调函数。成功返回查询到的群组对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryGroups({
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Groups. data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups10+
queryGroups(context: Context, holder?: Holder): Promise<Array<Group>>
根据holder查询联系人的所有群组，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人群组。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------- | --------------------------------------- |
| Promise<Array<[Group](#group)>> | Promise对象。返回查询到的群组对象数组。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryGroups(context, {
holderId: 1,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.info(`Succeeded in querying Groups. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryGroups(deprecated)7+
queryGroups(holder?: Holder): Promise<Array<Group>>
根据holder查询联系人的所有群组，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryGroups](#contactquerygroups10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人群组。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------- | --------------------------------------- |
| Promise<Array<[Group](#group)>> | Promise对象。返回查询到的群组对象数组。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryGroups({
holderId: 1,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.info(`Succeeded in querying Groups. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Groups. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryHolders10+
queryHolders(context: Context, callback: AsyncCallback<Array<Holder>>): void
查询所有创建联系人的应用信息，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| callback | AsyncCallback<Array<[Holder](#holder)>> | 是 | 回调函数。成功返回查询到的创建联系人应用信息的对象数组；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryHolders(context, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Holders. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Holders. data->${JSON.stringify(data)}`);
});
```
## contact.queryHolders(deprecated)7+
queryHolders(callback: AsyncCallback<Array<Holder>>): void
查询所有创建联系人的应用信息，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryHolders](#contactqueryholders10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback<Array<[Holder](#holder)>> | 是 | 回调函数。成功返回查询到的创建联系人应用信息的对象数组；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryHolders((err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Holders. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Holders. data->${JSON.stringify(data)}`);
});
```
## contact.queryHolders10+
queryHolders(context: Context): Promise<Array<Holder>>
查询所有创建联系人的应用信息，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------------- | ------------------------------------------------------- |
| Promise<Array<[Holder](#holder)>> | Promise对象。返回查询到的创建联系人应用信息的对象数组。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryHolders(context);
promise.then((data) => {
console.info(`Succeeded in querying Holders. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Holders. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryHolders(deprecated)7+
queryHolders(): Promise<Array<Holder>>
查询所有创建联系人的应用信息，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryHolders](#contactqueryholders10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**返回值：**
| 类型 | 说明 |
| --------------------------------------------- | ------------------------------------------------------- |
| Promise<Array<[Holder](#holder)>> | Promise对象。返回查询到的创建联系人应用信息的对象数组。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryHolders();
promise.then((data) => {
console.info(`Succeeded in querying Holders. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Holders. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryKey10+
queryKey(context: Context, id: number, callback: AsyncCallback<string>): void
根据联系人的id查询联系人的key，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback<string> | 是 | 回调函数。成功返回查询到的联系人对应的key；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryKey(context, /*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
});
```
## contact.queryKey(deprecated)7+
queryKey(id: number, callback: AsyncCallback<string>): void
根据联系人的id查询联系人的key，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryKey](#contactquerykey10)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback<string> | 是 | 回调函数。成功返回查询到的联系人对应的key；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryKey(/*id*/1, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
});
```
## contact.queryKey10+
queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback<string>): void
根据联系人的id和holder查询联系人的key，使用callback异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<string> | 是 | 回调函数。成功返回查询到的联系人对应的key；失败返回失败的错误码。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
contact.queryKey(context, /*id*/1, {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
});
```
## contact.queryKey(deprecated)7+
queryKey(id: number, holder: Holder, callback: AsyncCallback<string>): void
根据联系人的id和holder查询联系人的key，使用callback异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryKey](#contactquerykey10-1)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback<string> | 是 | 回调函数。成功返回查询到的联系人对应的key；失败返回失败的错误码。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
contact.queryKey(/*id*/1, {
holderId: 1,
bundleName: "",
displayName: ""
}, (err: BusinessError, data) => {
if (err) {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
return;
}
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
});
```
## contact.queryKey10+
queryKey(context: Context, id: number, holder?: Holder): Promise<string>
根据联系人的id和holder查询联系人的key，使用Promise异步回调。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------------ |
| Promise<string> | Promise对象。返回查询到的联系人对应的key。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Parameter verification failed. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';
// 获取context。
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.queryKey(context, /*id*/1, {
holderId: 1,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.queryKey(deprecated)7+
queryKey(id: number, holder?: Holder): Promise<string>
根据联系人的id和holder查询联系人的key，使用Promise异步回调。
> **说明**
>
> 从API version 7 开始支持，从API version 10 开始废弃，建议使用[queryKey](#contactquerykey10-2)替代。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息，不传默认不使用该条件过滤联系人。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------------ |
| Promise<string> | Promise对象。返回查询到的联系人对应的key。 |
**示例：**
```js
import { BusinessError } from '@kit.BasicServicesKit';
let promise = contact.queryKey(/*id*/1, {
holderId: 1,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.info(`Succeeded in querying Key. data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to query Key. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.addContactViaUI15+
addContactViaUI(context: Context, contact: Contact): Promise<number>
调用新建联系人接口，打开新建联系人UI界面，新建完成。使用Promise异步回调。
**原子化服务API**: 从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------------ |
| Promise<number> | Promise对象。返回添加的联系人id。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)和[Contacts错误码](../apis-contacts-kit/errorcode-contacts.md)。
| 错误码ID | 错误信息 |
| --------------------- | ------------------------------------------ |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
| 801 | The specified SystemCapability name was not found. |
| 16700001 | General error. |
| 16700102 | Failed to set value to contacts data. |
| 16700103 | User cancel. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context。
let contactInfo: contact.Contact = {
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxx'
}]
}
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.addContactViaUI(context, contactInfo);
promise.then((data) => {
console.info(`Succeeded in add Contact via UI.data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to add Contact via UI. Code: ${err.code}, message: ${err.message}`);
});
```
## contact.saveToExistingContactViaUI15+
saveToExistingContactViaUI(context: Context, contact: Contact): Promise<number>
调用保存至已有联系人接口，选择联系人UI界面并完成编辑。使用Promise异步回调。
**原子化服务API**: 从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------------ |
| Promise<number> | Promise对象。返回添加的联系人id。 |
**错误码：**
以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)和[Contacts错误码](../apis-contacts-kit/errorcode-contacts.md)。
| 错误码ID | 错误信息 |
| --------------------- | ------------------------------------------ |
| 401 | Parameter error. Possible causes: Mandatory parameters are left unspecified. |
| 801 | The specified SystemCapability name was not found. |
| 16700001 | General error. |
| 16700101 | Failed to get value to contacts data. |
| 16700102 | Failed to set value to contacts data. |
| 16700103 | User cancel. |
**示例：**
>**说明：**
>
>在本文档的示例中，通过this.context来获取UIAbilityContext，其中this代表继承自UIAbility的UIAbility实例。如需要在页面中使用UIAbilityContext提供的能力，请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
```js
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context。
let contactInfo: contact.Contact = {
id: 1,
name: {
fullName: 'xxx'
},
phoneNumbers: [{
phoneNumber: '138xxxxxx'
}]
}
let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
let promise = contact.saveToExistingContactViaUI(context, contactInfo);
promise.then((data) => {
console.info(`Succeeded in save to existing Contact via UI.data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
console.error(`Failed to save to existing Contact via UI. Code: ${err.code}, message: ${err.message}`);
});
```
## ContactSelectionOptions10+
选择联系人条件。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---- | ---------------- |
| isMultiSelect10+ | boolean | 否 | 是 | 是否为多选，true:多选，false:单选。默认值为false。**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。 |
| maxSelectable15+ | number | 否 | 是 | 联系人选择数量上限。默认值为10000。**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。 |
| isDisplayedByName15+ | boolean | 否 | 是 | 是否按联系人姓名维度展示，true:按联系人姓名维度展示，false:按联系人号码维度展示。默认值为false。**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。 |
| filter15+ | [ContactSelectionFilter](#contactselectionfilter15) | 否 | 是 | 联系人查询过滤器。**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。 |
## ContactSelectionFilter15+
联系人查询过滤器。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---- | ---------------- |
| filterClause | [FilterClause](#filterclause15) | 否 | 否 | 过滤条件。 |
| filterType | [FilterType](#filtertype15) | 否 | 否 | 过滤类型。 |
## FilterType15+
枚举，联系人过滤类型。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 值 | 说明 |
| --------------------- | ---- | ---------------------------------- |
| SHOW_FILTER | 0 | 仅展示符合过滤条件的联系人。
**系统能力**：SystemCapability.Applications.Contacts |
| DEFAULT_SELECT | 1 | 默认勾选符合过滤条件的联系人。
**系统能力**：SystemCapability.Applications.Contacts |
| SHOW_FILTER_AND_DEFAULT_SELECT | 2 | 默认勾选仅展示符合过滤条件的联系人。
**系统能力**：SystemCapability.Applications.Contacts |
## FilterClause15+
联系人过滤条件。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---- | ---------------- |
| id | Array\<[FilterOptions](#filteroptions15)> | 否 | 是 | 联系人id。 |
| name | Array\<[FilterOptions](#filteroptions15)> | 否 | 是 | 联系人姓名。 |
| dataItem | [DataFilter](#datafilter15) | 否 | 是 | 联系人数据过滤项。 |
| focusModeList | Array\<[FilterOptions](#filteroptions15)> | 否 | 是 | 专注模式。 |
## FilterOptions15+
联系人过滤参数。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---- | ---------------- |
| filterCondition | [FilterCondition](#filtercondition15) | 否 | 否 | 过滤条件。 |
| value | string \| ValueType[] | 否 | 是 | 过滤值，默认为undefined。 |
## FilterCondition15+
枚举，过滤条件。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 值 | 说明 |
| --------------------- | ---- | ---------------------------------- |
| IS_NOT_NULL | 0 | 对应字段不为空。
**系统能力**：SystemCapability.Applications.Contacts |
| EQUAL_TO | 1 | 对应字段等于某值。
**系统能力**：SystemCapability.Applications.Contacts |
| NOT_EQUAL_TO | 2 | 对应字段不等于某值。
**系统能力**：SystemCapability.Applications.Contacts |
| IN | 3 | 对应字段值在某数组中。
**系统能力**：SystemCapability.Applications.Contacts |
| NOT_IN | 4 | 对应字段值不在某数组中。
**系统能力**：SystemCapability.Applications.Contacts |
| CONTAINS | 5 | 对应字段值包含某值
**系统能力**：SystemCapability.Applications.Contacts。 |
## DataFilter15+
联系人数据过滤项。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---- | ---------------- |
| field | [DataField](#datafield15) | 否 | 否 | 联系人数据字段。 |
| options | Array\<[FilterOptions](#filteroptions15)> | 否 | 否 | 过滤参数。 |
## DataField15+
枚举，联系人数据字段。
**原子化服务API**：从API version 15 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 值 | 说明 |
| --------------------- | --- | ---------------------------------- |
| EMAIL | 0 | 联系人邮箱。
**系统能力**：SystemCapability.Applications.Contacts。 |
| PHONE | 1 | 联系人电话。
**系统能力**：SystemCapability.Applications.Contacts。 |
| ORGANIZATION | 2 | 联系人单位。
**系统能力**：SystemCapability.Applications.Contacts。 |
## Contact
联系人对象类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ------------------ | ---- | ---- | ---------------- |
| INVALID_CONTACT_ID | number | -1 | 默认联系人的id。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----------------- | --------------------------------------- | ---- | ---- | -------------------------------------- |
| id | number | 是 | 是 | 联系人的id。 |
| key | string | 是 | 是 | 联系人的key。 |
| contactAttributes | [ContactAttributes](#contactattributes) | 否 | 是 | 联系人的属性列表。 |
| emails | [Email](#email)[] | 否 | 是 | 联系人的邮箱地址列表。 |
| events | [Event](#event)[] | 否 | 是 | 联系人的生日、周年纪念等重要日期列表。 |
| groups | [Group](#group)[] | 否 | 是 | 联系人的群组列表。 |
| imAddresses | [ImAddress](#imaddress)[] | 否 | 是 | 联系人的即时消息地址列表。 |
| phoneNumbers | [PhoneNumber](#phonenumber)[] | 否 | 是 | 联系人的电话号码列表。 |
| portrait | [Portrait](#portrait) | 否 | 是 | 联系人的头像。 |
| postalAddresses | [PostalAddress](#postaladdress)[] | 否 | 是 | 联系人的邮政地址列表。 |
| relations | [Relation](#relation)[] | 否 | 是 | 联系人的关系列表。 |
| sipAddresses | [SipAddress](#sipaddress)[] | 否 | 是 | 联系人的会话发起协议(SIP)地址列表。 |
| websites | [Website](#website)[] | 否 | 是 | 联系人的网站列表。 |
| name | [Name](#name) | 否 | 是 | 联系人的姓名。 |
| nickName | [NickName](#nickname) | 否 | 是 | 联系人的昵称。 |
| note | [Note](#note) | 否 | 是 | 联系人的备注。 |
| organization | [Organization](#organization) | 否 | 是 | 联系人的组织信息。 |
**对象创建示例：**
使用JSON格式创建联系人数据。
```js
let myContact: contact.Contact = {
phoneNumbers: [{
phoneNumber: "138xxxxxxxx"
}],
name: {
fullName: "fullName",
namePrefix: "namePrefix"
},
nickName: {
nickName: "nickName"
}
};
```
## ContactAttributes
联系人属性列表，一般作为入参用来标识希望查询的联系人属性。
当传入为null时，默认查询全部属性。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ---------- | ------------------------- | ---- | ---- | ---------------- |
| attributes | [Attribute](#attribute)[] | 否 | 否 | 联系人属性列表。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let contactAttributes: contact.ContactAttributes = {
attributes: [
contact.Attribute.ATTR_EMAIL,
contact.Attribute.ATTR_NAME,
contact.Attribute.ATTR_PHONE
]
};
```
## Attribute
枚举，联系人属性列表。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：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
联系人的邮箱。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ---------------- | ---- | ---- | ---------------- |
| CUSTOM_LABEL | number | 0 |自定义邮箱类型。 |
| EMAIL_HOME | number | 1 | 家庭邮箱类型。 |
| EMAIL_WORK | number | 2 | 工作邮箱类型。 |
| EMAIL_OTHER | number | 3 | 其它邮箱类型。 |
| INVALID_LABEL_ID | number | -1 | 无效邮箱类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----------- | -------- | ---- | ---- | ---------------- |
| email | string | 否 | 否 | 邮箱地址。 |
| labelName | string | 否 | 是 | 邮箱的类型名称。 |
| displayName | string | 否 | 是 | 邮箱的显示名称。 |
| labelId | number | 否 | 是 | 邮箱的类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let email: contact.Email = {
email: "xxx@email.com",
displayName: "displayName"
}
```
或使用new一个Email对象的方式创建数据。
```js
let email = new contact.Email();
email.email = "xxx@email.com";
```
## Holder
创建联系人的应用信息类。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----------- | ------ | ---- | ---- | ------------ |
| bundleName | string | 是 | 否 | Bundle名称，值为com.ohos.contacts。 |
| displayName | string | 是 | 是 | 应用名称。 |
| holderId | number | 否 | 是 | 应用Id。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let holder: contact.Holder = {
bundleName: "com.ohos.contacts",
displayName: "displayName",
holderId: 1
};
```
## Event
联系人事件类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ----------------- | ---- | ---- | ------------------ |
| CUSTOM_LABEL | number | 0 | 自定义事件类型。 |
| EVENT_ANNIVERSARY | number | 1 | 周年纪念事件类型。 |
| EVENT_OTHER | number | 2 | 其它事件类型。 |
| EVENT_BIRTHDAY | number | 3 | 生日事件类型。 |
| INVALID_LABEL_ID | number | -1 | 无效事件类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------- | -------- | ---- | ---- | -------------- |
| eventDate | string | 否 | 否 | 事件的日期。 |
| labelName | string | 否 | 是 | 事件类型名称。 |
| labelId | number | 否 | 是 | 事件类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let event: contact.Event = {
eventDate: "xxxxxx"
};
```
或使用new一个Event对象的方式创建数据。
```js
let event = new contact.Event();
event.eventDate = "xxxxxx";
```
## Group
联系人的群组类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ------- | -------- | ---- | ---- | ------------------ |
| groupId | number | 否 | 是 | 联系人群组的Id。 |
| title | string | 否 | 否 | 联系人群组的名称。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let group: contact.Group = {
groupId: 1,
title: "title"
};
```
## ImAddress
联系人的即时消息地址。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ---------------- | ---- | ---- | -------------------- |
| CUSTOM_LABEL | number | -1 | 自定义即时消息类型。 |
| IM_AIM | number | 0 | AIM即时消息类型。 |
| IM_MSN | number | 1 | MSN即时消息类型。 |
| IM_YAHOO | number | 2 | YAHOO即时消息类型。 |
| IM_SKYPE | number | 3 | SKYPE即时消息类型。 |
| IM_QQ | number | 4 | QQ即时消息类型。 |
| IM_ICQ | number | 6 | ICQ即时消息类型。 |
| IM_JABBER | number | 7 | JABBER即时消息类型。 |
| INVALID_LABEL_ID | number | -2 | 无效的即时消息类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| --------- | -------- | ---- | ---- | ------------------ |
| imAddress | string | 否 | 否 | 即时消息地址。 |
| labelName | string | 否 | 是 | 即时消息类型名称。 |
| labelId | number | 否 | 是 | 即时消息类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let imAddress: contact.ImAddress = {
imAddress: "imAddress",
labelName: "labelName"
};
```
或使用new一个ImAddress对象的方式创建数据。
```js
let imAddress = new contact.ImAddress();
imAddress.imAddress = "imAddress";
```
## Name
联系人的名字类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ------------------ | -------- | ---- | ---- | --------------------------- |
| familyName | string | 否 | 是 | 联系人的家庭姓名。 |
| familyNamePhonetic | string | 否 | 是 | 联系人的家庭姓名拼音。 |
| fullName | string | 否 | 否 | 联系人的全名。 |
| givenName | string | 否 | 是 | 联系人的名称(firstName)。 |
| givenNamePhonetic | string | 否 | 是 | 联系人的名称拼音。 |
| middleName | string | 否 | 是 | 联系人的中间名。 |
| middleNamePhonetic | string | 否 | 是 | 联系人的中间名拼音。 |
| namePrefix | string | 否 | 是 | 联系人的姓名前缀。 |
| nameSuffix | string | 否 | 是 | 联系人的姓名后缀。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let name: contact.Name = {
familyName: "familyName",
fullName: "fullName"
};
```
## NickName
联系人的昵称类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | ---- | ---- | -------------- |
| nickName | string | 否 | 否 | 联系人的昵称。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let nickName: contact.NickName = {
nickName: "nickName"
};
```
## Note
联系人的备注类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----------- | -------- | ---- | ---- | ------------------ |
| noteContent | string | 否 | 否 | 联系人的备注内容。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let note: contact.Note = {
noteContent: "noteContent"
};
```
## Organization
联系人的组织类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----- | -------- | ---- | ---- | ---------- |
| name | string | 否 | 否 | 单位名称。 |
| title | string | 否 | 是 | 职位名称。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let organization: contact.Organization = {
name: "name",
title: "title"
};
```
## PhoneNumber
联系人电话号码类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ---------------- | ---- | ---- | ------------------------------------------------ |
| CUSTOM_LABEL | number | 0 | 自定义电话类型。 |
| NUM_HOME | number | 1 | 家庭电话类型。 |
| NUM_MOBILE | number | 2 | 移动电话类型。 |
| NUM_WORK | number | 3 | 工作电话类型。 |
| NUM_FAX_WORK | number | 4 | 工作传真电话类型。 |
| NUM_FAX_HOME | number | 5 | 家庭传真电话类型。 |
| NUM_PAGER | number | 6 | 寻呼机电话类型。 |
| NUM_OTHER | number | 7 | 其它电话类型。 |
| NUM_CALLBACK | number | 8 | 回呼电话类型。 |
| NUM_CAR | number | 9 | 车机电话类型。 |
| NUM_COMPANY_MAIN | number | 10 | 公司电话类型。 |
| NUM_ISDN | number | 11 | 综合业务数字网(ISDN)电话类型。 |
| NUM_MAIN | number | 12 | 主电话类型。 |
| NUM_OTHER_FAX | number | 13 | 其它传真类型。 |
| NUM_RADIO | number | 14 | 无线电话类型。 |
| NUM_TELEX | number | 15 | 电传电话类型。 |
| NUM_TTY_TDD | number | 16 | 电传打字机(TTY)或测试驱动开发(TDD)电话类型。 |
| NUM_WORK_MOBILE | number | 17 | 工作移动电话类型。 |
| NUM_WORK_PAGER | number | 18 | 工作寻呼机电话类型。 |
| NUM_ASSISTANT | number | 19 | 助理电话类型。 |
| NUM_MMS | number | 20 | 彩信电话类型。 |
| INVALID_LABEL_ID | number | -1 | 无效电话类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ----------- | -------- | ---- | ---- | ------------------ |
| labelName | string | 否 | 是 | 电话号码类型名称。 |
| phoneNumber | string | 否 | 否 | 电话号码。 |
| labelId | number | 否 | 是 | 电话号码类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let phoneNumber: contact.PhoneNumber = {
phoneNumber: "138xxxxxxxx",
labelId: contact.PhoneNumber.NUM_HOME
};
```
或使用new一个PhoneNumber对象的方式创建数据。
```js
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
```
## Portrait
联系人的头像类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ---- | -------- | ---- | ---- | -------------- |
| uri | string | 否 | 否 | 联系人的头像。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let portrait: contact.Portrait = {
uri: "uri"
};
```
## PostalAddress
联系人的邮政地址类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ---------------- | ---- | ---- | -------------------- |
| CUSTOM_LABEL | number | 0 | 自定义邮政地址类型。 |
| ADDR_HOME | number | 1 | 家庭地址类型。 |
| ADDR_WORK | number | 2 | 工作地址类型。 |
| ADDR_OTHER | number | 3 | 其它地址类型。 |
| INVALID_LABEL_ID | number | -1 | 无效地址类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ------------- | -------- | ---- | ---- | -------------------------- |
| city | string | 否 | 是 | 联系人所在的城市。 |
| country | string | 否 | 是 | 联系人所在的国家。 |
| labelName | string | 否 | 是 | 邮政地址类型名称。 |
| neighborhood | string | 否 | 是 | 联系人的邻居。 |
| pobox | string | 否 | 是 | 联系人的邮箱。 |
| postalAddress | string | 否 | 否 | 联系人的邮政地址。 |
| postcode | string | 否 | 是 | 联系人所在区域的邮政编码。 |
| region | string | 否 | 是 | 联系人所在的区域。 |
| street | string | 否 | 是 | 联系人所在的街道。 |
| labelId | number | 否 | 是 | 邮政地址类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let postalAddress: contact.PostalAddress = {
city: "city",
postalAddress: "postalAddress"
};
```
或使用new一个PostalAddress对象的方式创建数据。
```js
let postalAddress = new contact.PostalAddress();
postalAddress.city = "city";
postalAddress.postalAddress = "postalAddress";
```
## Relation
联系人的关系类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ------------------------- | ---- | ---- | ------------------ |
| CUSTOM_LABEL | number | 0 | 自定义关系类型。 |
| RELATION_ASSISTANT | number | 1 | 助手关系类型。 |
| RELATION_BROTHER | number | 2 | 兄弟关系类型。 |
| RELATION_CHILD | number | 3 | 子女关系类型。 |
| RELATION_DOMESTIC_PARTNER | number | 4 | 同居同伴关系类型。 |
| RELATION_FATHER | number | 5 | 父亲关系类型。 |
| RELATION_FRIEND | number | 6 | 朋友关系类型。 |
| RELATION_MANAGER | number | 7 | 管理者关系类型。 |
| RELATION_MOTHER | number | 8 | 母亲关系类型。 |
| RELATION_PARENT | number | 9 | 父母关系类型。 |
| RELATION_PARTNER | number | 10 | 合作伙伴关系类型。 |
| RELATION_REFERRED_BY | number | 11 | 推荐人关系类型。 |
| RELATION_RELATIVE | number | 12 | 亲属关系类型。 |
| RELATION_SISTER | number | 13 | 姐妹关系类型。 |
| RELATION_SPOUSE | number | 14 | 配偶关系类型。 |
| INVALID_LABEL_ID | number | -1 | 无效的关系类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ------------ | -------- | ---- | ---- | -------------- |
| labelName | string | 否 | 是 | 关系类型名称。 |
| relationName | string | 否 | 否 | 关系名称。 |
| labelId | number | 否 | 是 | 关系类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let relation: contact.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)地址类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
### 常量
| 名称 | 类型 | 值 | 说明 |
| ---------------- | ---- | ---- | ----------------------------------- |
| CUSTOM_LABEL | number | 0 | 自定义会话发起协议(SIP)地址类型。 |
| SIP_HOME | number | 1 | 家庭会话发起协议(SIP)地址类型。 |
| SIP_WORK | number | 2 | 工作会话发起协议(SIP)地址类型。 |
| SIP_OTHER | number | 3 | 其它会话发起协议(SIP)地址类型。 |
| INVALID_LABEL_ID | number | -1 | 无效会话发起协议(SIP)地址类型。 |
### 属性
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ---------- | -------- | ---- | ---- | --------------------------------- |
| labelName | string | 否 | 是 | 会话发起协议(SIP)地址类型名称。 |
| sipAddress | string | 否 | 否 | 会话发起协议(SIP)地址。 |
| labelId | number | 否 | 是 | 会话发起协议(SIP)地址类型。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let sipAddress: contact.SipAddress = {
sipAddress: "sipAddress"
};
```
或使用new一个SipAddress对象的方式创建数据。
```js
let sipAddress = new contact.SipAddress();
sipAddress.sipAddress = "sipAddress";
```
## Website
联系人的网站信息类。
**原子化服务API**：从API version 11 开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Applications.ContactsData
| 名称 | 类型 | 只读 | 可选 | 说明 |
| ------- | -------- | ---- | ---- | ------------------ |
| website | string | 否 | 否 | 联系人的网站信息。 |
**对象创建示例：**
使用JSON格式创建数据。
```js
let website: contact.Website = {
website: "website"
};
```