@ohos.contact (联系人)

本模块提供联系人管理能力，包括添加联系人、删除联系人、更新联系人等

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import contact from '@ohos.contact';

contact.addContact¹⁰⁺

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

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.addContact(
    context,
    {name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
    }, (err: BusinessError, data) => {
      if (err) {
        console.log(`addContact callback: err->${JSON.stringify(err)}`);
        return;
      }
      console.log(`addContact callback: success data->${JSON.stringify(data)}`);
  });

contact.addContact(deprecated)⁷⁺

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

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用addContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.addContact({
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`addContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`addContact callback: success data->${JSON.stringify(data)}`);
});

contact.addContact¹⁰⁺

addContact(context: Context, contact: Contact): Promise<number>

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  let promise = contact.addContact(
    context,
    {name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  });
  promise.then((data) => {
    console.log(`addContact success: data->${JSON.stringify(data)}`);
  }).catch((err: BusinessError) => {
    console.error(`addContact fail: err->${JSON.stringify(err)}`);
  });

contact.addContact(deprecated)⁷⁺

addContact(contact: Contact): Promise<number>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用addContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.addContact({
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
});
promise.then((data) => {
    console.log(`addContact success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`addContact fail: err->${JSON.stringify(err)}`);
});

contact.deleteContact¹⁰⁺

