js-apis-contact.md 168.7 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.contact (联系人)
O
ohos-lsw 已提交
2

T
explain  
tianyu 已提交
3 4
本模块提供联系人管理能力,包括添加联系人、删除联系人、更新联系人等

O
ohos-lsw 已提交
5 6 7 8 9 10 11 12 13 14 15
>**说明:**
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```
import contact from '@ohos.contact';
```

Z
update  
zhouhongli2023 已提交
16
## contact.addContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

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

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                        | 必填 | 说明                                                         |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                     | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| contact  | [Contact](#contact)         | 是   | 联系人信息。                                                 |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回添加的联系人id。                               |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
64
## contact.addContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
65 66 67 68 69

addContact(contact:Contact, callback:AsyncCallback&lt;number&gt;): void

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

Z
update  
zhouhongli2023 已提交
70
**说明**
Z
update  
zhouhongli2023 已提交
71
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
72

O
ohos-lsw 已提交
73 74 75 76 77
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
78

H
update  
HelloCrease 已提交
79 80 81 82
| 参数名   | 类型                        | 必填 | 说明                           |
| -------- | --------------------------- | ---- | ------------------------------ |
| contact  | [Contact](#contact)         | 是   | 联系人信息。                   |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回添加的联系人id。 |
O
ohos-lsw 已提交
83 84 85

**示例:**

Z
zengyawen 已提交
86
  ```js
O
ohos-lsw 已提交
87
  contact.addContact({
D
dingxiaochen 已提交
88
      name: {fullName: 'xxx'},
O
ohos-lsw 已提交
89 90 91 92 93 94 95 96 97 98
      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)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
99
## contact.addContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

addContact(context: Context, contact: Contact): Promise<number&gt;

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                | 必填 | 说明                                                         |
| ------- | ------------------- | ---- | ------------------------------------------------------------ |
| context | Context             | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| contact | [Contact](#contact) | 是   | 联系人信息。                                                 |

**返回值:**

| 类型                  | 说明                                        |
| --------------------- | ------------------------------------------- |
| Promise&lt;number&gt; | 以Promise形式返回结果,返回添加的联系人id。 |

**错误码:**

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

**示例:**

```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.addContact(
    globalThis.context as Context,
    {name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  });
  promise.then((data) => {
    console.log(`addContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
    console.error(`addContact fail: err->${JSON.stringify(err)}`);
  });
```
O
ohos-lsw 已提交
150

Z
update  
zhouhongli2023 已提交
151
## contact.addContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
152 153 154 155 156

addContact(contact: Contact): Promise&lt;number&gt;

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

Z
update  
zhouhongli2023 已提交
157
**说明**
Z
update  
zhouhongli2023 已提交
158
从API version 7 开始支持,从API 10 开始废弃,建议使用[addContact](#contactaddcontact10)
Z
update  
zhouhongli2023 已提交
159

O
ohos-lsw 已提交
160 161 162 163 164
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
165

H
update  
HelloCrease 已提交
166 167 168
| 参数名  | 类型                | 必填 | 说明         |
| ------- | ------------------- | ---- | ------------ |
| contact | [Contact](#contact) | 是   | 联系人信息。 |
O
ohos-lsw 已提交
169 170

**返回值:**
171

H
update  
HelloCrease 已提交
172 173
| 类型                  | 说明                                        |
| --------------------- | ------------------------------------------- |
O
ohos-lsw 已提交
174 175 176 177
| Promise&lt;number&gt; | 以Promise形式返回结果,返回添加的联系人id。 |

**示例:**

Z
zengyawen 已提交
178
  ```js
O
ohos-lsw 已提交
179 180 181 182 183 184 185 186 187 188 189
  let promise = contact.addContact({
      name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  });
  promise.then((data) => {
      console.log(`addContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`addContact fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
190
## contact.deleteContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

deleteContact(context: Context, key: string, callback: AsyncCallback&lt;void&gt;): void

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                      | 必填 | 说明                                                         |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                   | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key      | string                    | 是   | 联系人key值,一个联系人对应一个key。                         |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数,返回删除联系人的结果。                             |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
214

Z
update  
zhouhongli2023 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
**示例:**

```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');
  });
```

Z
update  
zhouhongli2023 已提交
234
## contact.deleteContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
235 236 237 238 239

deleteContact(key: string, callback: AsyncCallback&lt;void&gt;): void

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

Z
update  
zhouhongli2023 已提交
240
**说明**
Z
update  
zhouhongli2023 已提交
241
从API version 7 开始支持,从API 10 开始废弃,建议使用[deleteContact](#contactdeletecontact10)
Z
update  
zhouhongli2023 已提交
242

O
ohos-lsw 已提交
243 244 245 246 247
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
248

H
update  
HelloCrease 已提交
249 250 251 252
| 参数名   | 类型                      | 必填 | 说明                                 |
| -------- | ------------------------- | ---- | ------------------------------------ |
| key      | string                    | 是   | 联系人key值,一个联系人对应一个key。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数,返回删除联系人的结果。     |
O
ohos-lsw 已提交
253 254 255

**示例:**

Z
zengyawen 已提交
256
  ```js
O
ohos-lsw 已提交
257 258 259 260 261 262 263 264 265 266
  contact.deleteContact('xxx', (err) => {
      if (err) {
          console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log('deleteContact success');
  });
  ```


Z
update  
zhouhongli2023 已提交
267
## contact.deleteContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314

deleteContact(context: Context,  key: string): Promise&lt;void&gt;

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型    | 必填 | 说明                                                         |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key     | string  | 是   | 联系人的key值,一个联系人对应一个key。                       |

**返回值:**

| 类型                | 说明                                          |
| ------------------- | --------------------------------------------- |
| Promise&lt;void&gt; | 以Promise形式返回结果,返回删除联系人的结果。 |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.deleteContact(globalThis.context as Context, 'xxx');
  promise.then(() => {
      console.log(`deleteContact success`);
  }).catch((err) => {
      console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
315
## contact.deleteContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
316 317 318 319 320

deleteContact(key: string): Promise&lt;void&gt;

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

Z
update  
zhouhongli2023 已提交
321
**说明**
Z
update  
zhouhongli2023 已提交
322
从API version 7 开始支持,从API 10 开始废弃,建议使用[deleteContact](#contactdeletecontact10)
Z
update  
zhouhongli2023 已提交
323

O
ohos-lsw 已提交
324 325 326 327 328
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
329

H
update  
HelloCrease 已提交
330 331 332
| 参数名 | 类型   | 必填 | 说明                                   |
| ------ | ------ | ---- | -------------------------------------- |
| key    | string | 是   | 联系人的key值,一个联系人对应一个key。 |
O
ohos-lsw 已提交
333 334

**返回值:**
335

H
update  
HelloCrease 已提交
336 337
| 类型                | 说明                                          |
| ------------------- | --------------------------------------------- |
O
ohos-lsw 已提交
338 339 340 341
| Promise&lt;void&gt; | 以Promise形式返回结果,返回删除联系人的结果。 |

**示例:**

Z
zengyawen 已提交
342
  ```js
O
ohos-lsw 已提交
343 344 345 346 347 348 349 350 351
  let promise = contact.deleteContact('xxx');
  promise.then(() => {
      console.log(`deleteContact success`);
  }).catch((err) => {
      console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
352
## contact.updateContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399

updateContact(context: Context, contact: Contact, callback: AsyncCallback&lt;void&gt;): void

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                      | 必填 | 说明                                                         |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                   | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| contact  | [Contact](#contact)       | 是   | 联系人信息。                                                 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数,返回更新联系人的更新结果。                         |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
400
## contact.updateContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
401 402 403 404 405

updateContact(contact: Contact, callback: AsyncCallback&lt;void&gt;): void

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

Z
update  
zhouhongli2023 已提交
406
**说明**
Z
update  
zhouhongli2023 已提交
407
从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
Z
update  
zhouhongli2023 已提交
408

O
ohos-lsw 已提交
409 410 411 412 413
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
414

H
update  
HelloCrease 已提交
415 416 417 418
| 参数名   | 类型                      | 必填 | 说明                                 |
| -------- | ------------------------- | ---- | ------------------------------------ |
| contact  | [Contact](#contact)       | 是   | 联系人信息。                         |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数,返回更新联系人的更新结果。 |
O
ohos-lsw 已提交
419 420 421

**示例:**

Z
zengyawen 已提交
422
  ```js
O
ohos-lsw 已提交
423
  contact.updateContact({
W
fix doc  
w00636648 已提交
424
      id: 1,
O
ohos-lsw 已提交
425 426 427 428 429 430 431 432 433 434 435 436
      name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  }, (err) => {
      if (err) {
          console.log('updateContact callback: err->${JSON.stringify(err)}');
          return;
      }
      console.log('updateContact success');
  });
  ```


Z
update  
zhouhongli2023 已提交
437
## contact.updateContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487

updateContact(context: Context,  contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                    | 必填 | 说明                                                         |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| contact  | [Contact](#contact)                     | 是   | 联系人信息。                                                 |
| attrs    | [ContactAttributes](#contactattributes) | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;void&gt;               | 是   | 回调函数,返回更新联系人的更新结果。                         |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
488
## contact.updateContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
489 490 491 492 493

updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback&lt;void&gt;): void

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

Z
update  
zhouhongli2023 已提交
494
**说明**
Z
update  
zhouhongli2023 已提交
495
从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
Z
update  
zhouhongli2023 已提交
496

O
ohos-lsw 已提交
497 498 499 500 501
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
502

H
update  
HelloCrease 已提交
503 504 505 506 507
| 参数名   | 类型                                    | 必填 | 说明                                 |
| -------- | --------------------------------------- | ---- | ------------------------------------ |
| contact  | [Contact](#contact)                     | 是   | 联系人信息。                         |
| attrs    | [ContactAttributes](#contactattributes) | 是   | 联系人的属性列表。                   |
| callback | AsyncCallback&lt;void&gt;               | 是   | 回调函数,返回更新联系人的更新结果。 |
O
ohos-lsw 已提交
508 509 510

**示例:**

Z
zengyawen 已提交
511
  ```js
O
ohos-lsw 已提交
512
  contact.updateContact({
W
fix doc  
w00636648 已提交
513
      id: 1,
D
dingxiaochen 已提交
514
      name: {fullName: 'xxx'},
O
ohos-lsw 已提交
515
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
W
Modify  
w00636648 已提交
516 517
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
518 519 520 521 522 523 524 525 526 527
  }, (err) => {
      if (err) {
          console.log('updateContact callback: err->${JSON.stringify(err)}');
          return;
      }
      console.log('updateContact success');
  });
  ```


Z
update  
zhouhongli2023 已提交
528
## contact.updateContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

updateContact(context: Context,  contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;

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

**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| contact | [Contact](#contact)                     | 是   | 联系人信息。                                                 |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**

| 类型                | 说明                                              |
| ------------------- | ------------------------------------------------- |
| Promise&lt;void&gt; | 以Promise形式返回结果,返回更新联系人的更新结果。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
583
## contact.updateContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
584 585 586 587 588

updateContact(contact: Contact, attrs?: ContactAttributes): Promise&lt;void&gt;

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

Z
update  
zhouhongli2023 已提交
589
**说明**
Z
update  
zhouhongli2023 已提交
590
从API version 7 开始支持,从API 10 开始废弃,建议使用[updateContact](#contactupdatecontact10)
Z
update  
zhouhongli2023 已提交
591

O
ohos-lsw 已提交
592 593 594 595 596
**需要权限**:ohos.permission.WRITE_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
597

H
update  
HelloCrease 已提交
598 599 600 601
| 参数名  | 类型                                    | 必填 | 说明               |
| ------- | --------------------------------------- | ---- | ------------------ |
| contact | [Contact](#contact)                     | 是   | 联系人信息。       |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。 |
O
ohos-lsw 已提交
602 603

**返回值:**
H
update  
HelloCrease 已提交
604 605
| 类型                | 说明                                              |
| ------------------- | ------------------------------------------------- |
O
ohos-lsw 已提交
606 607 608 609
| Promise&lt;void&gt; | 以Promise形式返回结果,返回更新联系人的更新结果。 |

**示例:**

Z
zengyawen 已提交
610
  ```js
O
ohos-lsw 已提交
611
  let promise = contact.updateContact({
W
fix doc  
w00636648 已提交
612
      id: 1,
D
dingxiaochen 已提交
613
      name: {fullName: 'xxx'},
O
ohos-lsw 已提交
614 615
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  }, {
Q
qian-nan-xu 已提交
616
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
617 618 619 620 621 622 623 624 625
  });
  promise.then(() => {
      console.log('updateContact success');
  }).catch((err) => {
      console.error(`updateContact fail: err->${JSON.stringify(err)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
626
## contact.isLocalContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

isLocalContact(context: Context,  id: number, callback: AsyncCallback&lt;boolean&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                         | 必填 | 说明                                                         |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                      | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id       | number                       | 是   | 联系人对象的id属性,一个联系人对应一个id。                   |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数,返回布尔值。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;
    }
  }
  contact.isLocalContact(globalThis.context as Context, /*id*/1, (err, data) => {
      if (err) {
          console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
670
## contact.isLocalContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
671 672 673 674 675

isLocalContact(id: number, callback: AsyncCallback&lt;boolean&gt;): void

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

Z
update  
zhouhongli2023 已提交
676
**说明**
Z
update  
zhouhongli2023 已提交
677
从API version 7 开始支持,从API 10 开始废弃,建议使用[isLocalContact](#contactislocalcontact10)
Z
update  
zhouhongli2023 已提交
678

O
ohos-lsw 已提交
679 680 681 682 683
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
684

H
update  
HelloCrease 已提交
685 686 687 688
| 参数名   | 类型                         | 必填 | 说明                                                         |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id       | number                       | 是   | 联系人对象的id属性,一个联系人对应一个id。                   |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |
O
ohos-lsw 已提交
689 690 691

**示例:**

Z
zengyawen 已提交
692
  ```js
O
ohos-lsw 已提交
693 694 695 696 697 698 699 700 701
  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)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
702
## contact.isLocalContact<sup>10+</sup>
O
ohos-lsw 已提交
703

Z
update  
zhouhongli2023 已提交
704
isLocalContact(context: Context,  id: number): Promise&lt;boolean&gt;
O
ohos-lsw 已提交
705 706 707 708 709 710 711 712

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
713

Z
update  
zhouhongli2023 已提交
714 715 716 717
| 参数名  | 类型    | 必填 | 说明                                                         |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id      | number  | 是   | 联系人对象的id属性,一个联系人对应一个id。                   |
O
ohos-lsw 已提交
718 719

**返回值:**
720

H
update  
HelloCrease 已提交
721 722
| 类型                   | 说明                                                         |
| ---------------------- | ------------------------------------------------------------ |
O
ohos-lsw 已提交
723 724
| Promise&lt;boolean&gt; | 以Promise形式返回结果,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |

Z
update  
zhouhongli2023 已提交
725 726 727 728 729 730 731
**错误码:**

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

O
ohos-lsw 已提交
732 733
**示例:**

Z
update  
zhouhongli2023 已提交
734 735 736 737 738 739 740 741 742
```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);
O
ohos-lsw 已提交
743 744 745 746 747
  promise.then((data) => {
      console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
  });
Z
update  
zhouhongli2023 已提交
748
```
O
ohos-lsw 已提交
749

Z
update  
zhouhongli2023 已提交
750
## contact.isLocalContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
751

Z
update  
zhouhongli2023 已提交
752
isLocalContact(id: number): Promise&lt;boolean&gt;
O
ohos-lsw 已提交
753

Z
update  
zhouhongli2023 已提交
754
判断当前联系人id是否在电话簿中,使用Promise方式作为异步方法。
O
ohos-lsw 已提交
755

Z
update  
zhouhongli2023 已提交
756
**说明**
Z
update  
zhouhongli2023 已提交
757
从API version 7 开始支持,从API 10 开始废弃,建议使用[isLocalContact](#contactislocalcontact10)
Z
update  
zhouhongli2023 已提交
758

O
ohos-lsw 已提交
759 760 761 762 763
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
764

Z
update  
zhouhongli2023 已提交
765 766 767
| 参数名 | 类型   | 必填 | 说明                                       |
| ------ | ------ | ---- | ------------------------------------------ |
| id     | number | 是   | 联系人对象的id属性,一个联系人对应一个id。 |
O
ohos-lsw 已提交
768

Z
update  
zhouhongli2023 已提交
769
**返回值:**
O
ohos-lsw 已提交
770

Z
update  
zhouhongli2023 已提交
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
| 类型                   | 说明                                                         |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。 |

**示例:**

  ```js
  let promise = contact.isLocalContact(/*id*/1);
  promise.then((data) => {
      console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
786
## contact.isMyCard<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829

isMyCard(context: Context,  id: number, callback: AsyncCallback&lt;boolean&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                         | 必填 | 说明                                                         |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                      | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id       | number                       | 是   | 联系人对象的id属性。                                         |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |

**错误码:**

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

**示例:**

```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.isMyCard(globalThis.context as Context, /*id*/1, (err, data) => {
      if (err) {
          console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
  });
```

Z
update  
zhouhongli2023 已提交
830
## contact.isMyCard(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
831 832 833 834 835

isMyCard(id: number, callback: AsyncCallback&lt;boolean&gt;): void

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

Z
update  
zhouhongli2023 已提交
836
**说明**
Z
update  
zhouhongli2023 已提交
837
从API version 7 开始支持,从API 10 开始废弃,建议使用[isMyCard](#contactismycard10)
Z
update  
zhouhongli2023 已提交
838

Z
update  
zhouhongli2023 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                         | 必填 | 说明                                                         |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| id       | number                       | 是   | 联系人对象的id属性。                                         |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |

**示例:**

  ```js
  contact.isMyCard(/*id*/1, (err, data) => {
O
ohos-lsw 已提交
854 855 856 857 858 859 860 861 862
      if (err) {
          console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
863
## contact.isMyCard<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910

isMyCard(context: Context,  id: number): Promise&lt;boolean&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型    | 必填 | 说明                                                         |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id      | number  | 是   | 联系人对象的id属性。                                         |

**返回值:**

| 类型                   | 说明                                                         |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | 以Promise形式返回结果,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
911
## contact.isMyCard(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
912 913 914 915 916

isMyCard(id: number): Promise&lt;boolean&gt;

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

Z
update  
zhouhongli2023 已提交
917
**说明**
Z
update  
zhouhongli2023 已提交
918
从API version 7 开始支持,从API 10 开始废弃,建议使用[isMyCard](#contactismycard10)
Z
update  
zhouhongli2023 已提交
919

O
ohos-lsw 已提交
920 921 922 923 924
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
925

H
update  
HelloCrease 已提交
926 927 928
| 参数名 | 类型   | 必填 | 说明                 |
| ------ | ------ | ---- | -------------------- |
| id     | number | 是   | 联系人对象的id属性。 |
O
ohos-lsw 已提交
929 930

**返回值:**
931

H
update  
HelloCrease 已提交
932 933
| 类型                   | 说明                                                         |
| ---------------------- | ------------------------------------------------------------ |
O
ohos-lsw 已提交
934 935 936 937
| Promise&lt;boolean&gt; | 以Promise形式返回结果,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。 |

**示例:**

Z
zengyawen 已提交
938
  ```js
O
ohos-lsw 已提交
939 940 941 942 943 944 945 946
  let promise = contact.isMyCard(/*id*/1);
  promise.then((data) => {
      console.log(`isMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
947
## contact.queryMyCard<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988

queryMyCard(context: Context,  callback: AsyncCallback&lt;Contact&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回“我的名片”信息。                               |

**错误码:**

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

**示例:**

```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryMyCard(globalThis.context as Context, (err, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });
```
O
ohos-lsw 已提交
989

Z
update  
zhouhongli2023 已提交
990
## contact.queryMyCard(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
991 992 993 994 995

queryMyCard(callback: AsyncCallback&lt;Contact&gt;): void

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

Z
update  
zhouhongli2023 已提交
996
**说明**
Z
update  
zhouhongli2023 已提交
997
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
Z
update  
zhouhongli2023 已提交
998

O
ohos-lsw 已提交
999 1000 1001 1002 1003
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1004

H
update  
HelloCrease 已提交
1005 1006 1007
| 参数名   | 类型                                     | 必填 | 说明                           |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回“我的名片”信息。 |
O
ohos-lsw 已提交
1008 1009 1010

**示例:**

Z
zengyawen 已提交
1011
  ```js
O
ohos-lsw 已提交
1012 1013 1014 1015 1016 1017 1018 1019 1020
  contact.queryMyCard((err, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1021
## contact.queryMyCard<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

queryMyCard(context: Context,  attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回“我的名片”信息。                               |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
1045

Z
update  
zhouhongli2023 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
**示例:**

```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)}`);
  });
```

Z
update  
zhouhongli2023 已提交
1067
## contact.queryMyCard(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1068 1069 1070 1071 1072

queryMyCard(attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void

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

Z
update  
zhouhongli2023 已提交
1073
**说明**
Z
update  
zhouhongli2023 已提交
1074
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
Z
update  
zhouhongli2023 已提交
1075

O
ohos-lsw 已提交
1076 1077 1078 1079 1080
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1081

H
update  
HelloCrease 已提交
1082 1083 1084 1085
| 参数名   | 类型                                     | 必填 | 说明                           |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。             |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回“我的名片”信息。 |
O
ohos-lsw 已提交
1086 1087 1088

**示例:**

Z
zengyawen 已提交
1089
  ```js
O
ohos-lsw 已提交
1090
  contact.queryMyCard({
W
Modify  
w00636648 已提交
1091
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
1092 1093 1094 1095 1096 1097 1098 1099 1100
  }, (err, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1101
## contact.queryMyCard<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

queryMyCard(context: Context,  attrs?: ContactAttributes): Promise&lt;Contact&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**

| 类型                               | 说明                                        |
| ---------------------------------- | ------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果,返回“我的名片”信息。 |

**错误码:**

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

**示例:**

```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.queryMyCard(globalThis.context as Context, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then((data) => {
      console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
  });
```
O
ohos-lsw 已提交
1150

Z
update  
zhouhongli2023 已提交
1151
## contact.queryMyCard(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1152 1153 1154 1155 1156

queryMyCard(attrs?: ContactAttributes): Promise&lt;Contact&gt;

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

Z
update  
zhouhongli2023 已提交
1157
**说明**
Z
update  
zhouhongli2023 已提交
1158
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryMyCard](#contactquerymycard10)
Z
update  
zhouhongli2023 已提交
1159

O
ohos-lsw 已提交
1160 1161 1162 1163 1164
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1165

H
update  
HelloCrease 已提交
1166 1167 1168
| 参数名 | 类型                                    | 必填 | 说明               |
| ------ | --------------------------------------- | ---- | ------------------ |
| attrs  | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。 |
O
ohos-lsw 已提交
1169 1170

**返回值:**
H
update  
HelloCrease 已提交
1171 1172
| 类型                               | 说明                                        |
| ---------------------------------- | ------------------------------------------- |
O
ohos-lsw 已提交
1173 1174 1175 1176
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果,返回“我的名片”信息。 |

**示例:**

Z
zengyawen 已提交
1177
  ```js
O
ohos-lsw 已提交
1178
  let promise = contact.queryMyCard({
W
Modify  
w00636648 已提交
1179
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
1180 1181 1182 1183 1184 1185 1186 1187 1188
  });
  promise.then((data) => {
      console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
1189
## contact.selectContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1190

Z
zengyawen 已提交
1191
selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
1192 1193 1194

选择联系人,使用callback方式作为异步方法。

Z
update  
zhouhongli2023 已提交
1195 1196 1197
**说明**
从API version 7 开始支持,从API 10 开始废弃,建议使用[selectContacts](#contactselectcontacts10)

W
Modify  
w00636648 已提交
1198
**系统能力**:SystemCapability.Applications.Contacts
O
ohos-lsw 已提交
1199 1200

**参数:**
1201

H
update  
HelloCrease 已提交
1202 1203 1204
| 参数名   | 类型                                                  | 必填 | 说明                                 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回选择的联系人对象数组。 |
O
ohos-lsw 已提交
1205 1206 1207

**示例:**

Z
zengyawen 已提交
1208
  ```js
O
ohos-lsw 已提交
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
  contact.selectContact((err, data) => {
      if (err) {
          console.log(`selectContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
1219
## contact.selectContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1220 1221 1222 1223 1224

selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;

选择联系人,使用Promise方式作为异步方法。

Z
update  
zhouhongli2023 已提交
1225 1226 1227
**说明**
从API version 7 开始支持,从API 10 开始废弃,建议使用[selectContacts](#contactselectcontacts10)

W
Modify  
w00636648 已提交
1228
**系统能力**:SystemCapability.Applications.Contacts
O
ohos-lsw 已提交
1229 1230

**返回值:**
1231

H
update  
HelloCrease 已提交
1232 1233
| 类型                                            | 说明                                              |
| ----------------------------------------------- | ------------------------------------------------- |
O
ohos-lsw 已提交
1234 1235 1236 1237
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回选择的联系人对象数组。 |

**示例:**

Z
zengyawen 已提交
1238
  ```js
O
ohos-lsw 已提交
1239 1240 1241 1242 1243 1244 1245 1246
  let promise = contact.selectContact();
  promise.then((data) => {
      console.log(`selectContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`selectContact fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
## contact.selectContacts<sup>10+</sup>

selectContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

选择联系人,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Applications.Contacts

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回选择的联系人对象数组。 |

**示例:**

  ```js
  contact.selectContacts((err, data) => {
      if (err) {
          console.log(`selectContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

## contact.selectContacts<sup>10+</sup>

selectContacts(): Promise&lt;Array&lt;Contact&gt;&gt;

选择联系人,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Applications.Contacts

**返回值:**

| 类型                                            | 说明                                              |
| ----------------------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回选择的联系人对象数组。 |

**示例:**

  ```js
  let promise = contact.selectContacts();
  promise.then((data) => {
      console.log(`selectContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`selectContact fail: err->${JSON.stringify(err)}`);
  });
  ```

## contact.selectContacts<sup>10+</sup>

selectContacts(options: ContactSelectionOptions, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

选择联系人,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Applications.Contacts

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| options | ContactSelectionOptions | 是   | 选择联系人时的筛选条件 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回选择的联系人对象数组。 |

**示例:**

  ```js
  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&lt;Array&lt;Contact&gt;&gt;

选择联系人,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Applications.Contacts

**返回值:**

| 类型                                            | 说明                                              |
| ----------------------------------------------- | ------------------------------------------------- |
| options | ContactSelectionOptions | 是   | 选择联系人时的筛选条件 |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回选择的联系人对象数组。 |

**示例:**

  ```js
  let promise = contact.selectContacts({isMultiSelect:false});
  promise.then((data) => {
      console.log(`selectContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`selectContact fail: err->${JSON.stringify(err)}`);
  });
  ```
O
ohos-lsw 已提交
1352

Z
update  
zhouhongli2023 已提交
1353
## contact.queryContact<sup>10+</sup>
O
ohos-lsw 已提交
1354

Z
update  
zhouhongli2023 已提交
1355
queryContact(context: Context,  key: string,  callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1356 1357 1358 1359 1360 1361 1362 1363

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1364

Z
update  
zhouhongli2023 已提交
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。                       |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。                             |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
1377 1378 1379

**示例:**

Z
zengyawen 已提交
1380
  ```js
Z
update  
zhouhongli2023 已提交
1381 1382 1383 1384 1385 1386 1387 1388
  // 获取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) => {
O
ohos-lsw 已提交
1389 1390 1391 1392 1393 1394 1395 1396
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1397
## contact.queryContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1398

Z
update  
zhouhongli2023 已提交
1399
queryContact(key: string,  callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1400 1401 1402

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

Z
update  
zhouhongli2023 已提交
1403
**说明**
Z
update  
zhouhongli2023 已提交
1404
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
1405

O
ohos-lsw 已提交
1406 1407 1408 1409 1410
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1411

H
update  
HelloCrease 已提交
1412 1413 1414 1415
| 参数名   | 类型                                     | 必填 | 说明                                   |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。       |
O
ohos-lsw 已提交
1416 1417 1418

**示例:**

Z
zengyawen 已提交
1419
  ```js
Z
update  
zhouhongli2023 已提交
1420
  contact.queryContact('xxx', (err, data) => {
O
ohos-lsw 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
1430
## contact.queryContact<sup>10+</sup>
O
ohos-lsw 已提交
1431

Z
update  
zhouhongli2023 已提交
1432
queryContact(context: Context,  key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1433 1434 1435 1436 1437 1438 1439 1440

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1441

Z
update  
zhouhongli2023 已提交
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。                       |
| holder   | [Holder](#holder)                        | 是   | 创建联系人的应用信息。                                       |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。                             |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
1455 1456 1457

**示例:**

Z
zengyawen 已提交
1458
  ```js
Z
update  
zhouhongli2023 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
  // 获取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: ""
O
ohos-lsw 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1479
## contact.queryContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1480

Z
update  
zhouhongli2023 已提交
1481
queryContact(key: string, holder: Holder, callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1482 1483 1484

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

Z
update  
zhouhongli2023 已提交
1485
**说明**
Z
update  
zhouhongli2023 已提交
1486
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
1487

O
ohos-lsw 已提交
1488 1489 1490 1491 1492
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1493

H
update  
HelloCrease 已提交
1494 1495 1496 1497 1498
| 参数名   | 类型                                     | 必填 | 说明                                   |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。 |
| holder   | [Holder](#holder)                        | 是   | 创建联系人的应用信息。                 |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。       |
O
ohos-lsw 已提交
1499 1500 1501

**示例:**

Z
zengyawen 已提交
1502
  ```js
O
ohos-lsw 已提交
1503
  contact.queryContact('xxx', {
Q
qian-nan-xu 已提交
1504 1505 1506
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
1507 1508 1509 1510 1511 1512 1513 1514 1515
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1516
## contact.queryContact<sup>10+</sup>
O
ohos-lsw 已提交
1517

Z
update  
zhouhongli2023 已提交
1518
queryContact(context: Context,  key: string,  attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1519

Z
update  
zhouhongli2023 已提交
1520
根据key查询联系人,使用callback方式作为异步方法。
O
ohos-lsw 已提交
1521 1522 1523 1524 1525 1526

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1527

Z
update  
zhouhongli2023 已提交
1528 1529 1530 1531 1532 1533
| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。                       |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。                             |
O
ohos-lsw 已提交
1534

Z
update  
zhouhongli2023 已提交
1535 1536 1537 1538 1539 1540
**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
1541 1542 1543

**示例:**

Z
zengyawen 已提交
1544
  ```js
Z
update  
zhouhongli2023 已提交
1545 1546 1547 1548 1549 1550 1551 1552
  // 获取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', {
Q
qian-nan-xu 已提交
1553
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
Z
update  
zhouhongli2023 已提交
1554 1555 1556 1557 1558 1559
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
O
ohos-lsw 已提交
1560 1561 1562
  });
  ```

Z
update  
zhouhongli2023 已提交
1563
## contact.queryContact(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
1564

Z
update  
zhouhongli2023 已提交
1565
queryContact(key: string,  attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void
O
ohos-lsw 已提交
1566

Z
update  
zhouhongli2023 已提交
1567
根据key查询联系人,使用callback方式作为异步方法。
O
ohos-lsw 已提交
1568

Z
update  
zhouhongli2023 已提交
1569
**说明**
Z
update  
zhouhongli2023 已提交
1570
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
1571

O
ohos-lsw 已提交
1572 1573 1574 1575 1576
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1577

Z
update  
zhouhongli2023 已提交
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
| 参数名   | 类型                                     | 必填 | 说明                                   |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。 |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。                     |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。       |

**示例:**

  ```js
  contact.queryContact('xxx', {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1598
## contact.queryContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649

queryContact(context: Context,  key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                  | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。                       |
| holder   | [Holder](#holder)                        | 是   | 创建联系人的应用信息。                                       |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。                             |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
1650
## contact.queryContact(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
1651 1652 1653 1654 1655

queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Contact&gt;): void

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

Z
update  
zhouhongli2023 已提交
1656
**说明**
Z
update  
zhouhongli2023 已提交
1657
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
1658

Z
update  
zhouhongli2023 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                   |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| key      | string                                   | 是   | 联系人的key值,一个联系人对应一个key。 |
| holder   | [Holder](#holder)                        | 是   | 创建联系人的应用信息。                 |
| attrs    | [ContactAttributes](#contactattributes)  | 是   | 联系人的属性列表。                     |
| callback | AsyncCallback&lt;[Contact](#contact)&gt; | 是   | 回调函数,返回查询的联系人对象。       |

**示例:**

  ```js
  contact.queryContact('xxx', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
1691
## contact.queryContact<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745

queryContact(context: Context,  key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| key     | string                                  | 是   | 联系人的key值,一个联系人对应一个key。                       |
| holder  | [Holder](#holder)                       | 否   | 创建联系人的应用信息。                                       |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**
| 类型                               | 说明                                            |
| ---------------------------------- | ----------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果,返回查询到的联系人对象。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
1746
## contact.queryContact(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
1747 1748 1749 1750 1751

queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Contact&gt;

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

Z
update  
zhouhongli2023 已提交
1752
**说明**
Z
update  
zhouhongli2023 已提交
1753
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContact](#contactquerycontact10)
Z
update  
zhouhongli2023 已提交
1754

Z
update  
zhouhongli2023 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名 | 类型                                    | 必填 | 说明                                   |
| ------ | --------------------------------------- | ---- | -------------------------------------- |
| key    | string                                  | 是   | 联系人的key值,一个联系人对应一个key。 |
| holder | [Holder](#holder)                       | 否   | 创建联系人的应用信息。                 |
| attrs  | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                     |

**返回值:**
| 类型                               | 说明                                            |
| ---------------------------------- | ----------------------------------------------- |
| Promise&lt;[Contact](#contact)&gt; | 以Promise形式返回结果,返回查询到的联系人对象。 |

**示例:**

  ```js
  let promise = contact.queryContact('xxx', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then((data) => {
      console.log(`queryContact success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContact fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1789
## contact.queryContacts<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823

queryContacts(context: Context,  callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

| 错误码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) => {
O
ohos-lsw 已提交
1824 1825 1826 1827 1828 1829 1830 1831
      if (err) {
          console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1832
## contact.queryContacts(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
1833 1834 1835 1836 1837

queryContacts(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
1838
**说明**
Z
update  
zhouhongli2023 已提交
1839
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
Z
update  
zhouhongli2023 已提交
1840

Z
update  
zhouhongli2023 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |

**示例:**

  ```js
  contact.queryContacts((err, data) => {
      if (err) {
          console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  });
  ```
O
ohos-lsw 已提交
1862

Z
update  
zhouhongli2023 已提交
1863
## contact.queryContacts<sup>10+</sup>
O
ohos-lsw 已提交
1864

Z
update  
zhouhongli2023 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
queryContacts(context: Context,  holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
1911
## contact.queryContacts(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
1912

O
ohos-lsw 已提交
1913 1914 1915 1916
queryContacts(holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
1917
**说明**
Z
update  
zhouhongli2023 已提交
1918
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
Z
update  
zhouhongli2023 已提交
1919

O
ohos-lsw 已提交
1920 1921 1922 1923 1924
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
1925

H
update  
HelloCrease 已提交
1926 1927 1928 1929
| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
1930 1931 1932

**示例:**

Z
zengyawen 已提交
1933
  ```js
O
ohos-lsw 已提交
1934
  contact.queryContacts({
Q
qian-nan-xu 已提交
1935 1936 1937
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
1938 1939 1940 1941 1942 1943 1944 1945 1946
  }, (err, data) => {
      if (err) {
          console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
1947
## contact.queryContacts<sup>10+</sup>
O
ohos-lsw 已提交
1948

Z
update  
zhouhongli2023 已提交
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992
queryContacts(context: Context,  attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
1993
## contact.queryContacts(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
1994

O
ohos-lsw 已提交
1995 1996 1997 1998
queryContacts(attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
1999
**说明**
Z
update  
zhouhongli2023 已提交
2000
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
Z
update  
zhouhongli2023 已提交
2001

O
ohos-lsw 已提交
2002 2003 2004 2005 2006
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2007

H
update  
HelloCrease 已提交
2008 2009 2010 2011
| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                     |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2012 2013 2014

**示例:**

Z
zengyawen 已提交
2015
  ```js
O
ohos-lsw 已提交
2016
  contact.queryContacts({
Q
qian-nan-xu 已提交
2017
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2018 2019 2020 2021 2022 2023 2024 2025 2026
  }, (err, data) => {
      if (err) {
          console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2027
## contact.queryContacts<sup>10+</sup>
O
ohos-lsw 已提交
2028

Z
update  
zhouhongli2023 已提交
2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
queryContacts(context: Context,  holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
2078
## contact.queryContacts(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2079

C
clevercong 已提交
2080
queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
2081 2082 2083

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

Z
update  
zhouhongli2023 已提交
2084
**说明**
Z
update  
zhouhongli2023 已提交
2085
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
Z
update  
zhouhongli2023 已提交
2086

O
ohos-lsw 已提交
2087 2088 2089 2090 2091
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2092

H
update  
HelloCrease 已提交
2093 2094 2095 2096 2097
| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                 |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                     |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2098 2099 2100

**示例:**

Z
zengyawen 已提交
2101
  ```js
O
ohos-lsw 已提交
2102
  contact.queryContacts({
Q
qian-nan-xu 已提交
2103 2104 2105
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
2106
  }, {
Q
qian-nan-xu 已提交
2107
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2108 2109 2110 2111 2112 2113 2114 2115 2116
  }, (err, data) => {
      if (err) {
          console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2117
## contact.queryContacts<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170

queryContacts(context: Context,  holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder  | [Holder](#holder)                       | 否   | 创建联系人的应用信息。                                       |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**
| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
2171
## contact.queryContacts(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2172 2173 2174 2175 2176

queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;

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

Z
update  
zhouhongli2023 已提交
2177
**说明**
Z
update  
zhouhongli2023 已提交
2178
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContacts](#contactquerycontacts10)
Z
update  
zhouhongli2023 已提交
2179

Z
update  
zhouhongli2023 已提交
2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名 | 类型                                    | 必填 | 说明                   |
| ------ | --------------------------------------- | ---- | ---------------------- |
| holder | [Holder](#holder)                       | 否   | 创建联系人的应用信息。 |
| attrs  | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。     |

**返回值:**

| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**示例:**

```js
  let promise = contact.queryContacts({
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  });
  promise.then((data) => {
      console.log(`queryContacts success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
  });
```

Z
update  
zhouhongli2023 已提交
2214
## contact.queryContactsByPhoneNumber<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257

queryContactsByPhoneNumber(context: Context,  phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名      | 类型                                                  | 必填 | 说明                                                         |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context     | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                                           |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

  ```js
  // 获取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)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2258
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2259 2260 2261 2262 2263

queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2264
**说明**
Z
update  
zhouhongli2023 已提交
2265
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
Z
update  
zhouhongli2023 已提交
2266

Z
update  
zhouhongli2023 已提交
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名      | 类型                                                  | 必填 | 说明                                   |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                     |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |

**示例:**

  ```js
  contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => {
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  });
  ```


Z
update  
zhouhongli2023 已提交
2291
## contact.queryContactsByPhoneNumber<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339

queryContactsByPhoneNumber(context: Context,  phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名      | 类型                                                  | 必填 | 说明                                                         |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context     | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                                           |
| holder      | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 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)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2340
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2341 2342 2343 2344 2345

queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2346
**说明**
Z
update  
zhouhongli2023 已提交
2347
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
Z
update  
zhouhongli2023 已提交
2348

Z
update  
zhouhongli2023 已提交
2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名      | 类型                                                  | 必填 | 说明                                   |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                     |
| holder      | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                 |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |

**示例:**

  ```js
  contact.queryContactsByPhoneNumber('138xxxxxxxx', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  });
  ```
O
ohos-lsw 已提交
2376

Z
update  
zhouhongli2023 已提交
2377
## contact.queryContactsByPhoneNumber<sup>10+</sup>
O
ohos-lsw 已提交
2378

Z
update  
zhouhongli2023 已提交
2379
queryContactsByPhoneNumber(context: Context,  phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
2380

Z
update  
zhouhongli2023 已提交
2381
根据电话号码查询联系人,使用callback方式作为异步方法。
O
ohos-lsw 已提交
2382 2383 2384 2385 2386 2387

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2388

Z
update  
zhouhongli2023 已提交
2389 2390 2391 2392 2393 2394
| 参数名      | 类型                                                  | 必填 | 说明                                                         |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context     | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                                           |
| attrs       | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |
O
ohos-lsw 已提交
2395

Z
update  
zhouhongli2023 已提交
2396 2397 2398 2399 2400 2401
**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
2402 2403 2404

**示例:**

Z
zengyawen 已提交
2405
  ```js
Z
update  
zhouhongli2023 已提交
2406 2407 2408 2409 2410 2411 2412 2413
  // 获取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', {
Q
qian-nan-xu 已提交
2414
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
Z
update  
zhouhongli2023 已提交
2415 2416 2417 2418 2419 2420
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
O
ohos-lsw 已提交
2421 2422 2423
  });
  ```

Z
update  
zhouhongli2023 已提交
2424
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
2425

Z
update  
zhouhongli2023 已提交
2426
queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
2427 2428 2429

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

Z
update  
zhouhongli2023 已提交
2430
**说明**
Z
update  
zhouhongli2023 已提交
2431
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
Z
update  
zhouhongli2023 已提交
2432

O
ohos-lsw 已提交
2433 2434 2435 2436 2437
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2438

H
update  
HelloCrease 已提交
2439 2440 2441
| 参数名      | 类型                                                  | 必填 | 说明                                   |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                     |
Z
update  
zhouhongli2023 已提交
2442
| attrs       | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                     |
H
update  
HelloCrease 已提交
2443
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2444 2445 2446

**示例:**

Z
zengyawen 已提交
2447
  ```js
Z
update  
zhouhongli2023 已提交
2448 2449 2450
  contact.queryContactsByPhoneNumber('138xxxxxxxx', {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
O
ohos-lsw 已提交
2451 2452 2453 2454 2455 2456 2457 2458
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2459
## contact.queryContactsByPhoneNumber<sup>10+</sup>
O
ohos-lsw 已提交
2460

Z
update  
zhouhongli2023 已提交
2461
queryContactsByPhoneNumber(context: Context,  phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
2462 2463 2464 2465 2466 2467 2468 2469

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2470

Z
update  
zhouhongli2023 已提交
2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
| 参数名      | 类型                                                  | 必填 | 说明                                                         |
| ----------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context     | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                                           |
| holder      | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| attrs       | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
2485 2486 2487

**示例:**

Z
zengyawen 已提交
2488
  ```js
Z
update  
zhouhongli2023 已提交
2489 2490 2491 2492 2493 2494 2495 2496
  // 获取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', {
Q
qian-nan-xu 已提交
2497 2498 2499
      holderId: 0,
      bundleName: "",
      displayName: ""
Z
update  
zhouhongli2023 已提交
2500 2501
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2502 2503 2504 2505 2506 2507 2508 2509 2510
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2511
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
2512

Z
update  
zhouhongli2023 已提交
2513
queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
O
ohos-lsw 已提交
2514 2515 2516

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

Z
update  
zhouhongli2023 已提交
2517
**说明**
Z
update  
zhouhongli2023 已提交
2518
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
Z
update  
zhouhongli2023 已提交
2519

O
ohos-lsw 已提交
2520 2521 2522 2523 2524
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2525

H
update  
HelloCrease 已提交
2526 2527 2528
| 参数名      | 类型                                                  | 必填 | 说明                                   |
| ----------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| phoneNumber | string                                                | 是   | 联系人的电话号码。                     |
Z
update  
zhouhongli2023 已提交
2529
| holder      | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                 |
H
update  
HelloCrease 已提交
2530 2531
| attrs       | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                     |
| callback    | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2532 2533 2534

**示例:**

Z
zengyawen 已提交
2535
  ```js
O
ohos-lsw 已提交
2536
  contact.queryContactsByPhoneNumber('138xxxxxxxx', {
Z
update  
zhouhongli2023 已提交
2537 2538 2539 2540
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
Q
qian-nan-xu 已提交
2541
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2542 2543 2544 2545 2546 2547 2548 2549 2550
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2551
## contact.queryContactsByPhoneNumber<sup>10+</sup>
O
ohos-lsw 已提交
2552

Z
update  
zhouhongli2023 已提交
2553
queryContactsByPhoneNumber(context: Context,  phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;
O
ohos-lsw 已提交
2554

Z
update  
zhouhongli2023 已提交
2555
根据电话号码查询联系人,使用Promise方式作为异步方法。
O
ohos-lsw 已提交
2556 2557 2558 2559 2560 2561

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2562

Z
update  
zhouhongli2023 已提交
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
| 参数名      | 类型                                    | 必填 | 说明                                                         |
| ----------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context     | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| phoneNumber | string                                  | 是   | 联系人的电话号码。                                           |
| holder      | [Holder](#holder)                       | 否   | 创建联系人的应用信息。                                       |
| attrs       | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**

| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**错误码:**

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
2582 2583 2584

**示例:**

Z
zengyawen 已提交
2585
  ```js
Z
update  
zhouhongli2023 已提交
2586 2587 2588 2589 2590 2591 2592 2593
  // 获取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', {
Q
qian-nan-xu 已提交
2594 2595 2596
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
2597
  }, {
Q
qian-nan-xu 已提交
2598
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
Z
update  
zhouhongli2023 已提交
2599 2600 2601 2602 2603
  });
  promise.then((data) => {
      console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
O
ohos-lsw 已提交
2604 2605 2606
  });
  ```

Z
update  
zhouhongli2023 已提交
2607
## contact.queryContactsByPhoneNumber(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
2608 2609 2610 2611 2612

queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;

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

Z
update  
zhouhongli2023 已提交
2613
**说明**
Z
update  
zhouhongli2023 已提交
2614
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByPhoneNumber](#contactquerycontactsbyphonenumber10)
Z
update  
zhouhongli2023 已提交
2615

O
ohos-lsw 已提交
2616 2617 2618 2619 2620
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2621

H
update  
HelloCrease 已提交
2622 2623 2624 2625 2626
| 参数名      | 类型                                    | 必填 | 说明                   |
| ----------- | --------------------------------------- | ---- | ---------------------- |
| phoneNumber | string                                  | 是   | 联系人的电话号码。     |
| holder      | [Holder](#holder)                       | 否   | 创建联系人的应用信息。 |
| attrs       | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。     |
O
ohos-lsw 已提交
2627 2628

**返回值:**
2629

H
update  
HelloCrease 已提交
2630 2631
| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
O
ohos-lsw 已提交
2632 2633 2634 2635
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**示例:**

Z
zengyawen 已提交
2636
  ```js
O
ohos-lsw 已提交
2637
  let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
Q
qian-nan-xu 已提交
2638 2639 2640
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
2641
  }, {
Q
qian-nan-xu 已提交
2642
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2643 2644 2645 2646 2647 2648 2649 2650
  });
  promise.then((data) => {
      console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2651
## contact.queryContactsByEmail<sup>10+</sup>
O
ohos-lsw 已提交
2652

Z
update  
zhouhongli2023 已提交
2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
queryContactsByEmail(context: Context,  email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| email    | string                                                | 是   | 联系人的邮箱地址。                                           |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryContactsByEmail(globalThis.context as Context, 'xxx@email.com', (err, data) => {
      if (err) {
          console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2695
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2696

O
ohos-lsw 已提交
2697 2698 2699 2700
queryContactsByEmail(email: string, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2701
**说明**
Z
update  
zhouhongli2023 已提交
2702
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
Z
update  
zhouhongli2023 已提交
2703

O
ohos-lsw 已提交
2704 2705 2706 2707 2708
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2709

H
update  
HelloCrease 已提交
2710 2711 2712 2713
| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email    | string                                                | 是   | 联系人的邮箱地址。                     |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2714 2715 2716

**示例:**

Z
zengyawen 已提交
2717
  ```js
O
ohos-lsw 已提交
2718 2719 2720 2721 2722 2723 2724 2725 2726
  contact.queryContactsByEmail('xxx@email.com', (err, data) => {
      if (err) {
          console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2727
## contact.queryContactsByEmail<sup>10+</sup>
O
ohos-lsw 已提交
2728

Z
update  
zhouhongli2023 已提交
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775
queryContactsByEmail(context: Context,  email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| email    | string                                                | 是   | 联系人的邮箱地址。                                           |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。                       |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
2776
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2777

O
ohos-lsw 已提交
2778 2779 2780 2781
queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2782
**说明**
Z
update  
zhouhongli2023 已提交
2783
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
Z
update  
zhouhongli2023 已提交
2784

O
ohos-lsw 已提交
2785 2786 2787 2788 2789
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2790

H
update  
HelloCrease 已提交
2791 2792 2793 2794 2795
| 参数名   | 类型                                                  | 必填 | 说明                                   |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------- |
| email    | string                                                | 是   | 联系人的邮箱地址。                     |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                 |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到的联系人对象数组。 |
O
ohos-lsw 已提交
2796 2797 2798

**示例:**

Z
zengyawen 已提交
2799
  ```js
O
ohos-lsw 已提交
2800
  contact.queryContactsByEmail('xxx@email.com', {
Q
qian-nan-xu 已提交
2801 2802 2803
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
2804 2805 2806 2807 2808 2809 2810 2811 2812
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2813
## contact.queryContactsByEmail<sup>10+</sup>
O
ohos-lsw 已提交
2814

Z
update  
zhouhongli2023 已提交
2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
queryContactsByEmail(context: Context,  email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| email    | string                                                | 是   | 联系人的邮箱地址。                                           |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到联系人对象数组。                         |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
2860
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2861

O
ohos-lsw 已提交
2862 2863 2864 2865
queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2866
**说明**
Z
update  
zhouhongli2023 已提交
2867
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
Z
update  
zhouhongli2023 已提交
2868

O
ohos-lsw 已提交
2869 2870 2871 2872 2873
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
2874

H
update  
HelloCrease 已提交
2875 2876 2877 2878 2879
| 参数名   | 类型                                                  | 必填 | 说明                                 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| email    | string                                                | 是   | 联系人的邮箱地址。                   |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                   |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到联系人对象数组。 |
O
ohos-lsw 已提交
2880 2881 2882

**示例:**

Z
zengyawen 已提交
2883
  ```js
O
ohos-lsw 已提交
2884
  contact.queryContactsByEmail('xxx@email.com', {
Q
qian-nan-xu 已提交
2885
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
2886 2887 2888 2889 2890 2891 2892 2893 2894
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2895
## contact.queryContactsByEmail<sup>10+</sup>
O
ohos-lsw 已提交
2896

Z
update  
zhouhongli2023 已提交
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946
queryContactsByEmail(context: Context,  email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                               | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| email    | string                                                | 是   | 联系人的邮箱地址。                                           |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。                                       |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                                           |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到联系人对象数组。                         |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
2947
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
2948

O
ohos-lsw 已提交
2949 2950 2951 2952
queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
2953
**说明**
Z
update  
zhouhongli2023 已提交
2954
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
Z
update  
zhouhongli2023 已提交
2955

O
ohos-lsw 已提交
2956 2957 2958 2959
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

Z
update  
zhouhongli2023 已提交
2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986
**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------ |
| email    | string                                                | 是   | 联系人的邮箱地址。                   |
| holder   | [Holder](#holder)                                     | 是   | 创建联系人的应用信息。               |
| attrs    | [ContactAttributes](#contactattributes)               | 是   | 联系人的属性列表。                   |
| callback | AsyncCallback&lt;Array&lt;[Contact](#contact)&gt;&gt; | 是   | 回调函数,返回查询到联系人对象数组。 |

**示例:**

  ```js
  contact.queryContactsByEmail('xxx@email.com', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  }, (err, data) => {
      if (err) {
          console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
2987
## contact.queryContactsByEmail<sup>10+</sup>
Z
update  
zhouhongli2023 已提交
2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012

queryContactsByEmail(context: Context,  email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| context | Context                                 | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| email   | string                                  | 是   | 联系人的邮箱地址。                                           |
| holder  | [Holder](#holder)                       | 否   | 创建联系人的应用信息。                                       |
| attrs   | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。                                           |

**返回值:**

| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**错误码:**
3013

Z
update  
zhouhongli2023 已提交
3014 3015 3016 3017
| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 201      | Permission denied. |
| 401      | Parameter error.   |
O
ohos-lsw 已提交
3018 3019 3020

**示例:**

Z
zengyawen 已提交
3021
  ```js
Z
update  
zhouhongli2023 已提交
3022 3023 3024 3025 3026 3027 3028 3029
  // 获取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', {
Q
qian-nan-xu 已提交
3030 3031 3032
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3033
  }, {
Q
qian-nan-xu 已提交
3034
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
Z
update  
zhouhongli2023 已提交
3035 3036 3037 3038 3039
  });
  promise.then((data) => {
      console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
O
ohos-lsw 已提交
3040 3041 3042
  });
  ```

Z
update  
zhouhongli2023 已提交
3043
## contact.queryContactsByEmail(deprecated)<sup>7+</sup>
O
ohos-lsw 已提交
3044 3045 3046 3047 3048

queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise&lt;Array&lt;Contact&gt;&gt;

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

Z
update  
zhouhongli2023 已提交
3049
**说明**
Z
update  
zhouhongli2023 已提交
3050
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryContactsByEmail](#contactquerycontactsbyemail10)
Z
update  
zhouhongli2023 已提交
3051

O
ohos-lsw 已提交
3052 3053 3054 3055 3056
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3057

H
update  
HelloCrease 已提交
3058 3059 3060 3061 3062
| 参数名 | 类型                                    | 必填 | 说明                   |
| ------ | --------------------------------------- | ---- | ---------------------- |
| email  | string                                  | 是   | 联系人的邮箱地址。     |
| holder | [Holder](#holder)                       | 否   | 创建联系人的应用信息。 |
| attrs  | [ContactAttributes](#contactattributes) | 否   | 联系人的属性列表。     |
O
ohos-lsw 已提交
3063 3064

**返回值:**
3065

H
update  
HelloCrease 已提交
3066 3067
| 类型                                            | 说明                                                |
| ----------------------------------------------- | --------------------------------------------------- |
O
ohos-lsw 已提交
3068 3069 3070 3071
| Promise&lt;Array&lt;[Contact](#contact)&gt;&gt; | 以Promise形式返回结果,返回查询到的联系人对象数组。 |

**示例:**

Z
zengyawen 已提交
3072
  ```js
O
ohos-lsw 已提交
3073
  let promise = contact.queryContactsByEmail('xxx@email.com', {
Q
qian-nan-xu 已提交
3074 3075 3076
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3077
  }, {
Q
qian-nan-xu 已提交
3078
      attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
O
ohos-lsw 已提交
3079 3080 3081 3082 3083 3084 3085 3086
  });
  promise.then((data) => {
      console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3087
## contact.queryGroups<sup>10+</sup>
O
ohos-lsw 已提交
3088

Z
update  
zhouhongli2023 已提交
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129
queryGroups(context: Context,  callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                              | 必填 | 说明                                                         |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                           | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是   | 回调函数,返回查询到的群组对象数组。                         |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryGroups(globalThis.context as Context, (err, data) => {
      if (err) {
          console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3130
## contact.queryGroups(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3131

O
ohos-lsw 已提交
3132 3133 3134 3135
queryGroups(callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
3136
**说明**
Z
update  
zhouhongli2023 已提交
3137
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
Z
update  
zhouhongli2023 已提交
3138

O
ohos-lsw 已提交
3139 3140 3141 3142 3143
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3144

H
update  
HelloCrease 已提交
3145 3146 3147
| 参数名   | 类型                                              | 必填 | 说明                                 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是   | 回调函数,返回查询到的群组对象数组。 |
O
ohos-lsw 已提交
3148 3149 3150

**示例:**

Z
zengyawen 已提交
3151
  ```js
O
ohos-lsw 已提交
3152 3153 3154 3155 3156 3157 3158 3159 3160
  contact.queryGroups((err, data) => {
      if (err) {
          console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3161
## contact.queryGroups<sup>10+</sup>
O
ohos-lsw 已提交
3162

Z
update  
zhouhongli2023 已提交
3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
queryGroups(context: Context,  holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                              | 必填 | 说明                                                         |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                           | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder   | Holder                                            | 是   | 创建联系人的应用信息。                                       |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是   | 回调函数,返回查询到的群组对象数组。                         |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
3209
## contact.queryGroups(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3210

O
ohos-lsw 已提交
3211 3212 3213 3214
queryGroups(holder: Holder, callback: AsyncCallback&lt;Array&lt;Group&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
3215
**说明**
Z
update  
zhouhongli2023 已提交
3216
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
Z
update  
zhouhongli2023 已提交
3217

O
ohos-lsw 已提交
3218 3219 3220 3221 3222
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3223

H
update  
HelloCrease 已提交
3224 3225 3226 3227
| 参数名   | 类型                                              | 必填 | 说明                                 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| holder   | Holder                                            | 是   | 创建联系人的应用信息。               |
| callback | AsyncCallback&lt;Array&lt;[Group](#group)&gt;&gt; | 是   | 回调函数,返回查询到的群组对象数组。 |
O
ohos-lsw 已提交
3228 3229 3230

**示例:**

Z
zengyawen 已提交
3231
  ```js
O
ohos-lsw 已提交
3232
  contact.queryGroups({
Q
qian-nan-xu 已提交
3233 3234 3235
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3236 3237 3238 3239 3240 3241 3242 3243 3244
  }, (err, data) => {
      if (err) {
          console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3245
## contact.queryGroups<sup>10+</sup>
O
ohos-lsw 已提交
3246

Z
update  
zhouhongli2023 已提交
3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296
queryGroups(context: Context,  holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型              | 必填 | 说明                                                         |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context           | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| holder  | [Holder](#holder) | 否   | 创建联系人的应用信息。                                       |

**返回值:**

| 类型                                        | 说明                                              |
| ------------------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;[Group](#group)&gt;&gt; | 以Promise形式返回结果,返回查询到的群组对象数组。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
3297
## contact.queryGroups(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3298

O
ohos-lsw 已提交
3299 3300 3301 3302
queryGroups(holder?: Holder): Promise&lt;Array&lt;Group&gt;&gt;

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

Z
update  
zhouhongli2023 已提交
3303
**说明**
Z
update  
zhouhongli2023 已提交
3304
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryGroups](#contactquerygroups10)
Z
update  
zhouhongli2023 已提交
3305

O
ohos-lsw 已提交
3306 3307 3308 3309 3310
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3311

H
update  
HelloCrease 已提交
3312 3313 3314
| 参数名 | 类型              | 必填 | 说明                   |
| ------ | ----------------- | ---- | ---------------------- |
| holder | [Holder](#holder) | 否   | 创建联系人的应用信息。 |
O
ohos-lsw 已提交
3315 3316

**返回值:**
3317

H
update  
HelloCrease 已提交
3318 3319
| 类型                                        | 说明                                              |
| ------------------------------------------- | ------------------------------------------------- |
O
ohos-lsw 已提交
3320 3321 3322 3323
| Promise&lt;Array&lt;[Group](#group)&gt;&gt; | 以Promise形式返回结果,返回查询到的群组对象数组。 |

**示例:**

Z
zengyawen 已提交
3324
  ```js
O
ohos-lsw 已提交
3325
  let promise = contact.queryGroups({
Q
qian-nan-xu 已提交
3326 3327 3328
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3329 3330 3331 3332 3333 3334 3335 3336
  });
  promise.then((data) => {
      console.log(`queryGroups success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3337
## contact.queryHolders<sup>10+</sup>
O
ohos-lsw 已提交
3338

Z
update  
zhouhongli2023 已提交
3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379
queryHolders(context: Context,  callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                                                | 必填 | 说明                                                         |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                                             | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&gt;&gt; | 是   | 回调函数,返回查询到的创建联系人应用信息的对象数组。         |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryHolders(globalThis.context as Context, (err, data) => {
      if (err) {
          console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3380
## contact.queryHolders(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3381

O
ohos-lsw 已提交
3382 3383 3384 3385
queryHolders(callback: AsyncCallback&lt;Array&lt;Holder&gt;&gt;): void

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

Z
update  
zhouhongli2023 已提交
3386
**说明**
Z
update  
zhouhongli2023 已提交
3387
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryHolders](#contactqueryholders10)
Z
update  
zhouhongli2023 已提交
3388

O
ohos-lsw 已提交
3389 3390 3391 3392 3393
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3394

H
update  
HelloCrease 已提交
3395 3396 3397
| 参数名   | 类型                                                | 必填 | 说明                                                 |
| -------- | --------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Holder](#holder)&gt;&gt; | 是   | 回调函数,返回查询到的创建联系人应用信息的对象数组。 |
O
ohos-lsw 已提交
3398 3399 3400

**示例:**

Z
zengyawen 已提交
3401
  ```js
O
ohos-lsw 已提交
3402 3403 3404 3405 3406 3407 3408 3409 3410
  contact.queryHolders((err, data) => {
      if (err) {
          console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3411
## contact.queryHolders<sup>10+</sup>
O
ohos-lsw 已提交
3412

Z
update  
zhouhongli2023 已提交
3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457
queryHolders(context: Context ): Promise&lt;Array&lt;Holder&gt;&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型    | 必填 | 说明                                                         |
| ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |

**返回值:**

| 类型                                          | 说明                                                         |
| --------------------------------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[Holder](#holder)&gt;&gt; | 以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。 |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  let promise = contact.queryHolders(globalThis.context as Context);
  promise.then((data) => {
      console.log(`queryHolders success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3458
## contact.queryHolders(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3459

O
ohos-lsw 已提交
3460 3461 3462 3463
queryHolders(): Promise&lt;Array&lt;Holder&gt;&gt;

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

Z
update  
zhouhongli2023 已提交
3464
**说明**
Z
update  
zhouhongli2023 已提交
3465
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryHolders](#contactqueryholders10)
Z
update  
zhouhongli2023 已提交
3466

O
ohos-lsw 已提交
3467 3468 3469 3470 3471
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**返回值:**
3472

H
update  
HelloCrease 已提交
3473 3474
| 类型                                          | 说明                                                         |
| --------------------------------------------- | ------------------------------------------------------------ |
O
ohos-lsw 已提交
3475 3476 3477 3478
| Promise&lt;Array&lt;[Holder](#holder)&gt;&gt; | 以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。 |

**示例:**

Z
zengyawen 已提交
3479
  ```js
O
ohos-lsw 已提交
3480 3481 3482 3483 3484 3485 3486 3487
  let promise = contact.queryHolders();
  promise.then((data) => {
      console.log(`queryHolders success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3488
## contact.queryKey<sup>10+</sup>
O
ohos-lsw 已提交
3489

Z
update  
zhouhongli2023 已提交
3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531
queryKey(context: Context,  id: number, callback: AsyncCallback&lt;string&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                        | 必填 | 说明                                                         |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                     | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id       | number                      | 是   | 联系人对象的id属性。                                         |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回查询到的联系人对应的key。                      |

**错误码:**

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

**示例:**

  ```js
  // 获取context
  import UIAbility from '@ohos.app.ability.UIAbility';
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
      globalThis.context = this.context;
    }
  }
  contact.queryKey(globalThis.context as Context, /*id*/1, (err, data) => {
      if (err) {
          console.log(`queryKey callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3532
## contact.queryKey(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3533

O
ohos-lsw 已提交
3534 3535 3536 3537
queryKey(id: number, callback: AsyncCallback&lt;string&gt;): void

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

Z
update  
zhouhongli2023 已提交
3538
**说明**
Z
update  
zhouhongli2023 已提交
3539
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
Z
update  
zhouhongli2023 已提交
3540

O
ohos-lsw 已提交
3541 3542 3543 3544 3545
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3546

H
update  
HelloCrease 已提交
3547 3548 3549 3550
| 参数名   | 类型                        | 必填 | 说明                                    |
| -------- | --------------------------- | ---- | --------------------------------------- |
| id       | number                      | 是   | 联系人对象的id属性。                    |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回查询到的联系人对应的key。 |
O
ohos-lsw 已提交
3551 3552 3553

**示例:**

Z
zengyawen 已提交
3554
  ```js
O
ohos-lsw 已提交
3555 3556 3557 3558 3559 3560 3561 3562 3563
  contact.queryKey(/*id*/1, (err, data) => {
      if (err) {
          console.log(`queryKey callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3564
## contact.queryKey<sup>10+</sup>
O
ohos-lsw 已提交
3565

Z
update  
zhouhongli2023 已提交
3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612
queryKey(context: Context,  id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名   | 类型                        | 必填 | 说明                                                         |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context  | Context                     | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id       | number                      | 是   | 联系人对象的id属性。                                         |
| holder   | [Holder](#holder)           | 是   | 创建联系人的应用信息。                                       |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回查询到的联系人对应的key。                      |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
3613
## contact.queryKey(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3614

O
ohos-lsw 已提交
3615 3616 3617 3618
queryKey(id: number, holder: Holder, callback: AsyncCallback&lt;string&gt;): void

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

Z
update  
zhouhongli2023 已提交
3619
**说明**
Z
update  
zhouhongli2023 已提交
3620
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
Z
update  
zhouhongli2023 已提交
3621

O
ohos-lsw 已提交
3622 3623 3624 3625 3626
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3627

H
update  
HelloCrease 已提交
3628 3629 3630 3631 3632
| 参数名   | 类型                        | 必填 | 说明                                    |
| -------- | --------------------------- | ---- | --------------------------------------- |
| id       | number                      | 是   | 联系人对象的id属性。                    |
| holder   | [Holder](#holder)           | 是   | 创建联系人的应用信息。                  |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回查询到的联系人对应的key。 |
O
ohos-lsw 已提交
3633 3634 3635

**示例:**

Z
zengyawen 已提交
3636
  ```js
D
dingxiaochen 已提交
3637
  contact.queryKey(/*id*/1, {
Q
qian-nan-xu 已提交
3638 3639 3640
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3641 3642 3643 3644 3645 3646 3647 3648 3649
  }, (err, data) => {
      if (err) {
          console.log(`queryKey callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3650
## contact.queryKey<sup>10+</sup>
O
ohos-lsw 已提交
3651

Z
update  
zhouhongli2023 已提交
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702
queryKey(context: Context,  id: number, holder?: Holder): Promise&lt;string&gt;

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

**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**

| 参数名  | 类型              | 必填 | 说明                                                         |
| ------- | ----------------- | ---- | ------------------------------------------------------------ |
| context | Context           | 是   | 应用上下文Context,Stage模型的应用Context定义见[Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md)。 |
| id      | number            | 是   | 联系人对象的id属性。                                         |
| holder  | [Holder](#holder) | 否   | 创建联系人的应用信息。                                       |

**返回值:**

| 类型                  | 说明                                                 |
| --------------------- | ---------------------------------------------------- |
| Promise&lt;string&gt; | 以Promise形式返回结果,返回查询到的联系人对应的key。 |

**错误码:**

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

**示例:**

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

Z
update  
zhouhongli2023 已提交
3703
## contact.queryKey(deprecated)<sup>7+</sup>
Z
update  
zhouhongli2023 已提交
3704

O
ohos-lsw 已提交
3705 3706 3707 3708
queryKey(id: number, holder?: Holder): Promise&lt;string&gt;

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

Z
update  
zhouhongli2023 已提交
3709
**说明**
Z
update  
zhouhongli2023 已提交
3710
从API version 7 开始支持,从API 10 开始废弃,建议使用[queryKey](#contactquerykey10)
Z
update  
zhouhongli2023 已提交
3711

O
ohos-lsw 已提交
3712 3713 3714 3715 3716
**需要权限**:ohos.permission.READ_CONTACTS

**系统能力**:SystemCapability.Applications.ContactsData

**参数:**
3717

H
update  
HelloCrease 已提交
3718 3719 3720 3721
| 参数名 | 类型              | 必填 | 说明                   |
| ------ | ----------------- | ---- | ---------------------- |
| id     | number            | 是   | 联系人对象的id属性。   |
| holder | [Holder](#holder) | 否   | 创建联系人的应用信息。 |
O
ohos-lsw 已提交
3722 3723

**返回值:**
3724

H
update  
HelloCrease 已提交
3725 3726
| 类型                  | 说明                                                 |
| --------------------- | ---------------------------------------------------- |
O
ohos-lsw 已提交
3727 3728 3729 3730
| Promise&lt;string&gt; | 以Promise形式返回结果,返回查询到的联系人对应的key。 |

**示例:**

Z
zengyawen 已提交
3731
  ```js
D
dingxiaochen 已提交
3732
  let promise = contact.queryKey(/*id*/1, {
Q
qian-nan-xu 已提交
3733 3734 3735
      holderId: 0,
      bundleName: "",
      displayName: ""
O
ohos-lsw 已提交
3736 3737 3738 3739 3740 3741 3742 3743
  });
  promise.then((data) => {
      console.log(`queryKey success: data->${JSON.stringify(data)}`);
  }).catch((err) => {
      console.error(`queryKey fail: err->${JSON.stringify(err)}`);
  });
  ```

Z
update  
zhouhongli2023 已提交
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754
## ContactSelectionOptions<sup>10+</sup>

选择联系人条件。

**系统能力**:SystemCapability.Applications.Contacts

|                名称               |                  类型                 | 必填  |        说明      |
| --------------------------------- | ------------------------------------- | ---- | ---------------- |
| isMultiSelect <sup>10+</sup>         | boolean | 否   | 是否为多选     |


O
ohos-lsw 已提交
3755 3756 3757 3758 3759 3760 3761 3762 3763

## Contact

联系人对象类。

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

### 常量

H
update  
HelloCrease 已提交
3764 3765 3766
| 名称               | 值   | 说明             |
| ------------------ | ---- | ---------------- |
| INVALID_CONTACT_ID | -1   | 默认联系人的id。 |
O
ohos-lsw 已提交
3767 3768 3769 3770


### 属性

Y
YOUR_NAME 已提交
3771
|       名称        |                   类型                  | 可读 | 可写 | 说明                                   |
H
update  
HelloCrease 已提交
3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789
| ----------------- | --------------------------------------- | ---- | ---- | -------------------------------------- |
| id                | number                                  | 是   | 否   | 联系人的id。                           |
| key               | string                                  | 是   | 否   | 联系人的key。                          |
| contactAttributes | [ContactAttributes](#contactattributes) | 是   | 是   | 联系人的属性列表。                     |
| emails            | [Email](#email)[]                       | 是   | 是   | 联系人的邮箱地址列表。                 |
| events            | [Event](#event)[]                       | 是   | 是   | 联系人的生日、周年纪念等重要日期列表。 |
| groups            | [Group](#group)[]                       | 是   | 是   | 联系人的群组列表。                     |
| imAddresses       | [ImAddress](#imaddress)[]               | 是   | 是   | 联系人的即时消息地址列表。             |
| phoneNumbers      | [PhoneNumber](#phonenumber)[]           | 是   | 是   | 联系人的电话号码列表。                 |
| portrait          | [Portrait](#portrait)                   | 是   | 是   | 联系人的头像。                         |
| postalAddresses   | [PostalAddress](#postaladdress)[]       | 是   | 是   | 联系人的邮政地址列表。                 |
| relations         | [Relation](#relation)[]                 | 是   | 是   | 联系人的关系列表。                     |
| sipAddresses      | [SipAddress](#sipaddress)[]             | 是   | 是   | 联系人的会话发起协议(SIP)地址列表。  |
| websites          | [Website](#website)[]                   | 是   | 是   | 联系人的网站列表。                     |
| name              | [Name](#name)                           | 是   | 是   | 联系人的姓名。                         |
| nickName          | [NickName](#nickname)                   | 是   | 是   | 联系人的昵称。                         |
| note              | [Note](#note)                           | 是   | 是   | 联系人的备注。                         |
| organization      | [Organization](#organization)           | 是   | 是   | 联系人的组织信息。                     |
O
ohos-lsw 已提交
3790 3791 3792 3793 3794 3795 3796


**对象创建示例:**

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


3797
```js
O
ohos-lsw 已提交
3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814
let myContact = {
    phoneNumbers: [{
        phoneNumber: "138xxxxxxxx"
    }],
    name: {
        fullName: "fullName",
        namePrefix: "namePrefix"
    },
    nickName: {
        nickName: "nickName"
    }
};
```


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

Z
zengyawen 已提交
3815
```js
O
ohos-lsw 已提交
3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832
let myContact = new contact.Contact();
let name = new contact.Name();
name.fullName = "fullName";
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
myContact.name = name;
myContact.phoneNumbers = [phoneNumber];
```


## ContactAttributes

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

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

Y
YOUR_NAME 已提交
3833
| 名称       |            类型           | 可读 | 可写 | 说明             |
H
update  
HelloCrease 已提交
3834 3835
| ---------- | ------------------------- | ---- | ---- | ---------------- |
| attributes | [Attribute](#attribute)[] | 是   | 是   | 联系人属性列表。 |
O
ohos-lsw 已提交
3836 3837 3838 3839 3840 3841 3842


**对象创建示例:**

使用JSON格式创建数据:


3843
```js
O
ohos-lsw 已提交
3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855
let contactAttributes = {
    attributes: [
        contact.Attribute.ATTR_EMAIL,
        contact.Attribute.ATTR_NAME,
        contact.Attribute.ATTR_PHONE
    ]
};
```

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


Z
zengyawen 已提交
3856
```js
O
ohos-lsw 已提交
3857
let contactAttributes = new contact.ContactAttributes();
D
dingxiaochen 已提交
3858
contactAttributes.attributes = [contact.Attribute.ATTR_EMAIL];
O
ohos-lsw 已提交
3859 3860 3861 3862 3863 3864 3865 3866 3867
```


## Attribute

枚举,联系人属性列表。

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

H
update  
HelloCrease 已提交
3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883
| 名称                  | 说明                               |
| --------------------- | ---------------------------------- |
| ATTR_CONTACT_EVENT    | 联系人的生日、周年纪念等重要日期。 |
| ATTR_EMAIL            | 联系人的邮箱地址。                 |
| ATTR_GROUP_MEMBERSHIP | 联系人的群组。                     |
| ATTR_IM               | 联系人的即时消息地址。             |
| ATTR_NAME             | 联系人的姓名。                     |
| ATTR_NICKNAME         | 联系人的昵称。                     |
| ATTR_NOTE             | 联系人的备注。                     |
| ATTR_ORGANIZATION     | 联系人的组织信息。                 |
| ATTR_PHONE            | 联系人的电话号码。                 |
| ATTR_PORTRAIT         | 联系人的头像。                     |
| ATTR_POSTAL_ADDRESS   | 联系人的邮政地址。                 |
| ATTR_RELATION         | 联系人的关系。                     |
| ATTR_SIP_ADDRESS      | 联系人的会话发起协议(SIP)地址。  |
| ATTR_WEBSITE          | 联系人的网站。                     |
O
ohos-lsw 已提交
3884 3885 3886 3887 3888 3889


**对象创建示例:**

使用JSON格式创建数据:

3890
```js
O
ohos-lsw 已提交
3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902
let attributes = [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE];
```


## Email

联系人的邮箱。

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

### 常量

H
update  
HelloCrease 已提交
3903 3904 3905 3906 3907 3908 3909
| 名称             | 值   | 说明             |
| ---------------- | ---- | ---------------- |
| CUSTOM_LABEL     | 0    | 自定义邮箱类型。 |
| EMAIL_HOME       | 1    | 家庭邮箱类型。   |
| EMAIL_WORK       | 2    | 工作邮箱类型。   |
| EMAIL_OTHER      | 3    | 其它邮箱类型。   |
| INVALID_LABEL_ID | -1   | 无效邮箱类型。   |
O
ohos-lsw 已提交
3910 3911 3912 3913


### 属性

Y
YOUR_NAME 已提交
3914
| 名称        |   类型   | 可读 | 可写 | 说明             |
H
update  
HelloCrease 已提交
3915 3916 3917 3918 3919
| ----------- | -------- | ---- | ---- | ---------------- |
| email       | string   | 是   | 是   | 邮箱地址。       |
| labelName   | string   | 是   | 是   | 邮箱的类型名称。 |
| displayName | string   | 是   | 是   | 邮箱的显示名称。 |
| labelId     | number   | 是   | 是   | 邮箱的类型。     |
O
ohos-lsw 已提交
3920 3921 3922 3923 3924 3925


**对象创建示例:**

  使用JSON格式创建数据:

3926
```js
O
ohos-lsw 已提交
3927 3928 3929 3930 3931 3932 3933 3934 3935
let email = {
    email: "xxx@email.com",
    displayName: "displayName"
}
```


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

Z
zengyawen 已提交
3936
```js
O
ohos-lsw 已提交
3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947
let email = new contact.Email();
email.email = "xxx@email.com";
```


## Holder

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

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

3948 3949 3950 3951 3952
| 名称        | 类型   | 可读 | 可写 | 说明         |
| ----------- | ------ | ---- | ---- | ------------ |
| bundleName  | string | 是   | 否   | Bundle名称。 |
| displayName | string | 是   | 否   | 应用名称。   |
| holderId    | number | 是   | 是   | 应用ID。     |
O
ohos-lsw 已提交
3953 3954 3955 3956 3957 3958


**对象创建示例:**

  使用JSON格式创建数据:

3959
```js
O
ohos-lsw 已提交
3960 3961 3962 3963 3964 3965 3966
let holder = {
  holderId: 0
};
```

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

Z
zengyawen 已提交
3967
```js
O
ohos-lsw 已提交
3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980
let holder = new contact.Holder();
holder.holderId = 0;
```


## Event

联系人事件类。

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

### 常量

H
update  
HelloCrease 已提交
3981 3982 3983 3984 3985 3986 3987
| 名称              | 值   | 说明               |
| ----------------- | ---- | ------------------ |
| CUSTOM_LABEL      | 0    | 自定义事件类型。   |
| EVENT_ANNIVERSARY | 1    | 周年纪念事件类型。 |
| EVENT_OTHER       | 2    | 其它事件类型。     |
| EVENT_BIRTHDAY    | 3    | 生日事件类型。     |
| INVALID_LABEL_ID  | -1   | 无效事件类型。     |
O
ohos-lsw 已提交
3988 3989 3990 3991


### 属性

Y
YOUR_NAME 已提交
3992
|    名称   |   类型   | 可读 | 可写 | 说明           |
H
update  
HelloCrease 已提交
3993 3994 3995 3996
| --------- | -------- | ---- | ---- | -------------- |
| eventDate | string   | 是   | 是   | 事件的日期。   |
| labelName | string   | 是   | 是   | 事件类型名称。 |
| labelId   | number   | 是   | 是   | 事件类型。     |
O
ohos-lsw 已提交
3997 3998 3999 4000 4001 4002


**对象创建示例:**

  使用JSON格式创建数据:

4003
```js
O
ohos-lsw 已提交
4004 4005 4006 4007 4008 4009 4010
let event = {
    eventDate: "xxxxxx"
};
```

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

Z
zengyawen 已提交
4011
```js
O
ohos-lsw 已提交
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022
let event = new contact.Event();
event.eventDate = "xxxxxx";
```


## Group

联系人的群组类。

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

Y
YOUR_NAME 已提交
4023
| 名称    |   类型   | 可读 | 可写 | 说明               |
H
update  
HelloCrease 已提交
4024 4025 4026
| ------- | -------- | ---- | ---- | ------------------ |
| groupId | number   | 是   | 是   | 联系人群组的id。   |
| title   | string   | 是   | 是   | 联系人群组的名称。 |
O
ohos-lsw 已提交
4027 4028 4029 4030 4031 4032


**对象创建示例:**

  使用JSON格式创建数据:

4033
```js
O
ohos-lsw 已提交
4034 4035 4036 4037 4038 4039 4040 4041
let group = {
    groupId: 1,
    title: "title"
};
```

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

Z
zengyawen 已提交
4042
```js
O
ohos-lsw 已提交
4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055
let group = new contact.Group();
group.title = "title";
```


## ImAddress

联系人的即时消息地址。

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

### 常量

H
update  
HelloCrease 已提交
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
| 名称             | 值   | 说明                 |
| ---------------- | ---- | -------------------- |
| CUSTOM_LABEL     | -1   | 自定义即时消息类型。 |
| IM_AIM           | 0    | AIM即时消息类型。    |
| IM_MSN           | 1    | MSN即时消息类型。    |
| IM_YAHOO         | 2    | YAHOO即时消息类型。  |
| IM_SKYPE         | 3    | SKYPE即时消息类型。  |
| IM_QQ            | 4    | QQ即时消息类型。     |
| IM_ICQ           | 6    | ICQ即时消息类型。    |
| IM_JABBER        | 7    | JABBER即时消息类型。 |
| INVALID_LABEL_ID | -2   | 无效的即时消息类型。 |
O
ohos-lsw 已提交
4067 4068 4069 4070


### 属性

Y
YOUR_NAME 已提交
4071
| 名称      |   类型   | 可读 | 可写 | 说明               |
H
update  
HelloCrease 已提交
4072 4073 4074 4075
| --------- | -------- | ---- | ---- | ------------------ |
| imAddress | string   | 是   | 是   | 即时消息地址。     |
| labelName | string   | 是   | 是   | 即时消息类型名称。 |
| labelId   | number   | 是   | 是   | 即时消息类型。     |
O
ohos-lsw 已提交
4076 4077 4078 4079 4080 4081


**对象创建示例:**

  使用JSON格式创建数据:

4082
```js
O
ohos-lsw 已提交
4083 4084 4085 4086 4087 4088 4089 4090 4091
let imAddress = {
    imAddress: "imAddress",
    labelName: "labelName"
};
```


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

Z
zengyawen 已提交
4092
```js
O
ohos-lsw 已提交
4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103
let imAddress = new contact.ImAddress();
imAddress.imAddress = "imAddress";
```


## Name

联系人的名字类。

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

Y
YOUR_NAME 已提交
4104
| 名称               |   类型   | 可读 | 可写 | 说明                        |
H
update  
HelloCrease 已提交
4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
| ------------------ | -------- | ---- | ---- | --------------------------- |
| familyName         | string   | 是   | 是   | 联系人的家庭姓名。          |
| familyNamePhonetic | string   | 是   | 是   | 联系人的家庭姓名拼音。      |
| fullName           | string   | 是   | 是   | 联系人的全名。              |
| givenName          | string   | 是   | 是   | 联系人的名称(firstName)。 |
| givenNamePhonetic  | string   | 是   | 是   | 联系人的名称拼音。          |
| middleName         | string   | 是   | 是   | 联系人的中间名。            |
| middleNamePhonetic | string   | 是   | 是   | 联系人的中间名拼音。        |
| namePrefix         | string   | 是   | 是   | 联系人的姓名前缀。          |
| nameSuffix         | string   | 是   | 是   | 联系人的姓名后缀。          |
O
ohos-lsw 已提交
4115 4116 4117 4118 4119 4120


**对象创建示例:**

  使用JSON格式创建数据:

4121
```js
O
ohos-lsw 已提交
4122 4123 4124 4125 4126 4127 4128 4129
let name = {
    familyName: "familyName",
    fullName: "fullName"
};
```

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

Z
zengyawen 已提交
4130
```js
O
ohos-lsw 已提交
4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142
let name = new contact.Name();
name.familyName = "familyName";
name.fullName = "fullName";
```


## NickName

联系人的昵称类。

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

Y
YOUR_NAME 已提交
4143
| 名称     |   类型   | 可读 | 可写 | 说明           |
H
update  
HelloCrease 已提交
4144 4145
| -------- | -------- | ---- | ---- | -------------- |
| nickName | string   | 是   | 是   | 联系人的昵称。 |
O
ohos-lsw 已提交
4146 4147 4148 4149 4150 4151


**对象创建示例:**

  使用JSON格式创建数据:

4152
```js
O
ohos-lsw 已提交
4153 4154 4155 4156 4157 4158 4159
let nickName = {
    nickName: "nickName"
};
```

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

Z
zengyawen 已提交
4160
```js
O
ohos-lsw 已提交
4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171
let nickName = new contact.NickName();
nickName.nickName = "nickName";
```


## Note

联系人的备注类。

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

Y
YOUR_NAME 已提交
4172
| 名称        |   类型   | 可读 | 可写 | 说明               |
H
update  
HelloCrease 已提交
4173 4174
| ----------- | -------- | ---- | ---- | ------------------ |
| noteContent | string   | 是   | 是   | 联系人的备注内容。 |
O
ohos-lsw 已提交
4175 4176 4177 4178 4179 4180


**对象创建示例:**

  使用JSON格式创建数据:

4181
```js
O
ohos-lsw 已提交
4182 4183 4184 4185 4186 4187 4188
let note = {
    noteContent: "noteContent"
};
```

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

Z
zengyawen 已提交
4189
```js
O
ohos-lsw 已提交
4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200
let note = new contact.Note();
note.noteContent = "noteContent";
```


## Organization

联系人的组织类。

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

Y
YOUR_NAME 已提交
4201
| 名称  |   类型   | 可读 | 可写 | 说明       |
H
update  
HelloCrease 已提交
4202 4203 4204
| ----- | -------- | ---- | ---- | ---------- |
| name  | string   | 是   | 是   | 组织名称。 |
| title | string   | 是   | 是   | 组织标题。 |
O
ohos-lsw 已提交
4205 4206 4207 4208 4209 4210


**对象创建示例:**

  使用JSON格式创建数据:

4211
```js
O
ohos-lsw 已提交
4212 4213 4214 4215 4216 4217 4218 4219
let organization = {
    name: "name",
    title: "title"
};
```

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

Z
zengyawen 已提交
4220
```js
O
ohos-lsw 已提交
4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
let organization = new contact.Organization();
organization.name = "name";
organization.title = "title";
```


## PhoneNumber

联系人电话号码类。

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

### 常量

H
update  
HelloCrease 已提交
4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258
| 名称             | 值   | 说明                                             |
| ---------------- | ---- | ------------------------------------------------ |
| CUSTOM_LABEL     | 0    | 自定义电话类型。                                 |
| NUM_HOME         | 1    | 家庭电话类型。                                   |
| NUM_MOBILE       | 2    | 移动电话类型。                                   |
| NUM_WORK         | 3    | 工作电话类型。                                   |
| NUM_FAX_WORK     | 4    | 工作传真电话类型。                               |
| NUM_FAX_HOME     | 5    | 家庭传真电话类型。                               |
| NUM_PAGER        | 6    | 寻呼机电话类型。                                 |
| NUM_OTHER        | 7    | 其它电话类型。                                   |
| NUM_CALLBACK     | 8    | 回呼电话类型。                                   |
| NUM_CAR          | 9    | 车机电话类型。                                   |
| NUM_COMPANY_MAIN | 10   | 公司电话类型。                                   |
| NUM_ISDN         | 11   | 综合业务数字网(ISDN)电话类型。                 |
| NUM_MAIN         | 12   | 主电话类型。                                     |
| NUM_OTHER_FAX    | 13   | 其它传真类型。                                   |
| NUM_RADIO        | 14   | 无线电话类型。                                   |
| NUM_TELEX        | 15   | 电传电话类型。                                   |
| NUM_TTY_TDD      | 16   | 电传打字机(TTY)或测试驱动开发(TDD)电话类型。 |
| NUM_WORK_MOBILE  | 17   | 工作移动电话类型。                               |
| NUM_WORK_PAGER   | 18   | 工作寻呼机电话类型。                             |
| NUM_ASSISTANT    | 19   | 助理电话类型。                                   |
| NUM_MMS          | 20   | 彩信电话类型。                                   |
| INVALID_LABEL_ID | -1   | 无效电话类型。                                   |
O
ohos-lsw 已提交
4259 4260 4261 4262


### 属性

Y
YOUR_NAME 已提交
4263
| 名称        |   类型   | 可读 | 可写 | 说明               |
H
update  
HelloCrease 已提交
4264 4265 4266 4267
| ----------- | -------- | ---- | ---- | ------------------ |
| labelName   | string   | 是   | 是   | 电话号码类型名称。 |
| phoneNumber | string   | 是   | 是   | 电话号码。         |
| labelId     | number   | 是   | 是   | 电话号码类型。     |
O
ohos-lsw 已提交
4268 4269 4270 4271 4272 4273


**对象创建示例:**

  使用JSON格式创建数据:

4274
```js
O
ohos-lsw 已提交
4275 4276 4277 4278 4279 4280 4281 4282
let phoneNumber = {
    phoneNumber: "138xxxxxxxx",
    labelId: contact.PhoneNumber.NUM_HOME
};
```

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

Z
zengyawen 已提交
4283
```js
O
ohos-lsw 已提交
4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
```


## Portrait

联系人的头像类。

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

Y
YOUR_NAME 已提交
4295
| 名称 |   类型   | 可读 | 可写 | 说明           |
H
update  
HelloCrease 已提交
4296 4297
| ---- | -------- | ---- | ---- | -------------- |
| uri  | string   | 是   | 是   | 联系人的头像。 |
O
ohos-lsw 已提交
4298 4299 4300 4301 4302 4303


**对象创建示例:**

  使用JSON格式创建数据:

4304
```js
O
ohos-lsw 已提交
4305 4306 4307 4308 4309 4310 4311
let portrait = {
    uri: "uri"
};
```

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

Z
zengyawen 已提交
4312
```js
O
ohos-lsw 已提交
4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325
let portrait = new contact.Portrait();
portrait.uri = "uri";
```


## PostalAddress

联系人的邮政地址类。

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

### 常量

H
update  
HelloCrease 已提交
4326 4327 4328 4329 4330 4331 4332
| 名称             | 值   | 说明                 |
| ---------------- | ---- | -------------------- |
| CUSTOM_LABEL     | 0    | 自定义邮政地址类型。 |
| ADDR_HOME        | 1    | 家庭地址类型。       |
| ADDR_WORK        | 2    | 工作地址类型。       |
| ADDR_OTHER       | 3    | 其它地址类型。       |
| INVALID_LABEL_ID | -1   | 无效地址类型。       |
O
ohos-lsw 已提交
4333 4334 4335 4336


### 属性

Y
YOUR_NAME 已提交
4337
| 名称          |   类型   | 可读 | 可写 | 说明                       |
H
update  
HelloCrease 已提交
4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
| ------------- | -------- | ---- | ---- | -------------------------- |
| city          | string   | 是   | 是   | 联系人所在的城市。         |
| country       | string   | 是   | 是   | 联系人所在的国家。         |
| labelName     | string   | 是   | 是   | 邮政地址类型名称。         |
| neighborhood  | string   | 是   | 是   | 联系人的邻居。             |
| pobox         | string   | 是   | 是   | 联系人的邮箱。             |
| postalAddress | string   | 是   | 是   | 联系人的邮政地址。         |
| postcode      | string   | 是   | 是   | 联系人所在区域的邮政编码。 |
| region        | string   | 是   | 是   | 联系人所在的区域。         |
| street        | string   | 是   | 是   | 联系人所在的街道。         |
| labelId       | number   | 是   | 是   | 邮政地址名称。             |
O
ohos-lsw 已提交
4349 4350 4351 4352 4353 4354


**对象创建示例:**

  使用JSON格式创建数据:

4355
```js
O
ohos-lsw 已提交
4356 4357 4358 4359 4360 4361 4362
let postalAddress = {
    city: "city"
};
```

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

Z
zengyawen 已提交
4363
```js
O
ohos-lsw 已提交
4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376
let postalAddress = new contact.PostalAddress();
postalAddress.city = "city";
```


## Relation

联系人的关系类。

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

### 常量

H
update  
HelloCrease 已提交
4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394
| 名称                      | 值   | 说明               |
| ------------------------- | ---- | ------------------ |
| CUSTOM_LABEL              | 0    | 自定义关系类型。   |
| RELATION_ASSISTANT        | 1    | 助手关系类型。     |
| RELATION_BROTHER          | 2    | 兄弟关系类型。     |
| RELATION_CHILD            | 3    | 子女关系类型。     |
| RELATION_DOMESTIC_PARTNER | 4    | 同居同伴关系类型。 |
| RELATION_FATHER           | 5    | 父亲关系类型。     |
| RELATION_FRIEND           | 6    | 朋友关系类型。     |
| RELATION_MANAGER          | 7    | 管理者关系类型。   |
| RELATION_MOTHER           | 8    | 母亲关系类型。     |
| RELATION_PARENT           | 9    | 父母关系类型。     |
| RELATION_PARTNER          | 10   | 合作伙伴关系类型。 |
| RELATION_REFERRED_BY      | 11   | 推荐人关系类型。   |
| RELATION_RELATIVE         | 12   | 亲属关系类型。     |
| RELATION_SISTER           | 13   | 姐妹关系类型。     |
| RELATION_SPOUSE           | 14   | 配偶关系类型。     |
| INVALID_LABEL_ID          | -1   | 无效的关系类型。   |
O
ohos-lsw 已提交
4395 4396 4397 4398


### 属性

Y
YOUR_NAME 已提交
4399
| 名称         |   类型   | 可读 | 可写 | 说明           |
H
update  
HelloCrease 已提交
4400 4401 4402 4403
| ------------ | -------- | ---- | ---- | -------------- |
| labelName    | string   | 是   | 是   | 关系类型名称。 |
| relationName | string   | 是   | 是   | 关系名称。     |
| labelId      | number   | 是   | 是   | 关系类型。     |
O
ohos-lsw 已提交
4404 4405 4406 4407 4408 4409


**对象创建示例:**

  使用JSON格式创建数据:

4410
```js
O
ohos-lsw 已提交
4411 4412 4413 4414 4415 4416 4417 4418
let relation = {
    relationName: "relationName",
    labelId: contact.Relation.RELATION_ASSISTANT
};
```

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

Z
zengyawen 已提交
4419
```js
O
ohos-lsw 已提交
4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433
let relation = new contact.Relation();
relation.relationName = "relationName";
relation.labelId = contact.Relation.RELATION_ASSISTANT;
```


## SipAddress

联系人的会话发起协议(SIP)地址类。

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

### 常量

H
update  
HelloCrease 已提交
4434 4435 4436 4437 4438 4439 4440
| 名称             | 值   | 说明                                |
| ---------------- | ---- | ----------------------------------- |
| CUSTOM_LABEL     | 0    | 自定义会话发起协议(SIP)地址类型。 |
| SIP_HOME         | 1    | 家庭会话发起协议(SIP)地址类型。   |
| SIP_WORK         | 2    | 工作会话发起协议(SIP)地址类型。   |
| SIP_OTHER        | 3    | 其它会话发起协议(SIP)地址类型。   |
| INVALID_LABEL_ID | -1   | 无效会话发起协议(SIP)地址类型。   |
O
ohos-lsw 已提交
4441 4442 4443 4444


### 属性

Y
YOUR_NAME 已提交
4445
| 名称       |   类型   | 可读 | 可写 | 说明                              |
H
update  
HelloCrease 已提交
4446 4447 4448 4449
| ---------- | -------- | ---- | ---- | --------------------------------- |
| labelName  | string   | 是   | 是   | 会话发起协议(SIP)地址类型名称。 |
| sipAddress | string   | 是   | 是   | 会话发起协议(SIP)地址。         |
| labelId    | number   | 是   | 是   | 会话发起协议(SIP)地址类型。     |
O
ohos-lsw 已提交
4450 4451 4452 4453 4454

**对象创建示例:**

  使用JSON格式创建数据:

4455
```js
O
ohos-lsw 已提交
4456 4457 4458 4459 4460 4461 4462
var sipAddress = {
    sipAddress: "sipAddress"
};
```

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

Z
zengyawen 已提交
4463
```js
O
ohos-lsw 已提交
4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474
let sipAddress = new contact.SipAddress();
sipAddress.sipAddress = "sipAddress";
```


## Website

联系人的网站信息类。

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

Y
YOUR_NAME 已提交
4475
| 名称    |   类型   | 可读 | 可写 | 说明               |
H
update  
HelloCrease 已提交
4476 4477
| ------- | -------- | ---- | ---- | ------------------ |
| website | string   | 是   | 是   | 联系人的网站信息。 |
O
ohos-lsw 已提交
4478 4479 4480 4481 4482 4483


**对象创建示例:**

  使用JSON格式创建数据:

4484
```js
O
ohos-lsw 已提交
4485 4486 4487 4488 4489 4490 4491
let website = {
    website: "website"
};
```

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

Z
zengyawen 已提交
4492
```js
O
ohos-lsw 已提交
4493 4494
let website = new contact.Website();
website.website = "website";
D
dingxiaochen 已提交
4495
```