Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
eff2d8b0
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
eff2d8b0
编写于
8月 31, 2023
作者:
O
openharmony_ci
提交者:
Gitee
8月 31, 2023
浏览文件
操作
浏览文件
下载
差异文件
!23454 联系人API10接口文档更新 for monthly
Merge pull request !23454 from zhouhongli2023/monthly_20230815
上级
1887e3fc
f1916bb2
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
2513 addition
and
220 deletion
+2513
-220
zh-cn/application-dev/reference/apis/js-apis-contact.md
zh-cn/application-dev/reference/apis/js-apis-contact.md
+2513
-220
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-contact.md
浏览文件 @
eff2d8b0
...
...
@@ -13,12 +13,64 @@
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
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| contact |
[
Contact
](
#contact
)
| 是 | 联系人信息。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数,返回添加的联系人id。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
addContact
(
globalThis
.
context
as
Context
,
{
name
:
{
fullName
:
'
xxx
'
},
phoneNumbers
:
[{
phoneNumber
:
'
138xxxxxxxx
'
}]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`addContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`addContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.addContact(deprecated)<sup>7+</sup>
addContact(contact:Contact, callback:AsyncCallback
<
number
>
): void
添加联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -45,13 +97,68 @@ addContact(contact:Contact, callback:AsyncCallback<number>): void
});
```
## contact.addContact<sup>10+</sup>
addContact(context: Context, contact: Contact): Promise<number
>
添加联系人,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| contact |
[
Contact
](
#contact
)
| 是 | 联系人信息。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------------------------- |
| Promise
<
number
>
| 以Promise形式返回结果,返回添加的联系人id。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
addContact
(
globalThis
.
context
as
Context
,
{
name
:
{
fullName
:
'
xxx
'
},
phoneNumbers
:
[{
phoneNumber
:
'
138xxxxxxxx
'
}]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`addContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`addContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.addContact
## contact.addContact
(deprecated)<sup>7+</sup>
addContact(contact: Contact): Promise
<
number
>
添加联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[addContact](#contactaddcontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -82,13 +189,60 @@ addContact(contact: Contact): Promise<number>
});
```
## contact.deleteContact<sup>10+</sup>
deleteContact(context: Context, key: string, callback: AsyncCallback
<
void
>
): void
删除联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人key值,一个联系人对应一个key。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回删除联系人的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
deleteContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
(
err
)
=>
{
if
(
err
)
{
console
.
log
(
`deleteContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
'
deleteContact success
'
);
});
```
## contact.deleteContact
## contact.deleteContact
(deprecated)<sup>7+</sup>
deleteContact(key: string, callback: AsyncCallback
<
void
>
): void
删除联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[deleteContact](#contactdeletecontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -113,12 +267,64 @@ deleteContact(key: string, callback: AsyncCallback<void>): void
```
## contact.deleteContact
## contact.deleteContact<sup>10+</sup>
deleteContact(context: Context, key: string): Promise
<
void
>
删除联系人,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | --------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回删除联系人的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
deleteContact
(
globalThis
.
context
as
Context
,
'
xxx
'
);
promise
.
then
(()
=>
{
console
.
log
(
`deleteContact success`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`deleteContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.deleteContact(deprecated)<sup>7+</sup>
deleteContact(key: string): Promise
<
void
>
删除联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[deleteContact](#contactdeletecontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -147,12 +353,64 @@ deleteContact(key: string): Promise<void>
```
## contact.updateContact
## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, callback: AsyncCallback
<
void
>
): void
更新联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| contact |
[
Contact
](
#contact
)
| 是 | 联系人信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回更新联系人的更新结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
updateContact
(
globalThis
.
context
as
Context
,
{
id
:
1
,
name
:
{
fullName
:
'
xxx
'
},
phoneNumbers
:
[{
phoneNumber
:
'
138xxxxxxxx
'
}]
},
(
err
)
=>
{
if
(
err
)
{
console
.
log
(
'
updateContact callback: err->${JSON.stringify(err)}
'
);
return
;
}
console
.
log
(
'
updateContact success
'
);
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, callback: AsyncCallback
<
void
>
): void
更新联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -181,12 +439,67 @@ updateContact(contact: Contact, callback: AsyncCallback<void>): void
```
## contact.updateContact
## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback
<
void
>
): void
更新联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| contact |
[
Contact
](
#contact
)
| 是 | 联系人信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回更新联系人的更新结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
updateContact
(
globalThis
.
context
as
Context
,
{
id
:
1
,
name
:
{
fullName
:
'
xxx
'
},
phoneNumbers
:
[{
phoneNumber
:
'
138xxxxxxxx
'
}]
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
)
=>
{
if
(
err
)
{
console
.
log
(
'
updateContact callback: err->${JSON.stringify(err)}
'
);
return
;
}
console
.
log
(
'
updateContact success
'
);
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback
<
void
>
): void
更新联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -218,12 +531,71 @@ updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallbac
```
## contact.updateContact
## contact.updateContact<sup>10+</sup>
updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise
<
void
>
更新联系人,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| contact |
[
Contact
](
#contact
)
| 是 | 联系人信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回更新联系人的更新结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
updateContact
(
globalThis
.
context
as
Context
,
{
id
:
1
,
name
:
{
fullName
:
'
xxx
'
},
phoneNumbers
:
[{
phoneNumber
:
'
138xxxxxxxx
'
}]
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
(()
=>
{
console
.
log
(
'
updateContact success
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
`updateContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.updateContact(deprecated)<sup>7+</sup>
updateContact(contact: Contact, attrs?: ContactAttributes): Promise
<
void
>
更新联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
**需要权限**
:ohos.permission.WRITE_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -258,9 +630,9 @@ updateContact(contact: Contact, attrs?: ContactAttributes): Promise<void>
```
## contact.isLocalContact
## contact.isLocalContact
<sup>10+</sup>
isLocalContact(id: number, callback: AsyncCallback
<
boolean
>
): void
isLocalContact(
context: Context,
id: number, callback: AsyncCallback
<
boolean
>
): void
判断当前联系人id是否在电话簿中,使用callback方式作为异步方法。
...
...
@@ -272,13 +644,28 @@ isLocalContact(id: number, callback: AsyncCallback<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
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
)
{
console
.
log
(
`isLocalContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
...
...
@@ -287,12 +674,15 @@ isLocalContact(id: number, callback: AsyncCallback<boolean>): void
});
```
## contact.isLocalContact(deprecated)<sup>7+</sup>
## contact.isLocalContact
isLocalContact(id: number, callback: AsyncCallback
<
boolean
>
): void
isLocalContact(id: number): Promise
<
boolean
>
判断当前联系人id是否在电话簿中,使用callback方式作为异步方法。
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[isLocalContact](#contactislocalcontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -300,33 +690,28 @@ isLocalContact(id: number): Promise<boolean>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
**示例:**
```
js
let
promise
=
contact
.
isLocalContact
(
/*id*/
1
);
promise
.
then
((
data
)
=>
{
console
.
log
(
`isLocalContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`isLocalContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
contact
.
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>
## contact.isMyCard
isMyCard(id: number, callback: AsyncCallback
<
boolean
>
): void
isLocalContact(context: Context, id: number): Promise
<
boolean
>
判断
是否为“我的名片”,使用callback
方式作为异步方法。
判断
当前联系人id是否在电话簿中,使用Promise
方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -334,7 +719,138 @@ isMyCard(id: number, callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
isLocalContact
(
globalThis
.
context
as
Context
,
/*id*/
1
);
promise
.
then
((
data
)
=>
{
console
.
log
(
`isLocalContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`isLocalContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.isLocalContact(deprecated)<sup>7+</sup>
isLocalContact(id: number): Promise
<
boolean
>
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。
> **说明**
>从API version 7 开始支持,从API 10 开始废弃,建议使用[isLocalContact](#contactislocalcontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| id | number | 是 | 联系人对象的id属性,一个联系人对应一个id。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
**示例:**
```
js
let
promise
=
contact
.
isLocalContact
(
/*id*/
1
);
promise
.
then
((
data
)
=>
{
console
.
log
(
`isLocalContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`isLocalContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.isMyCard<sup>10+</sup>
isMyCard(context: Context, id: number, callback: AsyncCallback
<
boolean
>
): void
判断是否为“我的名片”,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
isMyCard
(
globalThis
.
context
as
Context
,
/*id*/
1
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`isMyCard callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`isMyCard callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.isMyCard(deprecated)<sup>7+</sup>
isMyCard(id: number, callback: AsyncCallback
<
boolean
>
): void
判断是否为“我的名片”,使用callback方式作为异步方法。
> **说明**
>从API version 7 开始支持,从API 10 开始废弃,建议使用[isMyCard](#contactismycard10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |
...
...
@@ -352,12 +868,64 @@ isMyCard(id: number, callback: AsyncCallback<boolean>): void
```
## contact.isMyCard
## contact.isMyCard<sup>10+</sup>
isMyCard(context: Context, id: number): Promise
<
boolean
>
判断是否为“我的名片”,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性。 |
**返回值:**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
isMyCard
(
globalThis
.
context
as
Context
,
/*id*/
1
);
promise
.
then
((
data
)
=>
{
console
.
log
(
`isMyCard success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`isMyCard fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.isMyCard(deprecated)<sup>7+</sup>
isMyCard(id: number): Promise
<
boolean
>
判断是否为“我的名片”,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[isMyCard](#contactismycard10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -385,13 +953,59 @@ isMyCard(id: number): Promise<boolean>
});
```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, callback: AsyncCallback
<
Contact
>
): void
## contact.queryMyCard
查询“我的名片”,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回“我的名片”信息。 |
**错误码:**
| 错误码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(deprecated)<sup>7+</sup>
queryMyCard(callback: AsyncCallback
<
Contact
>
): void
查询“我的名片”,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -414,13 +1028,62 @@ queryMyCard(callback: AsyncCallback<Contact>): void
});
```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
查询“我的名片”,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回“我的名片”信息。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryMyCard
(
globalThis
.
context
as
Context
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryMyCard callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryMyCard callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryMyCard
## contact.queryMyCard
(deprecated)<sup>7+</sup>
queryMyCard(attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
查询“我的名片”,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -446,13 +1109,66 @@ queryMyCard(attrs: ContactAttributes, callback: AsyncCallback<Contact>): v
});
```
## contact.queryMyCard<sup>10+</sup>
queryMyCard(context: Context, attrs?: ContactAttributes): Promise
<
Contact
>
查询“我的名片”,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------------------------------------------- |
| Promise
<
[Contact](#contact)
>
| 以Promise形式返回结果,返回“我的名片”信息。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryMyCard
(
globalThis
.
context
as
Context
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryMyCard success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryMyCard fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryMyCard
## contact.queryMyCard
(deprecated)<sup>7+</sup>
queryMyCard(attrs?: ContactAttributes): Promise
<
Contact
>
查询“我的名片”,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -482,12 +1198,16 @@ queryMyCard(attrs?: ContactAttributes): Promise<Contact>
```
## contact.selectContact
## contact.selectContact
(deprecated)<sup>7+</sup>
selectContact(callback: AsyncCallback
<
Array
<
Contact
>>
): void
选择联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[selectContacts](#contactselectcontacts10)
**系统能力**
:SystemCapability.Applications.Contacts
**参数:**
...
...
@@ -509,12 +1229,16 @@ selectContact(callback: AsyncCallback<Array<Contact>>): void
```
## contact.selectContact
## contact.selectContact
(deprecated)<sup>7+</sup>
selectContact(): Promise
<
Array
<
Contact
>>
选择联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[selectContacts](#contactselectcontacts10)
**系统能力**
:SystemCapability.Applications.Contacts
**返回值:**
...
...
@@ -534,63 +1258,148 @@ selectContact(): Promise<Array<Contact>>
});
```
## contact.selectContacts<sup>10+</sup>
## contact.queryContact
queryContact(key: string, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
selectContacts(callback: AsyncCallback
<
Array
<
Contact
>>
): void
**需要权限**
:ohos.permission.READ_CONTACTS
选择联系人,使用callback方式作为异步方法。
**系统能力**
:SystemCapability.Applications.Contacts
Data
**系统能力**
:SystemCapability.Applications.Contacts
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回选择的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContact
(
'
xxx
'
,
(
err
,
data
)
=>
{
contact
.
selectContacts
(
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`
query
Contact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
console
.
log
(
`
select
Contact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`
query
Contact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
console
.
log
(
`
select
Contact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.selectContacts<sup>10+</sup>
## contact.queryContact
queryContact(key: string, holder: Holder, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
selectContacts(): Promise
<
Array
<
Contact
>>
**需要权限**
:ohos.permission.READ_CONTACTS
选择联系人,使用Promise方式作为异步方法。
**系统能力**
:SystemCapability.Applications.Contacts
Data
**系统能力**
:SystemCapability.Applications.Contacts
**
参数
:**
**
返回值
:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回选择的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContact
(
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
let
promise
=
contact
.
selectContacts
();
promise
.
then
((
data
)
=>
{
console
.
log
(
`selectContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`selectContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.selectContacts<sup>10+</sup>
selectContacts(options: ContactSelectionOptions, callback: AsyncCallback
<
Array
<
Contact
>>
): void
选择联系人,使用callback方式作为异步方法。
**系统能力**
:SystemCapability.Applications.Contacts
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| options | ContactSelectionOptions | 是 | 选择联系人时的筛选条件 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回选择的联系人对象数组。 |
**示例:**
```
js
contact
.
selectContacts
({
isMultiSelect
:
false
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`selectContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`selectContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.selectContacts<sup>10+</sup>
selectContacts(options: ContactSelectionOptions): Promise
<
Array
<
Contact
>>
选择联系人,使用Promise方式作为异步方法。
**系统能力**
:SystemCapability.Applications.Contacts
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------- |
| options | ContactSelectionOptions | 是 | 选择联系人时的筛选条件 |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回选择的联系人对象数组。 |
**示例:**
```
js
let
promise
=
contact
.
selectContacts
({
isMultiSelect
:
false
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`selectContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`selectContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContact<sup>10+</sup>
queryContact(context: Context, key: string, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
...
...
@@ -599,13 +1408,16 @@ queryContact(key: string, holder: Holder, callback: AsyncCallback<Contact>
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContact
queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
queryContact(key: string, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -615,15 +1427,12 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**示例:**
```
js
contact
.
queryContact
(
'
xxx
'
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
contact
.
queryContact
(
'
xxx
'
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
...
...
@@ -633,12 +1442,65 @@ queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<
```
## contact.queryContact
## contact.queryContact
<sup>10+</sup>
queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
queryContact(key: string, holder: Holder, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -649,7 +1511,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**示例:**
...
...
@@ -659,8 +1520,6 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
...
...
@@ -670,12 +1529,11 @@ queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: As
});
```
## contact.queryContact<sup>10+</sup>
## contact.queryContact
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Contact
>
queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
根据key查询联系人,使用
Promise
方式作为异步方法。
根据key查询联系人,使用
callback
方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -683,40 +1541,50 @@ queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&l
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- |
| Promise
<
[Contact](#contact)
>
| 以Promise形式返回结果,返回查询到的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
let
promise
=
contact
.
queryContact
(
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContacts
queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
queryContacts(callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据key查询联系人,使用callback方式作为异步方法。
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -724,28 +1592,31 @@ queryContacts(callback: AsyncCallback<Array<Contact>>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**示例:**
```
js
contact
.
queryContacts
((
err
,
data
)
=>
{
contact
.
queryContact
(
'
xxx
'
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact
s
callback: err->
${
JSON
.
stringify
(
err
)}
`
);
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContact
s
callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
console
.
log
(
`queryContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContact<sup>10+</sup>
## contact.queryContacts
queryContacts(holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
查询所有
联系人,使用callback方式作为异步方法。
根据key查询
联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -753,33 +1624,55 @@ queryContacts(holder: Holder, callback: AsyncCallback<Array<Contact>>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
contact
.
queryContacts
({
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact
s
callback: err->
${
JSON
.
stringify
(
err
)}
`
);
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContact
s
callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
console
.
log
(
`queryContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
```
## contact.queryContact(deprecated)<sup>7+</sup>
## contact.queryContacts
queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Contact
>
): void
queryContacts(attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据key查询联系人,使用callback方式作为异步方法。
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -787,31 +1680,37 @@ queryContacts(attrs: ContactAttributes, callback: AsyncCallback<Array<Cont
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
[Contact](#contact)
>
| 是 | 回调函数,返回查询的联系人对象。 |
**示例:**
```
js
contact
.
queryContacts
({
contact
.
queryContact
(
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContact
s
callback: err->
${
JSON
.
stringify
(
err
)}
`
);
console
.
log
(
`queryContact callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContact
s
callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
console
.
log
(
`queryContact callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContact
s
## contact.queryContact
<sup>10+</sup>
queryContact
s(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContact
(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Contact
>
查询所有联系人,使用callback
方式作为异步方法。
根据key查询联系人,使用Promise
方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -819,36 +1718,693 @@ queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- |
| Promise
<
[Contact](#contact)
>
| 以Promise形式返回结果,返回查询到的联系人对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryContact
(
globalThis
.
context
as
Context
,
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContact(deprecated)<sup>7+</sup>
queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Contact
>
根据key查询联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | -------------------------------------- |
| key | string | 是 | 联系人的key值,一个联系人对应一个key。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ----------------------------------------------- |
| Promise
<
[Contact](#contact)
>
| 以Promise形式返回结果,返回查询到的联系人对象。 |
**示例:**
```
js
let
promise
=
contact
.
queryContact
(
'
xxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContact success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContact fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContacts
(
globalThis
.
context
as
Context
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContacts
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContacts
(
globalThis
.
context
as
Context
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContacts
({
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContacts
(
globalThis
.
context
as
Context
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContacts
({
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContacts
(
globalThis
.
context
as
Context
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContacts
({
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContacts<sup>10+</sup>
queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
查询所有联系人,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryContacts
(
globalThis
.
context
as
Context
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContacts success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContacts fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContacts(deprecated)<sup>7+</sup>
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
查询所有联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**示例:**
```
js
let
promise
=
contact
.
queryContacts
({
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContacts success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContacts fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByPhoneNumber
(
globalThis
.
context
as
Context
,
'
138xxxxxxxx
'
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByPhoneNumber callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByPhoneNumber callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContactsByPhoneNumber
(
'
138xxxxxxxx
'
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByPhoneNumber callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByPhoneNumber callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByPhoneNumber
(
globalThis
.
context
as
Context
,
'
138xxxxxxxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByPhoneNumber callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByPhoneNumber callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContacts
(
{
contact
.
queryContacts
ByPhoneNumber
(
'
138xxxxxxxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContacts callback: err->
${
JSON
.
stringify
(
err
)}
`
);
console
.
log
(
`queryContacts
ByPhoneNumber
callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContacts callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
console
.
log
(
`queryContacts
ByPhoneNumber
callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContacts
queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
查询所有联系人,使用Promise
方式作为异步方法。
根据电话号码查询联系人,使用callback
方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -856,40 +2412,51 @@ queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise<Array<C
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------------- | ---- | ---------------------- |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
let
promise
=
contact
.
queryContacts
({
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByPhoneNumber
(
globalThis
.
context
as
Context
,
'
138xxxxxxxx
'
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContacts success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContacts fail: err->
${
JSON
.
stringify
(
err
)}
`
);
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByPhoneNumber callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByPhoneNumber callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -899,12 +2466,15 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**示例:**
```
js
contact
.
queryContactsByPhoneNumber
(
'
138xxxxxxxx
'
,
(
err
,
data
)
=>
{
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
;
...
...
@@ -913,10 +2483,9 @@ queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
...
...
@@ -926,19 +2495,37 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
contact
.
queryContactsByPhoneNumber
(
'
138xxxxxxxx
'
,
{
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByPhoneNumber
(
globalThis
.
context
as
Context
,
'
138xxxxxxxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByPhoneNumber callback: err->
${
JSON
.
stringify
(
err
)}
`
);
...
...
@@ -948,13 +2535,16 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncC
});
```
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据电话号码查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -964,6 +2554,7 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
...
...
@@ -971,6 +2562,10 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
```
js
contact
.
queryContactsByPhoneNumber
(
'
138xxxxxxxx
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
...
...
@@ -981,12 +2576,11 @@ queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callba
});
```
## contact.queryContactsByPhoneNumber<sup>10+</sup>
## contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
根据电话号码查询联系人,使用
callback
方式作为异步方法。
根据电话号码查询联系人,使用
Promise
方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
...
...
@@ -994,38 +2588,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAt
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| phoneNumber | string | 是 | 联系人的电话号码。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
contact
.
queryContactsByPhoneNumber
(
'
138xxxxxxxx
'
,
{
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryContactsByPhoneNumber
(
globalThis
.
context
as
Context
,
'
138xxxxxxxx
'
,
{
holderId
:
0
,
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
)}
`
);
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContactsByPhoneNumber success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContactsByPhoneNumber fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContactsByPhoneNumber
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
根据电话号码查询联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1061,13 +2677,60 @@ queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: Contact
});
```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| email | string | 是 | 联系人的邮箱地址。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByEmail
(
globalThis
.
context
as
Context
,
'
xxx@email.com
'
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByEmail callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByEmail callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByEmail
## contact.queryContactsByEmail
(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1091,13 +2754,65 @@ queryContactsByEmail(email: string, callback: AsyncCallback<Array<Contact&
});
```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByEmail
(
globalThis
.
context
as
Context
,
'
xxx@email.com
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByEmail callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByEmail callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByEmail
## contact.queryContactsByEmail
(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1126,13 +2841,63 @@ queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback<A
});
```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| email | string | 是 | 联系人的邮箱地址。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByEmail
(
globalThis
.
context
as
Context
,
'
xxx@email.com
'
,
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByEmail callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByEmail callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByEmail
## contact.queryContactsByEmail
(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1159,13 +2924,68 @@ queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCal
});
```
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 是 | 联系人的属性列表。 |
| callback | AsyncCallback
<
Array
<
[Contact](#contact)
>>
| 是 | 回调函数,返回查询到联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryContactsByEmail
(
globalThis
.
context
as
Context
,
'
xxx@email.com
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryContactsByEmail callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryContactsByEmail callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryContactsByEmail
## contact.queryContactsByEmail
(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback
<
Array
<
Contact
>>
): void
根据email查询联系人,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1197,13 +3017,72 @@ queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, ca
});
```
## contact.queryContactsByEmail
## contact.queryContactsByEmail<sup>10+</sup>
queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
根据email查询联系人,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| email | string | 是 | 联系人的邮箱地址。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
| attrs |
[
ContactAttributes
](
#contactattributes
)
| 否 | 联系人的属性列表。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise
<
Array
<
[Contact](#contact)
>>
| 以Promise形式返回结果,返回查询到的联系人对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryContactsByEmail
(
globalThis
.
context
as
Context
,
'
xxx@email.com
'
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
{
attributes
:
[
contact
.
Attribute
.
ATTR_EMAIL
,
contact
.
Attribute
.
ATTR_NAME
]
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryContactsByEmail success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryContactsByEmail fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise
<
Array
<
Contact
>>
根据email查询联系人,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1239,13 +3118,59 @@ queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes):
});
```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, callback: AsyncCallback
<
Array
<
Group
>>
): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| callback | AsyncCallback
<
Array
<
[Group](#group)
>>
| 是 | 回调函数,返回查询到的群组对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryGroups
(
globalThis
.
context
as
Context
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryGroups callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryGroups callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryGroups
## contact.queryGroups
(deprecated)<sup>7+</sup>
queryGroups(callback: AsyncCallback
<
Array
<
Group
>>
): void
查询联系人的所有群组,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1268,13 +3193,64 @@ queryGroups(callback: AsyncCallback<Array<Group>>): void
});
```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, holder: Holder, callback: AsyncCallback
<
Array
<
Group
>>
): void
查询联系人的所有群组,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| holder | Holder | 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
Array
<
[Group](#group)
>>
| 是 | 回调函数,返回查询到的群组对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryGroups
(
globalThis
.
context
as
Context
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryGroups callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryGroups callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryGroups
## contact.queryGroups
(deprecated)<sup>7+</sup>
queryGroups(holder: Holder, callback: AsyncCallback
<
Array
<
Group
>>
): void
查询联系人的所有群组,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1302,13 +3278,68 @@ queryGroups(holder: Holder, callback: AsyncCallback<Array<Group>>):
});
```
## contact.queryGroups<sup>10+</sup>
queryGroups(context: Context, holder?: Holder): Promise
<
Array
<
Group
>>
查询联系人的所有群组,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------- | ------------------------------------------------- |
| Promise
<
Array
<
[Group](#group)
>>
| 以Promise形式返回结果,返回查询到的群组对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryGroups
(
globalThis
.
context
as
Context
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryGroups success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryGroups fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryGroups
## contact.queryGroups
(deprecated)<sup>7+</sup>
queryGroups(holder?: Holder): Promise
<
Array
<
Group
>>
查询联系人的所有群组,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1340,13 +3371,59 @@ queryGroups(holder?: Holder): Promise<Array<Group>>
});
```
## contact.queryHolders<sup>10+</sup>
queryHolders(context: Context, callback: AsyncCallback
<
Array
<
Holder
>>
): void
查询所有创建联系人的应用信息,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| callback | AsyncCallback
<
Array
<
[Holder](#holder)
>>
| 是 | 回调函数,返回查询到的创建联系人应用信息的对象数组。 |
## contact.queryHolders
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryHolders
(
globalThis
.
context
as
Context
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryHolders callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryHolders callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryHolders(deprecated)<sup>7+</sup>
queryHolders(callback: AsyncCallback
<
Array
<
Holder
>>
): void
查询所有创建联系人的应用信息,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryHolders](#contactqueryholders10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1369,13 +3446,63 @@ queryHolders(callback: AsyncCallback<Array<Holder>>): void
});
```
## contact.queryHolders<sup>10+</sup>
## contact.queryHolders
queryHolders(context: Context ): Promise
<
Array
<
Holder
>>
查询所有创建联系人的应用信息,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------------------- | ------------------------------------------------------------ |
| Promise
<
Array
<
[Holder](#holder)
>>
| 以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryHolders
(
globalThis
.
context
as
Context
);
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryHolders success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryHolders fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryHolders(deprecated)<sup>7+</sup>
queryHolders(): Promise
<
Array
<
Holder
>>
查询所有创建联系人的应用信息,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryHolders](#contactqueryholders10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1397,13 +3524,60 @@ queryHolders(): Promise<Array<Holder>>
});
```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, callback: AsyncCallback
<
string
>
): void
## contact.queryKey
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回查询到的联系人对应的key。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryKey
(
globalThis
.
context
as
Context
,
/*id*/
1
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryKey callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryKey callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryKey(deprecated)<sup>7+</sup>
queryKey(id: number, callback: AsyncCallback
<
string
>
): void
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1427,13 +3601,65 @@ queryKey(id: number, callback: AsyncCallback<string>): void
});
```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback
<
string
>
): void
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder |
[
Holder
](
#holder
)
| 是 | 创建联系人的应用信息。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回查询到的联系人对应的key。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
contact
.
queryKey
(
globalThis
.
context
as
Context
,
/*id*/
1
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
log
(
`queryKey callback: err->
${
JSON
.
stringify
(
err
)}
`
);
return
;
}
console
.
log
(
`queryKey callback: success data->
${
JSON
.
stringify
(
data
)}
`
);
});
```
## contact.queryKey
## contact.queryKey
(deprecated)<sup>7+</sup>
queryKey(id: number, holder: Holder, callback: AsyncCallback
<
string
>
): void
根据联系人的id查询联系人的key,使用callback方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1462,13 +3688,69 @@ queryKey(id: number, holder: Holder, callback: AsyncCallback<string>): voi
});
```
## contact.queryKey<sup>10+</sup>
queryKey(context: Context, id: number, holder?: Holder): Promise
<
string
>
根据联系人的id查询联系人的key,使用Promise方式作为异步方法。
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context | 是 | 应用上下文Context,Stage模型的应用Context定义见
[
Context
](
js-apis-inner-application-context.md
)
。 |
| id | number | 是 | 联系人对象的id属性。 |
| holder |
[
Holder
](
#holder
)
| 否 | 创建联系人的应用信息。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------------------------------------------------- |
| Promise
<
string
>
| 以Promise形式返回结果,返回查询到的联系人对应的key。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 201 | Permission denied. |
| 401 | Parameter error. |
**示例:**
```
js
// 获取context
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
){
globalThis
.
context
=
this
.
context
;
}
}
let
promise
=
contact
.
queryKey
(
globalThis
.
context
as
Context
,
/*id*/
1
,
{
holderId
:
0
,
bundleName
:
""
,
displayName
:
""
});
promise
.
then
((
data
)
=>
{
console
.
log
(
`queryKey success: data->
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`queryKey fail: err->
${
JSON
.
stringify
(
err
)}
`
);
});
```
## contact.queryKey
## contact.queryKey
(deprecated)<sup>7+</sup>
queryKey(id: number, holder?: Holder): Promise
<
string
>
根据联系人的id查询联系人的key,使用Promise方式作为异步方法。
> **说明**
>
> 从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.ContactsData
...
...
@@ -1501,6 +3783,17 @@ queryKey(id: number, holder?: Holder): Promise<string>
});
```
## ContactSelectionOptions<sup>10+</sup>
选择联系人条件。
**系统能力**
:SystemCapability.Applications.Contacts
| 名称 | 类型 | 必填 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---------------- |
| isMultiSelect
<sup>
10+
</sup>
| boolean | 否 | 是否为多选 |
## Contact
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录