Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 1772b682 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!22763 联系人API10接口文档更新 

Merge pull request !22763 from zhouhongli2023/master
上级 5e03152b 7f597813
隐藏空白更改
内联 并排
Showing with 2513 addition and 218 deletion
zh-cn/application-dev/reference/apis/js-apis-contact.md
浏览文件 @ 1772b682
...@@ -13,12 +13,64 @@ ...@@ -13,12 +13,64 @@
import contact from '@ohos.contact'; import contact from '@ohos.contact';
``` ```
## contact.addContact ## contact.addContact<sup>10+</sup>
addContact(context: Context, contact: Contact, callback: AsyncCallback&lt;number&gt;>): void
添加联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回添加的联系人id。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.addContact(
globalThis.context as Context,
{name: {fullName: 'xxx'},
phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err, data) => {
if (err) {
console.log(`addContact callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`addContact callback: success data->${JSON.stringify(data)}`);
});
```
## contact.addContact(deprecated)<sup>7+</sup>
addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void
添加联系人，使用callback方式作为异步方法。 添加联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -45,13 +97,68 @@ addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void ...@@ -45,13 +97,68 @@ addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void
}); });
``` ```
## contact.addContact<sup>10+</sup>
addContact(context: Context, contact: Contact): Promise<number&gt;
添加联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------------- |
| Promise&lt;number&gt; | 以Promise形式返回结果，返回添加的联系人id。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.addContact(
globalThis.context as Context,
{name: {fullName: 'xxx'},
phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
});
promise.then((data) => {
console.log(`addContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`addContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.addContact ## contact.addContact(deprecated)<sup>7+</sup>
addContact(contact: Contact): Promise&lt;number&gt; addContact(contact: Contact): Promise&lt;number&gt;
添加联系人，使用Promise方式作为异步方法。 添加联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[addContact](#contactaddcontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -82,13 +189,60 @@ addContact(contact: Contact): Promise&lt;number&gt; ...@@ -82,13 +189,60 @@ addContact(contact: Contact): Promise&lt;number&gt;
}); });
``` ```
## contact.deleteContact<sup>10+</sup>
deleteContact(context: Context, key: string, callback: AsyncCallback&lt;void&gt;): void
删除联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人key值，一个联系人对应一个key。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回删除联系人的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.deleteContact(globalThis.context as Context, 'xxx', (err) => {
if (err) {
console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
return;
}
console.log('deleteContact success');
});
```
## contact.deleteContact ## contact.deleteContact(deprecated)<sup>7+</sup>
deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void
删除联系人，使用callback方式作为异步方法。 删除联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[deleteContact](#contactdeletecontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -113,12 +267,64 @@ deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -113,12 +267,64 @@ deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void
``` ```
## contact.deleteContact ## contact.deleteContact<sup>10+</sup>
deleteContact(context: Context, key: string): Promise&lt;void&gt;
删除联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------------------------------- |
| Promise&lt;void&gt; | 以Promise形式返回结果，返回删除联系人的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.deleteContact(globalThis.context as Context, 'xxx');
promise.then(() => {
console.log(`deleteContact success`);
}).catch((err) => {
console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.deleteContact(deprecated)<sup>7+</sup>
deleteContact(key: string): Promise&lt;void&gt; deleteContact(key: string): Promise&lt;void&gt;
删除联系人，使用Promise方式作为异步方法。 删除联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[deleteContact](#contactdeletecontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -147,12 +353,64 @@ deleteContact(key: string): Promise&lt;void&gt; ...@@ -147,12 +353,64 @@ deleteContact(key: string): Promise&lt;void&gt;
``` ```
## contact.updateContact ## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, callback: AsyncCallback&lt;void&gt;): void
更新联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回更新联系人的更新结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.updateContact(globalThis.context as Context, {
id: 1,
name: {fullName: 'xxx'},
phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err) => {
if (err) {
console.log('updateContact callback: err->${JSON.stringify(err)}');
return;
}
console.log('updateContact success');
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void
更新联系人，使用callback方式作为异步方法。 更新联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[updateContact](#contactupdatecontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -181,12 +439,67 @@ updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void ...@@ -181,12 +439,67 @@ updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void
``` ```
## contact.updateContact ## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void
更新联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回更新联系人的更新结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.updateContact(globalThis.context as Context, {
id: 1,
name: {fullName: 'xxx'},
phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err) => {
if (err) {
console.log('updateContact callback: err->${JSON.stringify(err)}');
return;
}
console.log('updateContact success');
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void
更新联系人，使用callback方式作为异步方法。 更新联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[updateContact](#contactupdatecontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -218,12 +531,71 @@ updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallbac ...@@ -218,12 +531,71 @@ updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallbac
``` ```
## contact.updateContact ## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;
更新联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| contact | [Contact](#contact) | 是 | 联系人信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------- |
| Promise&lt;void&gt; | 以Promise形式返回结果，返回更新联系人的更新结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.updateContact(globalThis.context as Context, {
id: 1,
name: {fullName: 'xxx'},
phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then(() => {
console.log('updateContact success');
}).catch((err) => {
console.error(`updateContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt; updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;
更新联系人，使用Promise方式作为异步方法。 更新联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[updateContact](#contactupdatecontact10)
**需要权限**：ohos.permission.WRITE_CONTACTS **需要权限**：ohos.permission.WRITE_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -258,9 +630,9 @@ updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt; ...@@ -258,9 +630,9 @@ updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;
``` ```
## contact.isLocalContact ## contact.isLocalContact<sup>10+</sup>
isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void isLocalContact(context: Context, id: number, callback: AsyncCallback&lt;boolean&gt;): void
判断当前联系人id是否在电话簿中，使用callback方式作为异步方法。 判断当前联系人id是否在电话簿中，使用callback方式作为异步方法。
...@@ -272,13 +644,28 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -272,13 +644,28 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 | | id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
contact.isLocalContact(/*id*/1, (err, data) => { // 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.isLocalContact(globalThis.context as Context, /*id*/1, (err, data) => {
if (err) { if (err) {
console.log(`isLocalContact callback: err->${JSON.stringify(err)}`); console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
return; return;
...@@ -287,12 +674,15 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -287,12 +674,15 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
}); });
``` ```
## contact.isLocalContact(deprecated)<sup>7+</sup>
## contact.isLocalContact isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
isLocalContact(id: number): Promise&lt;boolean&gt; 判断当前联系人id是否在电话簿中，使用callback方式作为异步方法。
判断当前联系人id是否在电话簿中，使用Promise方式作为异步方法。 > **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[isLocalContact](#contactislocalcontact10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -300,33 +690,28 @@ isLocalContact(id: number): Promise&lt;boolean&gt; ...@@ -300,33 +690,28 @@ isLocalContact(id: number): Promise&lt;boolean&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 | | id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 |
**示例：** **示例：**
```js ```js
let promise = contact.isLocalContact(/*id*/1); contact.isLocalContact(/*id*/1, (err, data) => {
promise.then((data) => { if (err) {
console.log(`isLocalContact success: data->${JSON.stringify(data)}`); console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
}).catch((err) => { return;
console.error(`isLocalContact fail: err->${JSON.stringify(err)}`); }
console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.isLocalContact<sup>10+</sup>
## contact.isMyCard isLocalContact(context: Context, id: number): Promise&lt;boolean&gt;
isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void
判断是否为“我的名片”，使用callback方式作为异步方法。 判断当前联系人id是否在电话簿中，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -334,7 +719,140 @@ isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -334,7 +719,140 @@ isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.isLocalContact(globalThis.context as Context, /*id*/1);
promise.then((data) => {
console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.isLocalContact(deprecated)<sup>7+</sup>
isLocalContact(id: number): Promise&lt;boolean&gt;
判断当前联系人id是否在电话簿中，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[isLocalContact](#contactislocalcontact10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| id | number | 是 | 联系人对象的id属性，一个联系人对应一个id。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。 |
**示例：**
```js
let promise = contact.isLocalContact(/*id*/1);
promise.then((data) => {
console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.isMyCard<sup>10+</sup>
isMyCard(context: Context, id: number, callback: AsyncCallback&lt;boolean&gt;): void
判断是否为“我的名片”，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.isMyCard(globalThis.context as Context, /*id*/1, (err, data) => {
if (err) {
console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
});
```
## contact.isMyCard(deprecated)<sup>7+</sup>
isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void
判断是否为“我的名片”，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[isMyCard](#contactismycard10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性。 | | id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。 |
...@@ -352,12 +870,64 @@ isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -352,12 +870,64 @@ isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void
``` ```
## contact.isMyCard ## contact.isMyCard<sup>10+</sup>
isMyCard(context: Context, id: number): Promise&lt;boolean&gt;
判断是否为“我的名片”，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.isMyCard(globalThis.context as Context, /*id*/1);
promise.then((data) => {
console.log(`isMyCard success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
});
```
## contact.isMyCard(deprecated)<sup>7+</sup>
isMyCard(id: number): Promise&lt;boolean&gt; isMyCard(id: number): Promise&lt;boolean&gt;
判断是否为“我的名片”，使用Promise方式作为异步方法。 判断是否为“我的名片”，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[isMyCard](#contactismycard10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -385,13 +955,59 @@ isMyCard(id: number): Promise&lt;boolean&gt; ...@@ -385,13 +955,59 @@ isMyCard(id: number): Promise&lt;boolean&gt;
}); });
``` ```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, callback: AsyncCallback&lt;Contact&gt;): void
查询“我的名片”，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回“我的名片”信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryMyCard(globalThis.context as Context, (err, data) => {
if (err) {
console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard ## contact.queryMyCard(deprecated)<sup>7+</sup>
queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void
查询“我的名片”，使用callback方式作为异步方法。 查询“我的名片”，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -414,13 +1030,62 @@ queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void ...@@ -414,13 +1030,62 @@ queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void
}); });
``` ```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
查询“我的名片”，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回“我的名片”信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryMyCard(globalThis.context as Context, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryMyCard ## contact.queryMyCard(deprecated)<sup>7+</sup>
queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
查询“我的名片”，使用callback方式作为异步方法。 查询“我的名片”，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -446,13 +1111,66 @@ queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): v ...@@ -446,13 +1111,66 @@ queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): v
}); });
``` ```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, attrs?: ContactAttributes): Promise&lt;Contact&gt;
查询“我的名片”，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果，返回“我的名片”信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryMyCard(globalThis.context as Context, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryMyCard ## contact.queryMyCard(deprecated)<sup>7+</sup>
queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt; queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt;
查询“我的名片”，使用Promise方式作为异步方法。 查询“我的名片”，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryMyCard](#contactquerymycard10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -482,12 +1200,16 @@ queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt; ...@@ -482,12 +1200,16 @@ queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt;
``` ```
## contact.selectContact ## contact.selectContact(deprecated)<sup>7+</sup>
selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
选择联系人，使用callback方式作为异步方法。 选择联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[selectContacts](#contactselectcontacts10)
**系统能力**：SystemCapability.Applications.Contacts **系统能力**：SystemCapability.Applications.Contacts
**参数：** **参数：**
...@@ -509,12 +1231,16 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void ...@@ -509,12 +1231,16 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
``` ```
## contact.selectContact ## contact.selectContact(deprecated)<sup>7+</sup>
selectContact(): Promise&lt;Array&lt;Contact&gt;&gt; selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
选择联系人，使用Promise方式作为异步方法。 选择联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[selectContacts](#contactselectcontacts10)
**系统能力**：SystemCapability.Applications.Contacts **系统能力**：SystemCapability.Applications.Contacts
**返回值：** **返回值：**
...@@ -534,63 +1260,148 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt; ...@@ -534,63 +1260,148 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
}); });
``` ```
## contact.selectContacts<sup>10+</sup>
## contact.queryContact selectContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS 选择联系人，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.Contacts
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回选择的联系人对象数组。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**示例：** **示例：**
```js ```js
contact.queryContact('xxx', (err, data) => { contact.selectContacts((err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`selectContact callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContact callback: success data->${JSON.stringify(data)}`); console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.selectContacts<sup>10+</sup>
## contact.queryContact selectContacts(): Promise&lt;Array&lt;Contact&gt;&gt;
queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void 选择联系人，使用Promise方式作为异步方法。
根据key查询联系人，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Applications.Contacts
**需要权限**：ohos.permission.READ_CONTACTS **返回值：**
**系统能力**：SystemCapability.Applications.ContactsData | 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回选择的联系人对象数组。 |
**参数：** **示例：**
| 参数名 | 类型 | 必填 | 说明 | ```js
| -------- | ---------------------------------------- | ---- | -------------------------------------- | let promise = contact.selectContacts();
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 | promise.then((data) => {
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | console.log(`selectContact success: data->${JSON.stringify(data)}`);
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 | }).catch((err) => {
console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.selectContacts<sup>10+</sup>
selectContacts(options: ContactSelectionOptions, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
选择联系人，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| options | ContactSelectionOptions | 是 | 选择联系人时的筛选条件 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回选择的联系人对象数组。 |
**示例：** **示例：**
```js ```js
contact.queryContact('xxx', { contact.selectContacts({
holderId: 0, isMultiSelect:false
bundleName: "",
displayName: ""
}, (err, data) => { }, (err, data) => {
if (err) {
console.log(`selectContact callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
});
```
## contact.selectContacts<sup>10+</sup>
selectContacts(options: ContactSelectionOptions): Promise&lt;Array&lt;Contact&gt;&gt;
选择联系人，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Applications.Contacts
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------- |
| options | ContactSelectionOptions | 是 | 选择联系人时的筛选条件 |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回选择的联系人对象数组。 |
**示例：**
```js
let promise = contact.selectContacts({isMultiSelect:false});
promise.then((data) => {
console.log(`selectContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContact<sup>10+</sup>
queryContact(context: Context, key: string, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContact(globalThis.context as Context, 'xxx', (err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
...@@ -599,13 +1410,16 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt; ...@@ -599,13 +1410,16 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;
}); });
``` ```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContact queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void
queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人，使用callback方式作为异步方法。 根据key查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -615,15 +1429,12 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt; ...@@ -615,15 +1429,12 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 | | callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**示例：** **示例：**
```js ```js
contact.queryContact('xxx', { contact.queryContact('xxx', (err, data) => {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
...@@ -633,12 +1444,65 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt; ...@@ -633,12 +1444,65 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;
``` ```
## contact.queryContact ## contact.queryContact<sup>10+</sup>
queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContact(globalThis.context as Context, 'xxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人，使用callback方式作为异步方法。 根据key查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -649,7 +1513,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -649,7 +1513,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 | | callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**示例：** **示例：**
...@@ -659,8 +1522,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -659,8 +1522,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
...@@ -670,12 +1531,11 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -670,12 +1531,11 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
}); });
``` ```
## contact.queryContact<sup>10+</sup>
## contact.queryContact queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;
根据key查询联系人，使用Promise方式作为异步方法。 根据key查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -683,40 +1543,50 @@ queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&l ...@@ -683,40 +1543,50 @@ queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&l
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**返回值：** **错误码：**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- | | 错误码ID | 错误信息 |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果，返回查询到的联系人对象。 | | -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
let promise = contact.queryContact('xxx', { // 获取context
holderId: 0, import UIAbility from '@ohos.app.ability.UIAbility';
bundleName: "", class EntryAbility extends UIAbility {
displayName: "" onWindowStageCreate(windowStage){
}, { globalThis.context = this.context;
}
}
contact.queryContact(globalThis.context as Context, 'xxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}); }, (err, data) => {
promise.then((data) => { if (err) {
console.log(`queryContact success: data->${JSON.stringify(data)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
}).catch((err) => { return;
console.error(`queryContact fail: err->${JSON.stringify(err)}`); }
console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContacts queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void 根据key查询联系人，使用callback方式作为异步方法。
查询所有联系人，使用callback方式作为异步方法。 > **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -724,28 +1594,31 @@ queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void ...@@ -724,28 +1594,31 @@ queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**示例：** **示例：**
```js ```js
contact.queryContacts((err, data) => { contact.queryContact('xxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`); console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContact<sup>10+</sup>
## contact.queryContacts queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。 根据key查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -753,33 +1626,55 @@ queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt ...@@ -753,33 +1626,55 @@ queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
contact.queryContacts({ // 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContact(globalThis.context as Context, 'xxx', {
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`); console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContacts queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void 根据key查询联系人，使用callback方式作为异步方法。
查询所有联系人，使用callback方式作为异步方法。 > **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -787,31 +1682,37 @@ queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Cont ...@@ -787,31 +1682,37 @@ queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Cont
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数，返回查询的联系人对象。 |
**示例：** **示例：**
```js ```js
contact.queryContacts({ contact.queryContact('xxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`); console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts ## contact.queryContact<sup>10+</sup>
queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContact(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;
查询所有联系人，使用callback方式作为异步方法。 根据key查询联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -819,36 +1720,693 @@ queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback& ...@@ -819,36 +1720,693 @@ queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果，返回查询到的联系人对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryContact(globalThis.context as Context, 'xxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;
根据key查询联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContact](#contactquerycontact10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值，一个联系人对应一个key。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果，返回查询到的联系人对象。 |
**示例：**
```js
let promise = contact.queryContact('xxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContact fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContacts(globalThis.context as Context, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：**
```js
contact.queryContacts((err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContacts(globalThis.context as Context, {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：**
```js
contact.queryContacts({
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContacts(globalThis.context as Context, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：**
```js
contact.queryContacts({
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContacts(globalThis.context as Context, {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：**
```js
contact.queryContacts({
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
查询所有联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryContacts(globalThis.context as Context, {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContacts success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
查询所有联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContacts](#contactquerycontacts10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回查询到的联系人对象数组。 |
**示例：**
```js
let promise = contact.queryContacts({
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContacts success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：**
```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：** **示例：**
```js ```js
contact.queryContacts({ contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContacts callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContacts queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
查询所有联系人，使用Promise方式作为异步方法。 根据电话号码查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -856,40 +2414,51 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C ...@@ -856,40 +2414,51 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- | | ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**返回值：** **错误码：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- | | 错误码ID | 错误信息 |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回查询到的联系人对象数组。 | | -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
let promise = contact.queryContacts({ // 获取context
holderId: 0, import UIAbility from '@ohos.app.ability.UIAbility';
bundleName: "", class EntryAbility extends UIAbility {
displayName: "" onWindowStageCreate(windowStage){
}, { globalThis.context = this.context;
}
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}); }, (err, data) => {
promise.then((data) => { if (err) {
console.log(`queryContacts success: data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
}).catch((err) => { return;
console.error(`queryContacts fail: err->${JSON.stringify(err)}`); }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
## contact.queryContactsByPhoneNumber queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。 根据电话号码查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -899,12 +2468,15 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array ...@@ -899,12 +2468,15 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**示例：** **示例：**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => { contact.queryContactsByPhoneNumber('138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return; return;
...@@ -913,10 +2485,9 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array ...@@ -913,10 +2485,9 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array
}); });
``` ```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContactsByPhoneNumber queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。 根据电话号码查询联系人，使用callback方式作为异步方法。
...@@ -926,19 +2497,37 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC ...@@ -926,19 +2497,37 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', { // 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
...@@ -948,13 +2537,16 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC ...@@ -948,13 +2537,16 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
## contact.queryContactsByPhoneNumber queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。 根据电话号码查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -964,6 +2556,7 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba ...@@ -964,6 +2556,7 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
...@@ -971,6 +2564,10 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba ...@@ -971,6 +2564,10 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', { contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { }, (err, data) => {
if (err) { if (err) {
...@@ -981,12 +2578,11 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba ...@@ -981,12 +2578,11 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
}); });
``` ```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContactsByPhoneNumber queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人，使用callback方式作为异步方法。 根据电话号码查询联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
...@@ -994,38 +2590,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAt ...@@ -994,38 +2590,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAt
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ----------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 | | context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 | | attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：** **示例：**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', { // 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
}, { }, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => { });
if (err) { promise.then((data) => {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
return; }).catch((err) => {
} console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt; queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据电话号码查询联系人，使用Promise方式作为异步方法。 根据电话号码查询联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1061,13 +2679,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: Contact ...@@ -1061,13 +2679,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: Contact
}); });
``` ```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail ## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。 根据email查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1091,13 +2756,65 @@ queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact& ...@@ -1091,13 +2756,65 @@ queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&
}); });
``` ```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail ## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。 根据email查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1126,13 +2843,63 @@ queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;A ...@@ -1126,13 +2843,63 @@ queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;A
}); });
``` ```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail ## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。 根据email查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1159,13 +2926,68 @@ queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCal ...@@ -1159,13 +2926,68 @@ queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCal
}); });
``` ```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数，返回查询到联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail ## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人，使用callback方式作为异步方法。 根据email查询联系人，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1197,13 +3019,72 @@ queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, ca ...@@ -1197,13 +3019,72 @@ queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, ca
}); });
``` ```
## contact.queryContactsByEmail<sup>10+</sup>
## contact.queryContactsByEmail
queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据email查询联系人，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果，返回查询到的联系人对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt; queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据email查询联系人，使用Promise方式作为异步方法。 根据email查询联系人，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1239,13 +3120,59 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): ...@@ -1239,13 +3120,59 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes):
}); });
``` ```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数，返回查询到的群组对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryGroups(globalThis.context as Context, (err, data) => {
if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups ## contact.queryGroups(deprecated)<sup>7+</sup>
queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组，使用callback方式作为异步方法。 查询联系人的所有群组，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryGroups](#contactquerygroups10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1268,13 +3195,64 @@ queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void ...@@ -1268,13 +3195,64 @@ queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
}); });
``` ```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | Holder | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数，返回查询到的群组对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryGroups(globalThis.context as Context, {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups ## contact.queryGroups(deprecated)<sup>7+</sup>
queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组，使用callback方式作为异步方法。 查询联系人的所有群组，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryGroups](#contactquerygroups10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1302,13 +3280,68 @@ queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): ...@@ -1302,13 +3280,68 @@ queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;):
}); });
``` ```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;
查询联系人的所有群组，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;[Group](#group)&gt;&gt; | 以Promise形式返回结果，返回查询到的群组对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryGroups(globalThis.context as Context, {
holderId: 0,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryGroups ## contact.queryGroups(deprecated)<sup>7+</sup>
queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt; queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;
查询联系人的所有群组，使用Promise方式作为异步方法。 查询联系人的所有群组，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryGroups](#contactquerygroups10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1340,13 +3373,59 @@ queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt; ...@@ -1340,13 +3373,59 @@ queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;
}); });
``` ```
## contact.queryHolders<sup>10+</sup>
queryHolders(context: Context, callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
查询所有创建联系人的应用信息，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&gt;&gt; | 是 | 回调函数，返回查询到的创建联系人应用信息的对象数组。 |
## contact.queryHolders **错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryHolders(globalThis.context as Context, (err, data) => {
if (err) {
console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryHolders(deprecated)<sup>7+</sup>
queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
查询所有创建联系人的应用信息，使用callback方式作为异步方法。 查询所有创建联系人的应用信息，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryHolders](#contactqueryholders10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1369,13 +3448,63 @@ queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void ...@@ -1369,13 +3448,63 @@ queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
}); });
``` ```
## contact.queryHolders<sup>10+</sup>
## contact.queryHolders queryHolders(context: Context ): Promise&lt;Array&lt;Holder&gt;&gt;
查询所有创建联系人的应用信息，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[Holder](#holder)&gt;&gt; | 以Promise形式返回结果，返回查询到的创建联系人应用信息的对象数组。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryHolders(globalThis.context as Context);
promise.then((data) => {
console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryHolders(deprecated)<sup>7+</sup>
queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt; queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt;
查询所有创建联系人的应用信息，使用Promise方式作为异步方法。 查询所有创建联系人的应用信息，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryHolders](#contactqueryholders10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1397,13 +3526,60 @@ queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt; ...@@ -1397,13 +3526,60 @@ queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt;
}); });
``` ```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, callback: AsyncCallback&lt;string&gt;): void
## contact.queryKey 根据联系人的id查询联系人的key，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回查询到的联系人对应的key。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryKey(globalThis.context as Context, /*id*/1, (err, data) => {
if (err) {
console.log(`queryKey callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryKey(deprecated)<sup>7+</sup>
queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void
根据联系人的id查询联系人的key，使用callback方式作为异步方法。 根据联系人的id查询联系人的key，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryKey](#contactquerykey10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1427,13 +3603,65 @@ queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -1427,13 +3603,65 @@ queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void
}); });
``` ```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void
根据联系人的id查询联系人的key，使用callback方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回查询到的联系人对应的key。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
contact.queryKey(globalThis.context as Context, /*id*/1, {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryKey callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryKey ## contact.queryKey(deprecated)<sup>7+</sup>
queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void
根据联系人的id查询联系人的key，使用callback方式作为异步方法。 根据联系人的id查询联系人的key，使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryKey](#contactquerykey10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1462,13 +3690,69 @@ queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): voi ...@@ -1462,13 +3690,69 @@ queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): voi
}); });
``` ```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, holder?: Holder): Promise&lt;string&gt;
根据联系人的id查询联系人的key，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context，Stage模型的应用Context定义见[Context](js-apis-inner-application-context.md)。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------------------------------------------- |
| Promise&lt;string&gt; | 以Promise形式返回结果，返回查询到的联系人对应的key。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例：**
```js
// 获取context
import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage){
globalThis.context = this.context;
}
}
let promise = contact.queryKey(globalThis.context as Context, /*id*/1, {
holderId: 0,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.log(`queryKey success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryKey fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryKey ## contact.queryKey(deprecated)<sup>7+</sup>
queryKey(id: number, holder?: Holder): Promise&lt;string&gt; queryKey(id: number, holder?: Holder): Promise&lt;string&gt;
根据联系人的id查询联系人的key，使用Promise方式作为异步方法。 根据联系人的id查询联系人的key，使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持，从API 10 开始废弃，建议使用[queryKey](#contactquerykey10)
**需要权限**：ohos.permission.READ_CONTACTS **需要权限**：ohos.permission.READ_CONTACTS
**系统能力**：SystemCapability.Applications.ContactsData **系统能力**：SystemCapability.Applications.ContactsData
...@@ -1501,6 +3785,17 @@ queryKey(id: number, holder?: Holder): Promise&lt;string&gt; ...@@ -1501,6 +3785,17 @@ queryKey(id: number, holder?: Holder): Promise&lt;string&gt;
}); });
``` ```
## ContactSelectionOptions<sup>10+</sup>
选择联系人条件。
**系统能力**：SystemCapability.Applications.Contacts
| 名称 | 类型 | 必填 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---------------- |
| isMultiSelect <sup>10+</sup> | boolean | 否 | 是否为多选 |
## Contact ## Contact
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或