@ohos.contact (Contacts)

The contact module provides contact management functions, such as adding, deleting, and updating contacts.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import contact from '@ohos.contact';

contact.addContact¹⁰⁺

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

Adds a contact. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Adds a contact. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use addContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Adds a contact. This API uses a promise to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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>

Adds a contact. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use addContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Deletes a contact based on the specified contact key. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Deletes a contact based on the specified contact key. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use deleteContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Deletes a contact based on the specified contact key. This API uses a promise to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>

Deletes a contact based on the specified contact key. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use deleteContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Updates a contact based on the specified contact information. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Updates a contact based on the specified contact information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use updateContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Updates a contact based on the specified contact information. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Updates a contact based on the specified contact information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use updateContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Updates a contact based on the specified contact information and attributes. This API uses a promise to return the result.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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>

Updates a contact based on the specified contact information and attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use updateContact.

Permission required: ohos.permission.WRITE_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Checks whether the ID of this contact is in the local address book. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Checks whether the ID of this contact is in the local address book. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use isLocalContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Checks whether the ID of this contact is in the local address book. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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>

Checks whether the ID of this contact is in the local address book. This API uses a promise to return the result.

NOTE This API is supported since API version 7 and deprecated since API version 10. You are advised to use isLocalContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Checks whether a contact is included in my card. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Checks whether a contact is included in my card. This API uses an asynchronous callback to return the result.

NOTE This API is supported since API version 7 and deprecated since API version 10. You are advised to use isMyCard.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Checks whether a contact is included in my card. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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>

Checks whether a contact is included in my card. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use isMyCard.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Queries my card. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Queries my card. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryMyCard.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries my card. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Queries my card. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryMyCard.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Queries my card based on the specified contact attributes. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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>

Queries my card based on the specified contact attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryMyCard.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Selects a contact. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use selectContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.Contacts

Parameters

Example

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>>

Selects a contact. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use selectContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.Contacts

Return Value

Example

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

Selects a contact. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.Contacts

Parameters

Error codes

Example

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

contact.selectContacts¹⁰⁺

selectContacts(): Promise<Array<Contact>>

Selects a contact. This API uses a promise to return the result.

System capability: SystemCapability.Applications.Contacts

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
let promise = contact.selectContacts();
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(options: ContactSelectionOptions, callback: AsyncCallback<Array<Contact>>): void

Selects a contact. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.Contacts

Parameters

Error codes

Example

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

contact.selectContacts¹⁰⁺

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

Selects a contact. This API uses a promise to return the result.

System capability: SystemCapability.Applications.Contacts

Return Value

Error codes

Example

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

contact.queryContact¹⁰⁺

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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

  import { BusinessError } from '@ohos.base';
  // Obtain the 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

Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Queries contacts based on the specified key, application, and attributes. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>

Queries contacts based on the specified key, application, and attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContact.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Queries all contacts. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all contacts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries all contacts. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all contacts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries all contacts. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all contacts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries all contacts. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all contacts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>>

Queries all contacts based on the specified application and attributes. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>>

Queries all contacts based on the specified application and attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContacts.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

  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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByPhoneNumber.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByPhoneNumber.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByPhoneNumber.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByPhoneNumber.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>>

Queries contacts based on the specified phone number, application, and attributes. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>>

Queries contacts based on the specified phone number, application, and attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByPhoneNumber.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByEmail.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByEmail.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByEmail.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByEmail.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>>

Queries contacts based on the specified email address, application, and attributes. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>>

Queries contacts based on the specified email address, application, and attributes. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryContactsByEmail.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Queries all groups of this contact. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all groups of this contact. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryGroups.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries all groups of this contact. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all groups of this contact. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryGroups.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>>

Queries all groups of this contact based on the specified application. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>>

Queries all groups of this contact based on the specified application. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryGroups.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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

Queries all applications that have created contacts. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries all applications that have created contacts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryHolders.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>>

Queries all applications that have created contacts. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>>

Queries all applications that have created contacts. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryHolders.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Return Value

Example

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

Queries the key of a contact based on the specified contact ID. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries the key of a contact based on the specified contact ID. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryKey.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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

Queries the key of a contact based on the specified contact ID. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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

Queries the key of a contact based on the specified contact ID. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryKey.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Example

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>

Queries the key of a contact based on the specified contact ID and application. This API uses a promise to return the result.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Error codes

Example

import { BusinessError } from '@ohos.base';
// Obtain the 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>

Queries the key of a contact based on the specified contact ID and application. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 10. You are advised to use queryKey.

Permission required: ohos.permission.READ_CONTACTS

System capability: SystemCapability.Applications.ContactsData

Parameters

Return Value

Example

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¹⁰⁺

Defines the contact selection options.

System capability: SystemCapability.Applications.Contacts

Contact

Defines a contact.

System capability: SystemCapability.Applications.ContactsData

Constant

Attributes

Example

Create contact data in JSON format:

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

Or, create data by configuring a new Contact object.

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

Provides a list of contact attributes, which are generally used as arguments. If null is passed, all attributes are queried by default.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a ContactAttributes object.

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

Attribute

Enumerates contact attributes.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Email

Defines a contact's email.

System capability: SystemCapability.Applications.ContactsData

Constant

Attributes

Example

Create contact data in JSON format:

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

Or, create data by configuring an Email object.

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

Holder

Defines an application that creates the contact.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a Holder object.

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

Event

Defines a contact's event.

System capability: SystemCapability.Applications.ContactsData

Constant

Attributes

Example

Create contact data in JSON format:

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

Or, create data by configuring an Event object.

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

Group

Defines a contact group.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a Group object.

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

ImAddress

Enumerates IM addresses.

System capability: SystemCapability.Applications.ContactsData

Constant

Attributes

Example

Create contact data in JSON format:

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

Or, create data by configuring an ImAddress object.

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

Name

Defines a contact's name.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a Name object.

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

NickName

Defines a contact's nickname.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a NickName object.

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

Note

Defines a contact's note.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a Note object.

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

Organization

Defines a contact's organization.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring an Organization object.

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

PhoneNumber

Defines a contact's phone number.

System capability: SystemCapability.Applications.ContactsData

Constant

Attributes

Example

Create contact data in JSON format:

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

Or, create data by configuring a new PhoneNumber object.

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

Portrait

Defines a contact's portrait.

System capability: SystemCapability.Applications.ContactsData

Example

Create contact data in JSON format:

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

Or, create data by configuring a new Portrait object.

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