提交 e4ae26cf 编写于 作者: Z zhouhongli2023

update

Signed-off-by: Nzhouhongli2023 <zhouhongli5@huawei.com>
上级 31583289
...@@ -13,7 +13,57 @@ ...@@ -13,7 +13,57 @@
import contact from '@ohos.contact'; import contact from '@ohos.contact';
``` ```
## contact.addContact ## contact.addContact<sup>10+<sup>
addContact(context: Context, contact: Contact, callback: AsyncCallback<number>): void
添加联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.WRITE_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void
...@@ -45,8 +95,61 @@ addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void ...@@ -45,8 +95,61 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
addContact(contact: Contact): Promise&lt;number&gt; addContact(contact: Contact): Promise&lt;number&gt;
...@@ -82,8 +185,53 @@ addContact(contact: Contact): Promise&lt;number&gt; ...@@ -82,8 +185,53 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -113,7 +261,57 @@ deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -113,7 +261,57 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
deleteContact(key: string): Promise&lt;void&gt; deleteContact(key: string): Promise&lt;void&gt;
...@@ -147,7 +345,57 @@ deleteContact(key: string): Promise&lt;void&gt; ...@@ -147,7 +345,57 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void
...@@ -181,7 +429,60 @@ updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void ...@@ -181,7 +429,60 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void
...@@ -218,7 +519,64 @@ updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallbac ...@@ -218,7 +519,64 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt; updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;
...@@ -258,9 +616,9 @@ updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt; ...@@ -258,9 +616,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方式作为异步方法。
...@@ -268,17 +626,34 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -268,17 +626,34 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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 +662,11 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -287,12 +662,11 @@ isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
}); });
``` ```
## contact.isLocalContact(deprecated)
## contact.isLocalContact isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void
isLocalContact(id: number): Promise&lt;boolean&gt;
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。 判断当前联系人id是否在电话簿中,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -301,7 +675,86 @@ isLocalContact(id: number): Promise&lt;boolean&gt; ...@@ -301,7 +675,86 @@ isLocalContact(id: number): Promise&lt;boolean&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
**示例:**
```js
contact.isLocalContact(/*id*/1, (err, data) => {
if (err) {
console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
});
```
## contact.isLocalContact<sup>10+<sup>
isLocalContact(context: Context, id: number): Promise&lt;boolean&gt;
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
isLocalContact(id: number): Promise&lt;boolean&gt;
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 | | id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
**返回值:** **返回值:**
...@@ -321,8 +774,53 @@ isLocalContact(id: number): Promise&lt;boolean&gt; ...@@ -321,8 +774,53 @@ isLocalContact(id: number): Promise&lt;boolean&gt;
}); });
``` ```
## contact.isMyCard<sup>10+<sup>
isMyCard(context: Context, id: number, callback: AsyncCallback&lt;boolean&gt;): void
判断是否为“我的名片”,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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 ## contact.isMyCard(deprecated)
isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void
...@@ -352,7 +850,57 @@ isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -352,7 +850,57 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
isMyCard(id: number): Promise&lt;boolean&gt; isMyCard(id: number): Promise&lt;boolean&gt;
...@@ -385,8 +933,52 @@ isMyCard(id: number): Promise&lt;boolean&gt; ...@@ -385,8 +933,52 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void
...@@ -414,8 +1006,55 @@ queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void ...@@ -414,8 +1006,55 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
...@@ -446,8 +1085,59 @@ queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): v ...@@ -446,8 +1085,59 @@ 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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt; queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt;
...@@ -535,9 +1225,9 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt; ...@@ -535,9 +1225,9 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
``` ```
## contact.queryContact ## contact.queryContact<sup>10+<sup>
queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void queryContact(context: Context, key: string, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
...@@ -545,17 +1235,34 @@ queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void ...@@ -545,17 +1235,34 @@ queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 | | key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 | | callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContact('xxx', (err, data) => { // 获取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;
...@@ -564,10 +1271,9 @@ queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void ...@@ -564,10 +1271,9 @@ queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void
}); });
``` ```
## contact.queryContact(deprecated)
## contact.queryContact queryContact(key: string, callback: AsyncCallback&lt;Contact&gt;): void
queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
...@@ -580,17 +1286,12 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt; ...@@ -580,17 +1286,12 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 | | key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 | | callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 |
**示例:** **示例:**
```js ```js
contact.queryContact('xxx', { contact.queryContact('xxx', (err, data) => {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
return; return;
...@@ -602,7 +1303,7 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt; ...@@ -602,7 +1303,7 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;
## contact.queryContact ## contact.queryContact
queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
...@@ -610,19 +1311,38 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt; ...@@ -610,19 +1311,38 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 | | key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 | | callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是 | 回调函数,返回查询的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContact('xxx', { // 获取context
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] 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) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContact callback: err->${JSON.stringify(err)}`); console.log(`queryContact callback: err->${JSON.stringify(err)}`);
...@@ -632,10 +1352,9 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt; ...@@ -632,10 +1352,9 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;
}); });
``` ```
## contact.queryContact(deprecated)
## contact.queryContact queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
...@@ -649,7 +1368,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -649,7 +1368,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 +1377,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -659,8 +1377,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,53 +1386,60 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As ...@@ -670,53 +1386,60 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
}); });
``` ```
## contact.queryContact ## contact.queryContact
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt; queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
根据key查询联系人,使用Promise方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 | | key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | 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)
## contact.queryContacts queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询所有联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -725,61 +1448,84 @@ queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void ...@@ -725,61 +1448,84 @@ 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
## 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
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | 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.queryContacts ## contact.queryContact(deprecated)
queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
查询所有联系人,使用callback方式作为异步方法。 根据key查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -788,67 +1534,93 @@ queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Cont ...@@ -788,67 +1534,93 @@ queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Cont
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | 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
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
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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 ```js
contact.queryContacts({ // 获取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, 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(`queryContacts callback: err->${JSON.stringify(err)}`); console.log(`queryContact success: data->${JSON.stringify(data)}`);
return; }).catch((err) => {
} console.error(`queryContact fail: err->${JSON.stringify(err)}`);
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContact(deprecated)
## contact.queryContacts queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
查询所有联系人,使用Promise方式作为异步方法。 根据key查询联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -857,19 +1629,20 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C ...@@ -857,19 +1629,20 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- | | ------ | --------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- | | ---------------------------------- | ----------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 | | Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果,返回查询到的联系人对象。 |
**示例:** **示例:**
```js ```js
let promise = contact.queryContacts({ let promise = contact.queryContact('xxx', {
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
...@@ -877,48 +1650,62 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C ...@@ -877,48 +1650,62 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;C
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}); });
promise.then((data) => { promise.then((data) => {
console.log(`queryContacts success: data->${JSON.stringify(data)}`); console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err) => { }).catch((err) => {
console.error(`queryContacts fail: err->${JSON.stringify(err)}`); console.error(`queryContact fail: err->${JSON.stringify(err)}`);
}); });
``` ```
## contact.queryContacts
## contact.queryContactsByPhoneNumber queryContacts(context: Context, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人,使用callback方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md) |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => { // 获取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) { if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts(deprecated)
## contact.queryContactsByPhoneNumber queryContacts(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方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -927,66 +1714,76 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC ...@@ -927,66 +1714,76 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:** **示例:**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', { contact.queryContacts((err, data) => {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts
## contact.queryContactsByPhoneNumber queryContacts(context: Context, holder: Holder, 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方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md) |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', { // 获取context
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] 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) => { }, (err, data) => {
if (err) { if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts(deprecated)
## contact.queryContactsByPhoneNumber queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人,使用callback方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -995,78 +1792,79 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAt ...@@ -995,78 +1792,79 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAt
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| 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', { contact.queryContacts({
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(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts
## contact.queryContactsByPhoneNumber queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据电话号码查询联系人,使用Promise方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ---------------------- | | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 联系人的电话号码。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md) |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| 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.queryContactsByPhoneNumber('138xxxxxxxx', { // 获取context
holderId: 0, import UIAbility from '@ohos.app.ability.UIAbility';
bundleName: "", class EntryAbility extends UIAbility {
displayName: "" onWindowStageCreate(windowStage){
}, { globalThis.context = this.context;
}
}
contact.queryContacts(globalThis.context as Context, {
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(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
}).catch((err) => { return;
console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`); }
console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts(deprecated)
## contact.queryContactsByEmail queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -1076,62 +1874,81 @@ queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact& ...@@ -1076,62 +1874,81 @@ queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email | 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.queryContactsByEmail('xxx@email.com', (err, data) => { contact.queryContacts({
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) { if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts
## contact.queryContactsByEmail queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, 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方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- | | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md) |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContactsByEmail('xxx@email.com', { // 获取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, 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(`queryContactsByEmail callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts(deprecated)
## contact.queryContactsByEmail queryContacts(holder: Holder, 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方式作为异步方法。 查询所有联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -1140,69 +1957,90 @@ queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCal ...@@ -1140,69 +1957,90 @@ queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCal
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ | | -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email | 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; | 是 | 回调函数,返回查询到联系人对象数组。 |
**示例:** **示例:**
```js ```js
contact.queryContactsByEmail('xxx@email.com', { contact.queryContacts({
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(`queryContactsByEmail callback: err->${JSON.stringify(err)}`); console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`); console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts
## contact.queryContactsByEmail queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。 查询所有联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到联系人对象数组。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryContactsByEmail('xxx@email.com', { // 获取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, 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(`queryContactsByEmail callback: err->${JSON.stringify(err)}`); console.log(`queryContacts success: data->${JSON.stringify(data)}`);
return; }).catch((err) => {
} console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContacts(deprecated)
## contact.queryContactsByEmail queryContacts(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方式作为异步方法。 查询所有联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -1212,7 +2050,6 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): ...@@ -1212,7 +2050,6 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- | | ------ | --------------------------------------- | ---- | ---------------------- |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 | | attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
...@@ -1224,8 +2061,8 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): ...@@ -1224,8 +2061,8 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes):
**示例:** **示例:**
```js ```js
let promise = contact.queryContactsByEmail('xxx@email.com', { let promise = contact.queryContacts({
holderId: 0, holderId: 0,
bundleName: "", bundleName: "",
displayName: "" displayName: ""
...@@ -1233,47 +2070,63 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): ...@@ -1233,47 +2070,63 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes):
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME] attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}); });
promise.then((data) => { promise.then((data) => {
console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`); console.log(`queryContacts success: data->${JSON.stringify(data)}`);
}).catch((err) => { }).catch((err) => {
console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`); console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
}); });
``` ```
## contact.queryGroups ## contact.queryContactsByPhoneNumber
queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。 根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ | | ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数,返回查询到的群组对象数组。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
contact.queryGroups((err, data) => { // 获取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) { if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)
## contact.queryGroups queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。 根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -1282,70 +2135,79 @@ queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): ...@@ -1282,70 +2135,79 @@ queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;):
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ | | ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder | Holder | 是 | 创建联系人的应用信息。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数,返回查询到的群组对象数组。 | | callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:** **示例:**
```js ```js
contact.queryGroups({ contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) { if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryGroups ## contact.queryContactsByPhoneNumber
queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt; queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
查询联系人的所有群组,使用Promise方式作为异步方法。 根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- | | ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 | | context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**返回值:** **错误码:**
| 类型 | 说明 | | 错误码ID | 错误信息 |
| ------------------------------------------- | ------------------------------------------------- | | -------- | ------------------ |
| Promise&lt;Array&lt;[Group](#group)&gt;&gt; | 以Promise形式返回结果,返回查询到的群组对象数组。 | | 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
let promise = contact.queryGroups({ // 获取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: ""
}); }, (err, data) => {
promise.then((data) => { if (err) {
console.log(`queryGroups success: data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
}).catch((err) => { return;
console.error(`queryGroups fail: err->${JSON.stringify(err)}`); }
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)
## contact.queryHolders queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
查询所有创建联系人的应用信息,使用callback方式作为异步方法。 根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
...@@ -1354,51 +2216,1172 @@ queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void ...@@ -1354,51 +2216,1172 @@ queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ---------------------------------------------------- | | ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&gt;&gt; | 是 | 回调函数,返回查询到的创建联系人应用信息的对象数组。 | | phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:** **示例:**
```js ```js
contact.queryHolders((err, data) => { contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) { if (err) {
console.log(`queryHolders callback: err->${JSON.stringify(err)}`); console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return; return;
} }
console.log(`queryHolders callback: success data->${JSON.stringify(data)}`); console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber
## contact.queryHolders queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt;
查询所有创建联系人的应用信息,使用Promise方式作为异步方法。 根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS **需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData **系统能力**:SystemCapability.Applications.ContactsData
**返回值:** **模型约束**:此接口仅可在Stage模型下使用。
| 类型 | 说明 | **参数:**
| --------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[Holder](#holder)&gt;&gt; | 以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
let promise = contact.queryHolders(); // 获取context
promise.then((data) => { import UIAbility from '@ohos.app.ability.UIAbility';
console.log(`queryHolders success: data->${JSON.stringify(data)}`); class EntryAbility extends UIAbility {
}).catch((err) => { onWindowStageCreate(windowStage){
console.error(`queryHolders fail: err->${JSON.stringify(err)}`); globalThis.context = this.context;
}
}
contact.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
}); });
``` ```
## contact.queryContactsByPhoneNumber(deprecated)
## contact.queryKey queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | 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.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```js
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据电话号码查询联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | 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.queryContactsByPhoneNumber(globalThis.context as Context, '138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContactsByPhoneNumber(deprecated)
queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据电话号码查询联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ---------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**示例:**
```js
let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryContactsByEmail
queryContactsByEmail(context: Context, email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email | string | 是 | 联系人的邮箱地址。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```js
contact.queryContactsByEmail('xxx@email.com', (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail
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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```js
contact.queryContactsByEmail('xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail
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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到联系人对象数组。 |
**示例:**
```js
contact.queryContactsByEmail('xxx@email.com', {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryContactsByEmail
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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 是 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 是 | 联系人的属性列表。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是 | 回调函数,返回查询到联系人对象数组。 |
**示例:**
```js
contact.queryContactsByEmail('xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err, data) => {
if (err) {
console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});
```
## contact.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
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
根据email查询联系人,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| email | string | 是 | 联系人的邮箱地址。 |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
| attrs | [ContactAttributes](#contactattributes) | 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**示例:**
```js
let promise = contact.queryContactsByEmail('xxx@email.com', {
holderId: 0,
bundleName: "",
displayName: ""
}, {
attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryGroups
queryGroups(context: Context, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数,返回查询到的群组对象数组。 |
**示例:**
```js
contact.queryGroups((err, data) => {
if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups
queryGroups(context: Context, holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| holder | Holder | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是 | 回调函数,返回查询到的群组对象数组。 |
**示例:**
```js
contact.queryGroups({
holderId: 0,
bundleName: "",
displayName: ""
}, (err, data) => {
if (err) {
console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryGroups
queryGroups(context: Context, holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;
查询联系人的所有群组,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;
查询联系人的所有群组,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| holder | [Holder](#holder) | 否 | 创建联系人的应用信息。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;[Group](#group)&gt;&gt; | 以Promise形式返回结果,返回查询到的群组对象数组。 |
**示例:**
```js
let promise = contact.queryGroups({
holderId: 0,
bundleName: "",
displayName: ""
});
promise.then((data) => {
console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryHolders
queryHolders(context: Context, callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
查询所有创建联系人的应用信息,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&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.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)
queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void
查询所有创建联系人的应用信息,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&gt;&gt; | 是 | 回调函数,返回查询到的创建联系人应用信息的对象数组。 |
**示例:**
```js
contact.queryHolders((err, data) => {
if (err) {
console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
return;
}
console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});
```
## contact.queryHolders
queryHolders(context: Context ): Promise&lt;Array&lt;Holder&gt;&gt;
查询所有创建联系人的应用信息,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt;
查询所有创建联系人的应用信息,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**返回值:**
| 类型 | 说明 |
| --------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[Holder](#holder)&gt;&gt; | 以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。 |
**示例:**
```js
let promise = contact.queryHolders();
promise.then((data) => {
console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err) => {
console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});
```
## contact.queryKey
queryKey(context: Context, id: number, callback: AsyncCallback&lt;string&gt;): void
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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)
queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void
...@@ -1427,9 +3410,59 @@ queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -1427,9 +3410,59 @@ queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void
}); });
``` ```
## contact.queryKey ## contact.queryKey
queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
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方式作为异步方法。
...@@ -1462,9 +3495,63 @@ queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): voi ...@@ -1462,9 +3495,63 @@ queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): voi
}); });
``` ```
## contact.queryKey ## contact.queryKey
queryKey(context: Context, id: number, holder?: Holder): Promise&lt;string&gt;
根据联系人的id查询联系人的key,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.READ_CONTACTS
**系统能力**:SystemCapability.Applications.ContactsData
**模型约束**:此接口仅可在Stage模型下使用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.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(deprecated)
queryKey(id: number, holder?: Holder): Promise&lt;string&gt; queryKey(id: number, holder?: Holder): Promise&lt;string&gt;
根据联系人的id查询联系人的key,使用Promise方式作为异步方法。 根据联系人的id查询联系人的key,使用Promise方式作为异步方法。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册