deleteContact(context: Context, key: string, callback: AsyncCallback<void>): void

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.deleteContact(context, 'xxx', (err: BusinessError) => {
      if (err) {
          console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log('deleteContact success');
  });

contact.deleteContact(deprecated)⁷⁺

deleteContact(key: string, callback: AsyncCallback<void>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用deleteContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.deleteContact('xxx', (err: BusinessError) => {
    if (err) {
        console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('deleteContact success');
});

contact.deleteContact¹⁰⁺

deleteContact(context: Context, key: string): Promise<void>

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.deleteContact(context, 'xxx');
promise.then(() => {
    console.log(`deleteContact success`);
}).catch((err: BusinessError) => {
    console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
});

contact.deleteContact(deprecated)⁷⁺

deleteContact(key: string): Promise<void>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用deleteContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.deleteContact('xxx');
promise.then(() => {
    console.log(`deleteContact success`);
}).catch((err: BusinessError) => {
    console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
});

contact.updateContact¹⁰⁺

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

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.updateContact(context, {
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err: BusinessError) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact(deprecated)⁷⁺

updateContact(contact: Contact, callback: AsyncCallback<void>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err: BusinessError) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact¹⁰⁺

updateContact(context: Context, contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.updateContact(context, {
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact(deprecated)⁷⁺

updateContact(contact: Contact, attrs: ContactAttributes, callback: AsyncCallback<void>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err：BusinessError) => {
    if (err) {
        console.log(`updateContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log('updateContact success');
});

contact.updateContact¹⁰⁺

updateContact(context: Context, contact: Contact, attrs?: ContactAttributes): Promise<void>

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

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  let promise = contact.updateContact(context, {
      id: 1,
      name: {fullName: 'xxx'},
      phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  }, {
      attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
  });
  promise.then(() => {
      console.log('updateContact success');
  }).catch((err: BusinessError) => {
      console.error(`updateContact fail: err->${JSON.stringify(err)}`);
  });

contact.updateContact(deprecated)⁷⁺

updateContact(contact: Contact, attrs?: ContactAttributes): Promise<void>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用updateContact

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.updateContact({
    id: 1,
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then(() => {
    console.log('updateContact success');
}).catch((err) => {
    console.error(`updateContact fail: err->${JSON.stringify(err)}`);
});

contact.isLocalContact¹⁰⁺

isLocalContact(context: Context, id: number, callback: AsyncCallback<boolean>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage){
    globalThis.context = this.context;
  }
}
contact.isLocalContact(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)}`);
});

contact.isLocalContact(deprecated)⁷⁺

isLocalContact(id: number, callback: AsyncCallback<boolean>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isLocalContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.isLocalContact(/*id*/1, (err, data) => {
    if (err) {
        console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
});

contact.isLocalContact¹⁰⁺

isLocalContact(context: Context, id: number): Promise<boolean>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  let promise = contact.isLocalContact(context, /*id*/1);
  promise.then((data) => {
      console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
  }).catch((err: BusinessError) => {
      console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
  });

contact.isLocalContact(deprecated)⁷⁺

isLocalContact(id: number): Promise<boolean>

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

说明 从API version 7 开始支持，从API 10 开始废弃，建议使用isLocalContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.isLocalContact(/*id*/1);
promise.then((data) => {
    console.log(`isLocalContact success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`isLocalContact fail: err->${JSON.stringify(err)}`);
});

contact.isMyCard¹⁰⁺

isMyCard(context: Context, id: number, callback: AsyncCallback<boolean>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.isMyCard(context, /*id*/1, (err: BusinessError, data) => {
      if (err) {
          console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.isMyCard(deprecated)⁷⁺

isMyCard(id: number, callback: AsyncCallback<boolean>): void

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

说明 从API version 7 开始支持，从API 10 开始废弃，建议使用isMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.isMyCard(/*id*/1, (err: BusinessError, data) => {
    if (err) {
        console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.isMyCard¹⁰⁺

isMyCard(context: Context, id: number): Promise<boolean>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  let promise = contact.isMyCard(context, /*id*/1);
  promise.then((data) => {
      console.log(`isMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err: BusinessError) => {
      console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
  });

contact.isMyCard(deprecated)⁷⁺

isMyCard(id: number): Promise<boolean>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用isMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.isMyCard(/*id*/1);
promise.then((data) => {
    console.log(`isMyCard success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
});

contact.queryMyCard¹⁰⁺

queryMyCard(context: Context, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.queryMyCard(context, (err: BusinessError, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.queryMyCard(deprecated)⁷⁺

queryMyCard(callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryMyCard((err: BusinessError, data) => {
    if (err) {
        console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.queryMyCard¹⁰⁺

queryMyCard(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.queryMyCard(context, {
      attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
  }, (err: BusinessError, data) => {
      if (err) {
          console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  });

contact.queryMyCard(deprecated)⁷⁺

queryMyCard(attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryMyCard({
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
});

contact.queryMyCard¹⁰⁺

queryMyCard(context: Context, attrs?: ContactAttributes): Promise<Contact>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  let promise = contact.queryMyCard(context, {
      attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
  });
  promise.then((data) => {
      console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
  }).catch((err: BusinessError) => {
      console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
  });

contact.queryMyCard(deprecated)⁷⁺

queryMyCard(attrs?: ContactAttributes): Promise<Contact>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryMyCard

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryMyCard({
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
    console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
});

contact.selectContact(deprecated)⁷⁺

selectContact(callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用selectContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.Contacts

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.selectContact((err: BusinessError, data) => {
    if (err) {
        console.log(`selectContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
});

contact.selectContact(deprecated)⁷⁺

selectContact(): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用selectContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.Contacts

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.selectContact();
promise.then((data) => {
    console.log(`selectContact success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`selectContact fail: err->${JSON.stringify(err)}`);
});

contact.selectContacts¹⁰⁺

selectContacts(callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
contact.selectContacts((err: BusinessError, data) => {
    if (err) {
        console.log(`selectContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContacts callback: success data->${JSON.stringify(data)}`);
});

contact.selectContacts¹⁰⁺

selectContacts(): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.selectContacts();
promise.then((data) => {
    console.log(`selectContacts success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`selectContacts fail: err->${JSON.stringify(err)}`);
});

contact.selectContacts¹⁰⁺

selectContacts(options: ContactSelectionOptions, callback: AsyncCallback<Array<Contact>>): void

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用callback方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
contact.selectContacts({
  isMultiSelect:false
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`selectContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`selectContacts callback: success data->${JSON.stringify(data)}`);
});

contact.selectContacts¹⁰⁺

selectContacts(options: ContactSelectionOptions): Promise<Array<Contact>>

调用选择联系人接口，打开选择联系人UI界面，选定的联系人使用Promise方式作为异步方法。

系统能力：SystemCapability.Applications.Contacts

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.selectContacts({isMultiSelect:false});
promise.then((data) => {
    console.log(`selectContacts success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`selectContacts fail: err->${JSON.stringify(err)}`);
});

contact.queryContact¹⁰⁺

queryContact(context: Context, key: string, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContact(context, 'xxx', (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)⁷⁺

queryContact(key: string, callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContact('xxx', (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact¹⁰⁺

queryContact(context: Context, key: string, holder: Holder, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContact(context, 'xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)⁷⁺

queryContact(key: string, holder: Holder, callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContact('xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact¹⁰⁺

queryContact(context: Context, key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContact(context, 'xxx', {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact(deprecated)⁷⁺

queryContact(key: string, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContact('xxx', {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContact callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
});

contact.queryContact¹⁰⁺

queryContact(context: Context, key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

  import { BusinessError } from '@ohos.base';
  // 获取context
  let context = getContext(this) as Context;
  contact.queryContact(context, 'xxx', {
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
  }, (err: BusinessError, data) => {
      if (err) {
          console.log(`queryContact callback: err->${JSON.stringify(err)}`);
          return;
      }
      console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  });

contact.queryContact(deprecated)⁷⁺

queryContact(key: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Contact>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

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

contact.queryContact¹⁰⁺

queryContact(context: Context, key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryContact(context, 'xxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
    console.log(`queryContact success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContact fail: err->${JSON.stringify(err)}`);
});

contact.queryContact(deprecated)⁷⁺

queryContact(key: string, holder?: Holder, attrs?: ContactAttributes): Promise<Contact>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContact

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

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

contact.queryContacts¹⁰⁺

queryContacts(context: Context, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContacts(context, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)⁷⁺

queryContacts(callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContacts((err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts¹⁰⁺

queryContacts(context: Context, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContacts(context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)⁷⁺

queryContacts(holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContacts({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts¹⁰⁺

queryContacts(context: Context, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContacts(context, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)⁷⁺

queryContacts(attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContacts({
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts¹⁰⁺

queryContacts(context: Context, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContacts(context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts(deprecated)⁷⁺

queryContacts(holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContacts({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
});

contact.queryContacts¹⁰⁺

queryContacts(context: Context, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryContacts(context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
    console.log(`queryContacts success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
});

contact.queryContacts(deprecated)⁷⁺

queryContacts(holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContacts

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

  import { BusinessError } from '@ohos.base';
  let promise = contact.queryContacts({
      holderId: 0,
      bundleName: "",
      displayName: ""
  }, {
      attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
  });
  promise.then((data) => {
      console.log(`queryContacts success: data->${JSON.stringify(data)}`);
  }).catch((err: BusinessError) => {
      console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
  });

contact.queryContactsByPhoneNumber¹⁰⁺

queryContactsByPhoneNumber(context: Context, phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)⁷⁺

queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

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

contact.queryContactsByPhoneNumber¹⁰⁺

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)⁷⁺

queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber¹⁰⁺

queryContactsByPhoneNumber(context: Context, phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)⁷⁺

queryContactsByPhoneNumber(phoneNumber: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber¹⁰⁺

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber(deprecated)⁷⁺

queryContactsByPhoneNumber(phoneNumber: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber¹⁰⁺

queryContactsByPhoneNumber(context: Context, phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryContactsByPhoneNumber(context, '138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
    console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByPhoneNumber(deprecated)⁷⁺

queryContactsByPhoneNumber(phoneNumber: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByPhoneNumber

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE]
});
promise.then((data) => {
    console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByEmail¹⁰⁺

queryContactsByEmail(context: Context, email: string, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByEmail(context, 'xxx@email.com', (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)⁷⁺

queryContactsByEmail(email: string, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByEmail('xxx@email.com', (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail¹⁰⁺

queryContactsByEmail(context: Context, email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByEmail(context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)⁷⁺

queryContactsByEmail(email: string, holder: Holder, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByEmail('xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail¹⁰⁺

queryContactsByEmail(context: Context, email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByEmail(context, 'xxx@email.com', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)⁷⁺

queryContactsByEmail(email: string, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryContactsByEmail('xxx@email.com', {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail¹⁰⁺

queryContactsByEmail(context: Context, email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryContactsByEmail(context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
});

contact.queryContactsByEmail(deprecated)⁷⁺

queryContactsByEmail(email: string, holder: Holder, attrs: ContactAttributes, callback: AsyncCallback<Array<Contact>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

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

contact.queryContactsByEmail¹⁰⁺

queryContactsByEmail(context: Context, email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryContactsByEmail(context, 'xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});

contact.queryContactsByEmail(deprecated)⁷⁺

queryContactsByEmail(email: string, holder?: Holder, attrs?: ContactAttributes): Promise<Array<Contact>>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryContactsByEmail

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryContactsByEmail('xxx@email.com', {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, {
    attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
});
promise.then((data) => {
    console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
});

contact.queryGroups¹⁰⁺

queryGroups(context: Context, callback: AsyncCallback<Array<Group>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryGroups(context, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups(deprecated)⁷⁺

queryGroups(callback: AsyncCallback<Array<Group>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryGroups((err: BusinessError, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups¹⁰⁺

queryGroups(context: Context, holder: Holder, callback: AsyncCallback<Array<Group>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryGroups(context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups(deprecated)⁷⁺

queryGroups(holder: Holder, callback: AsyncCallback<Array<Group>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryGroups({
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
});

contact.queryGroups¹⁰⁺

queryGroups(context: Context, holder?: Holder): Promise<Array<Group>>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryGroups(context, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});

contact.queryGroups(deprecated)⁷⁺

queryGroups(holder?: Holder): Promise<Array<Group>>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryGroups

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryGroups({
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryGroups success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
});

contact.queryHolders¹⁰⁺

queryHolders(context: Context, callback: AsyncCallback<Array<Holder>>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryHolders(context, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});

contact.queryHolders(deprecated)⁷⁺

queryHolders(callback: AsyncCallback<Array<Holder>>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryHolders

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryHolders((err: BusinessError, data) => {
    if (err) {
        console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
});

contact.queryHolders¹⁰⁺

queryHolders(context: Context): Promise<Array<Holder>>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryHolders(context);
promise.then((data) => {
    console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});

contact.queryHolders(deprecated)⁷⁺

queryHolders(): Promise<Array<Holder>>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryHolders

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryHolders();
promise.then((data) => {
    console.log(`queryHolders success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
});

contact.queryKey¹⁰⁺

queryKey(context: Context, id: number, callback: AsyncCallback<string>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryKey(context, /*id*/1, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey(deprecated)⁷⁺

queryKey(id: number, callback: AsyncCallback<string>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryKey(/*id*/1, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey¹⁰⁺

queryKey(context: Context, id: number, holder: Holder, callback: AsyncCallback<string>): void

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
contact.queryKey(context, /*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey(deprecated)⁷⁺

queryKey(id: number, holder: Holder, callback: AsyncCallback<string>): void

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

示例：

import { BusinessError } from '@ohos.base';
contact.queryKey(/*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
}, (err: BusinessError, data) => {
    if (err) {
        console.log(`queryKey callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
});

contact.queryKey¹⁰⁺

queryKey(context: Context, id: number, holder?: Holder): Promise<string>

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

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

错误码：

示例：

import { BusinessError } from '@ohos.base';
// 获取context
let context = getContext(this) as Context;
let promise = contact.queryKey(context, /*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryKey success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryKey fail: err->${JSON.stringify(err)}`);
});

contact.queryKey(deprecated)⁷⁺

queryKey(id: number, holder?: Holder): Promise<string>

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

说明

从API version 7 开始支持，从API 10 开始废弃，建议使用queryKey

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let promise = contact.queryKey(/*id*/1, {
    holderId: 0,
    bundleName: "",
    displayName: ""
});
promise.then((data) => {
    console.log(`queryKey success: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`queryKey fail: err->${JSON.stringify(err)}`);
});

ContactSelectionOptions¹⁰⁺

选择联系人条件。

系统能力：SystemCapability.Applications.Contacts

Contact

联系人对象类。

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

常量

属性

对象创建示例：

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

let myContact: contact.Contact = {
    phoneNumbers: [{
        phoneNumber: "138xxxxxxxx"
    }],
    name: {
        fullName: "fullName",
        namePrefix: "namePrefix"
    },
    nickName: {
        nickName: "nickName"
    }
};

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

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。

对象创建示例：

使用JSON格式创建数据：

let contactAttributes: contact.ContactAttributes = {
    attributes: [
        contact.Attribute.ATTR_EMAIL,
        contact.Attribute.ATTR_NAME,
        contact.Attribute.ATTR_PHONE
    ]
};

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

let contactAttributes = new contact.ContactAttributes();
contactAttributes.attributes = [contact.Attribute.ATTR_EMAIL];

Attribute

枚举，联系人属性列表。

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

对象创建示例：

使用JSON格式创建数据：

let attributes = [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE];

Email

联系人的邮箱。

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

常量

属性

对象创建示例：

使用JSON格式创建数据：

let email: contact.Email = {
    email: "xxx@email.com",
    displayName: "displayName"
}

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

let email = new contact.Email();
email.email = "xxx@email.com";

Holder

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

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

对象创建示例：

使用JSON格式创建数据：

let holder: contact.Holder = {
  bundleName: "com.ohos.contacts",
  displayName: "displayName",
  holderId: 0
};

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

let holder = new contact.Holder();
holder.holderId = 0;

Event

联系人事件类。

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

常量

属性

对象创建示例：

使用JSON格式创建数据：

let event: contact.Event = {
    eventDate: "xxxxxx"
};

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

let event = new contact.Event();
event.eventDate = "xxxxxx";

Group

联系人的群组类。

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

对象创建示例：

使用JSON格式创建数据：

let group: contact.Group = {
    groupId: 1,
    title: "title"
};

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

let group = new contact.Group();
group.title = "title";

ImAddress

联系人的即时消息地址。

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

常量

属性

对象创建示例：

使用JSON格式创建数据：

let imAddress: contact.ImAddress = {
    imAddress: "imAddress",
    labelName: "labelName"
};

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

let imAddress = new contact.ImAddress();
imAddress.imAddress = "imAddress";

Name

联系人的名字类。

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

对象创建示例：

使用JSON格式创建数据：

let name: contact.Name = {
    familyName: "familyName",
    fullName: "fullName"
};

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

let name = new contact.Name();
name.familyName = "familyName";
name.fullName = "fullName";

NickName

联系人的昵称类。

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

对象创建示例：

使用JSON格式创建数据：

let nickName: contact.NickName = {
    nickName: "nickName"
};

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

let nickName = new contact.NickName();
nickName.nickName = "nickName";

Note

联系人的备注类。

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

对象创建示例：

使用JSON格式创建数据：

let note: contact.Note() = {
    noteContent: "noteContent"
};

或使用new一个Note对象的方式创建数据：

let note = new contact.Note();
note.noteContent = "noteContent";

Organization

联系人的组织类。

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

对象创建示例：

使用JSON格式创建数据：

let organization: contact.Organization = {
    name: "name",
    title: "title"
};

或使用new一个Organization对象的方式创建数据：

let organization = new contact.Organization();
organization.name = "name";
organization.title = "title";

PhoneNumber

联系人电话号码类。

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

常量

属性

对象创建示例：

使用JSON格式创建数据：

let phoneNumber: contact.PhoneNumber = {
    phoneNumber: "138xxxxxxxx",
    labelId: contact.PhoneNumber.NUM_HOME
};

或使用new一个PhoneNumber对象的方式创建数据：

let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";

Portrait

联系人的头像类。

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

对象创建示例：

使用JSON格式创建数据：

let portrait: contact.Portrait = {
    uri: "uri"
};

或使用new一个Portrait对象的方式创建数据：

let portrait = new contact.Portrait();
portrait.uri = "uri";

PostalAddress

联系人的邮政地址类。

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

常量