codecamp

联系人

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

说明

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

导入模块

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

contact.addContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

contact

Contact

是

联系人信息。

callback

AsyncCallback<number>

是

回调函数，返回添加的联系人id。

示例：

  1. contact.addContact({
  2.     name: {fullName: 'xxx'},
  3.     phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  4. }, (err, data) => {
  5.     if (err) {
  6.         console.log(`addContact callback: err->${JSON.stringify(err)}`);
  7.         return;
  8.     }
  9.     console.log(`addContact callback: success data->${JSON.stringify(data)}`);
  10. });

contact.addContact

addContact(contact: Contact): Promise<number>

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

contact

Contact

是

联系人信息。

返回值：

类型

说明

Promise<number>

以Promise形式返回结果，返回添加的联系人id。

示例：

  1. let promise = contact.addContact({
  2.     name: {fullName: 'xxx'},
  3.     phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  4. });
  5. promise.then((data) => {
  6.     console.log(`addContact success: data->${JSON.stringify(data)}`);
  7. }).catch((err) => {
  8.     console.error(`addContact fail: err->${JSON.stringify(err)}`);
  9. });

contact.deleteContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人key值，一个联系人对应一个key。

callback

AsyncCallback<void>

是

异步删除联系人之后的回调。

示例：

  1. contact.deleteContact('xxx', (err) => {
  2.     if (err) {
  3.         console.log(`deleteContact callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log('deleteContact success');
  7. });

contact.deleteContact

deleteContact(key: string): Promise<void>

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

返回值：

类型

说明

Promise<void>

返回一个Promise对象。

示例：

  1. let promise = contact.deleteContact('xxx');
  2. promise.then(() => {
  3.     console.log(`deleteContact success`);
  4. }).catch((err) => {
  5.     console.error(`deleteContact fail: err->${JSON.stringify(err)}`);
  6. });

contact.updateContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

contact

Contact

是

联系人信息。

callback

AsyncCallback<void>

是

异步更新联系人之后的回调。

示例：

  1. contact.updateContact({
  2.     id: 1,
  3.     name: {fullName: 'xxx'},
  4.     phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  5. }, (err) => {
  6.     if (err) {
  7.         console.log(`updateContact callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log('updateContact success');
  11. });

contact.updateContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

contact

Contact

是

联系人信息。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<void>

是

异步更新联系人之后的回调。

示例：

  1. contact.updateContact({
  2.     id: 1,
  3.     name: {fullName: 'xxx'},
  4.     phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. }, (err) => {
  8.     if (err) {
  9.         console.log(`updateContact callback: err->${JSON.stringify(err)}`);
  10.         return;
  11.     }
  12.     console.log('updateContact success');
  13. });

contact.updateContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.WRITE_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

contact

Contact

是

联系人信息。

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<void>

返回一个Promise对象。

示例：

  1. let promise = contact.updateContact({
  2.     id: 1,
  3.     name: {fullName: 'xxx'},
  4.     phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. });
  8. promise.then(() => {
  9.     console.log('updateContact success');
  10. }).catch((err) => {
  11.     console.error(`updateContact fail: err->${JSON.stringify(err)}`);
  12. });

contact.isLocalContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性，一个联系人对应一个id。

callback

AsyncCallback<boolean>

是

回调函数，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

示例：

  1. contact.isLocalContact(/*id*/1, (err, data) => {
  2.     if (err) {
  3.         console.log(`isLocalContact callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`isLocalContact callback: success data->${JSON.stringify(data)}`);
  7. });

contact.isLocalContact

isLocalContact(id: number): Promise<boolean>

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性，一个联系人对应一个id。

返回值：

类型

说明

Promise<boolean>

以Promise形式返回结果，返回布尔值。true代表联系人id在本地电话簿中，false则代表联系人id不在本地电话簿中。

示例：

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

contact.isMyCard

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性。

callback

AsyncCallback<boolean>

是

回调函数，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

示例：

  1. contact.isMyCard(/*id*/1, (err, data) => {
  2.     if (err) {
  3.         console.log(`isMyCard callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`isMyCard callback: success data->${JSON.stringify(data)}`);
  7. });

contact.isMyCard

isMyCard(id: number): Promise<boolean>

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性。

返回值：

类型

说明

Promise<boolean>

以Promise形式返回结果，返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”，false则代表不是。

示例：

  1. let promise = contact.isMyCard(/*id*/1);
  2. promise.then((data) => {
  3.     console.log(`isMyCard success: data->${JSON.stringify(data)}`);
  4. }).catch((err) => {
  5.     console.error(`isMyCard fail: err->${JSON.stringify(err)}`);
  6. });

contact.queryMyCard

queryMyCard(callback: AsyncCallback<Contact>): void

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

callback

AsyncCallback<Contact>

是

回调函数，返回“我的名片”信息。

示例：

  1. contact.queryMyCard((err, data) => {
  2.     if (err) {
  3.         console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryMyCard

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Contact>

是

回调函数，返回“我的名片”信息。

示例：

  1. contact.queryMyCard({
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. }, (err, data) => {
  4.     if (err) {
  5.         console.log(`queryMyCard callback: err->${JSON.stringify(err)}`);
  6.         return;
  7.     }
  8.     console.log(`queryMyCard callback: success data->${JSON.stringify(data)}`);
  9. });

contact.queryMyCard

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<Contact>

以Promise形式返回结果，返回“我的名片”信息。

示例：

  1. let promise = contact.queryMyCard({
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. });
  4. promise.then((data) => {
  5.     console.log(`queryMyCard success: data->${JSON.stringify(data)}`);
  6. }).catch((err) => {
  7.     console.error(`queryMyCard fail: err->${JSON.stringify(err)}`);
  8. });

contact.selectContact

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

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

该接口仅支持在FA模型中调用。

系统能力：SystemCapability.Applications.Contacts

参数：

参数名

类型

必填

说明

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回选择的联系人对象数组。

示例：

  1. contact.selectContact((err, data) => {
  2.     if (err) {
  3.         console.log(`selectContact callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`selectContact callback: success data->${JSON.stringify(data)}`);
  7. });

contact.selectContact

selectContact(): Promise<Array<Contact>>

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

该接口仅支持在FA模型中调用。

系统能力：SystemCapability.Applications.Contacts

返回值：

类型

说明

Promise<Array<Contact>>

以Promise形式返回结果，返回选择的联系人对象数组。

示例：

  1. let promise = contact.selectContact();
  2. promise.then((data) => {
  3.     console.log(`selectContact success: data->${JSON.stringify(data)}`);
  4. }).catch((err) => {
  5.     console.error(`selectContact fail: err->${JSON.stringify(err)}`);
  6. });

contact.queryContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

callback

AsyncCallback<Contact>

是

回调函数，返回查询的联系人对象。

示例：

  1. contact.queryContact('xxx', (err, data) => {
  2.     if (err) {
  3.         console.log(`queryContact callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<Contact>

是

回调函数，返回查询的联系人对象。

示例：

  1. contact.queryContact('xxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryContact callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Contact>

是

回调函数，返回查询的联系人对象。

示例：

  1. contact.queryContact('xxx', {
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. }, (err, data) => {
  4.     if (err) {
  5.         console.log(`queryContact callback: err->${JSON.stringify(err)}`);
  6.         return;
  7.     }
  8.     console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  9. });

contact.queryContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

holder

Holder

是

创建联系人的应用信息。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Contact>

是

回调函数，返回查询的联系人对象。

示例：

  1. contact.queryContact('xxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. }, (err, data) => {
  8.     if (err) {
  9.         console.log(`queryContact callback: err->${JSON.stringify(err)}`);
  10.         return;
  11.     }
  12.     console.log(`queryContact callback: success data->${JSON.stringify(data)}`);
  13. });

contact.queryContact

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

key

string

是

联系人的key值，一个联系人对应一个key。

holder

Holder

否

创建联系人的应用信息。

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<Contact>

以Promise形式返回结果，返回查询到的联系人对象。

示例：

  1. let promise = contact.queryContact('xxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. });
  8. promise.then((data) => {
  9.     console.log(`queryContact success: data->${JSON.stringify(data)}`);
  10. }).catch((err) => {
  11.     console.error(`queryContact fail: err->${JSON.stringify(err)}`);
  12. });

contact.queryContacts

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContacts((err, data) => {
  2.     if (err) {
  3.         console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryContacts

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContacts({
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryContacts

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContacts({
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. }, (err, data) => {
  4.     if (err) {
  5.         console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
  6.         return;
  7.     }
  8.     console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  9. });

contact.queryContacts

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

holder

Holder

是

创建联系人的应用信息。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContacts({
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. }, (err, data) => {
  8.     if (err) {
  9.         console.log(`queryContacts callback: err->${JSON.stringify(err)}`);
  10.         return;
  11.     }
  12.     console.log(`queryContacts callback: success data->${JSON.stringify(data)}`);
  13. });

contact.queryContacts

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

holder

Holder

否

创建联系人的应用信息。

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<Array<Contact>>

以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

  1. let promise = contact.queryContacts({
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. });
  8. promise.then((data) => {
  9.     console.log(`queryContacts success: data->${JSON.stringify(data)}`);
  10. }).catch((err) => {
  11.     console.error(`queryContacts fail: err->${JSON.stringify(err)}`);
  12. });

contact.queryContactsByPhoneNumber

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

phoneNumber

string

是

联系人的电话号码。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByPhoneNumber('138xxxxxxxx', (err, data) => {
  2.     if (err) {
  3.         console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryContactsByPhoneNumber

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

phoneNumber

string

是

联系人的电话号码。

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByPhoneNumber('138xxxxxxxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryContactsByPhoneNumber

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

phoneNumber

string

是

联系人的电话号码。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByPhoneNumber('138xxxxxxxx', {
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. }, (err, data) => {
  4.     if (err) {
  5.         console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
  6.         return;
  7.     }
  8.     console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  9. });

contact.queryContactsByPhoneNumber

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

phoneNumber

string

是

联系人的电话号码。

holder

Holder

是

创建联系人的应用信息。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByPhoneNumber('138xxxxxxxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. }, (err, data) => {
  8.     if (err) {
  9.         console.log(`queryContactsByPhoneNumber callback: err->${JSON.stringify(err)}`);
  10.         return;
  11.     }
  12.     console.log(`queryContactsByPhoneNumber callback: success data->${JSON.stringify(data)}`);
  13. });

contact.queryContactsByPhoneNumber

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

phoneNumber

string

是

联系人的电话号码。

holder

Holder

否

创建联系人的应用信息。

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<Array<Contact>>

以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

  1. let promise = contact.queryContactsByPhoneNumber('138xxxxxxxx', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. });
  8. promise.then((data) => {
  9.     console.log(`queryContactsByPhoneNumber success: data->${JSON.stringify(data)}`);
  10. }).catch((err) => {
  11.     console.error(`queryContactsByPhoneNumber fail: err->${JSON.stringify(err)}`);
  12. });

contact.queryContactsByEmail

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

email

string

是

联系人的邮箱地址。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByEmail('xxx@email.com', (err, data) => {
  2.     if (err) {
  3.         console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryContactsByEmail

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

email

string

是

联系人的邮箱地址。

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到的联系人对象数组。

示例：

  1. contact.queryContactsByEmail('xxx@email.com', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryContactsByEmail

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

email

string

是

联系人的邮箱地址。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到联系人对象数组。

示例：

  1. contact.queryContactsByEmail('xxx@email.com', {
  2.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  3. }, (err, data) => {
  4.     if (err) {
  5.         console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
  6.         return;
  7.     }
  8.     console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  9. });

contact.queryContactsByEmail

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

email

string

是

联系人的邮箱地址。

holder

Holder

是

创建联系人的应用信息。

attrs

ContactAttributes

是

联系人的属性列表。

callback

AsyncCallback<Array<Contact>>

是

回调函数，返回查询到联系人对象数组。

示例：

  1. contact.queryContactsByEmail('xxx@email.com', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. }, (err, data) => {
  8.     if (err) {
  9.         console.log(`queryContactsByEmail callback: err->${JSON.stringify(err)}`);
  10.         return;
  11.     }
  12.     console.log(`queryContactsByEmail callback: success data->${JSON.stringify(data)}`);
  13. });

contact.queryContactsByEmail

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

email

string

是

联系人的邮箱地址。

holder

Holder

否

创建联系人的应用信息。

attrs

ContactAttributes

否

联系人的属性列表。

返回值：

类型

说明

Promise<Array<Contact>>

以Promise形式返回结果，返回查询到的联系人对象数组。

示例：

  1. let promise = contact.queryContactsByEmail('xxx@email.com', {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, {
  6.     attributes: [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME]
  7. });
  8. promise.then((data) => {
  9.     console.log(`queryContactsByEmail success: data->${JSON.stringify(data)}`);
  10. }).catch((err) => {
  11.     console.error(`queryContactsByEmail fail: err->${JSON.stringify(err)}`);
  12. });

contact.queryGroups

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

callback

AsyncCallback<Array<Group>>

是

回调函数，返回查询到的群组对象数组。

示例：

  1. contact.queryGroups((err, data) => {
  2.     if (err) {
  3.         console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryGroups

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<Array<Group>>

是

回调函数，返回查询到的群组对象数组。

示例：

  1. contact.queryGroups({
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryGroups callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryGroups callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryGroups

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

holder

Holder

否

创建联系人的应用信息。

返回值：

类型

说明

Promise<Array<Group>>

以Promise形式返回结果，返回查询到的群组对象数组。

示例：

  1. let promise = contact.queryGroups({
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. });
  6. promise.then((data) => {
  7.     console.log(`queryGroups success: data->${JSON.stringify(data)}`);
  8. }).catch((err) => {
  9.     console.error(`queryGroups fail: err->${JSON.stringify(err)}`);
  10. });

contact.queryHolders

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

callback

AsyncCallback<Array<Holder>>

是

回调函数，返回查询到的创建联系人应用信息的对象数组。

示例：

  1. contact.queryHolders((err, data) => {
  2.     if (err) {
  3.         console.log(`queryHolders callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryHolders callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryHolders

queryHolders(): Promise<Array<Holder>>

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

返回值：

类型

说明

Promise<Array<Holder>>

以Promise形式返回结果，返回查询到的创建联系人应用信息的对象数组。

示例：

  1. let promise = contact.queryHolders();
  2. promise.then((data) => {
  3.     console.log(`queryHolders success: data->${JSON.stringify(data)}`);
  4. }).catch((err) => {
  5.     console.error(`queryHolders fail: err->${JSON.stringify(err)}`);
  6. });

contact.queryKey

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性。

callback

AsyncCallback<string>

是

回调函数，返回查询到的联系人对应的key。

示例：

  1. contact.queryKey(/*id*/1, (err, data) => {
  2.     if (err) {
  3.         console.log(`queryKey callback: err->${JSON.stringify(err)}`);
  4.         return;
  5.     }
  6.     console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
  7. });

contact.queryKey

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性。

holder

Holder

是

创建联系人的应用信息。

callback

AsyncCallback<string>

是

回调函数，返回查询到的联系人对应的key。

示例：

  1. contact.queryKey(/*id*/1, {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. }, (err, data) => {
  6.     if (err) {
  7.         console.log(`queryKey callback: err->${JSON.stringify(err)}`);
  8.         return;
  9.     }
  10.     console.log(`queryKey callback: success data->${JSON.stringify(data)}`);
  11. });

contact.queryKey

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

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

该接口仅支持在FA模型中调用。

需要权限：ohos.permission.READ_CONTACTS

系统能力：SystemCapability.Applications.ContactsData

参数：

参数名

类型

必填

说明

id

number

是

联系人对象的id属性。

holder

Holder

否

创建联系人的应用信息。

返回值：

类型

说明

Promise<string>

以Promise形式返回结果，返回查询到的联系人对应的key。

示例：

  1. let promise = contact.queryKey(/*id*/1, {
  2.     holderId: 0,
  3.     bundleName: "",
  4.     displayName: ""
  5. });
  6. promise.then((data) => {
  7.     console.log(`queryKey success: data->${JSON.stringify(data)}`);
  8. }).catch((err) => {
  9.     console.error(`queryKey fail: err->${JSON.stringify(err)}`);
  10. });

Contact

联系人对象类。

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

常量

名称

值

说明

INVALID_CONTACT_ID

-1

默认联系人的id。

属性

名称

类型

可读

可写

说明

id

number

是

否

联系人的id。

key

string

是

否

联系人的key。

contactAttributes

ContactAttributes

是

是

联系人的属性列表。

emails

Email[]

是

是

联系人的邮箱地址列表。

events

Event[]

是

是

联系人的生日、周年纪念等重要日期列表。

groups

Group[]

是

是

联系人的群组列表。

imAddresses

ImAddress[]

是

是

联系人的即时消息地址列表。

phoneNumbers

PhoneNumber[]

是

是

联系人的电话号码列表。

portrait

Portrait

是

是

联系人的头像。

postalAddresses

PostalAddress[]

是

是

联系人的邮政地址列表。

relations

Relation[]

是

是

联系人的关系列表。

sipAddresses

SipAddress[]

是

是

联系人的会话发起协议（SIP）地址列表。

websites

Website[]

是

是

联系人的网站列表。

name

Name

是

是

联系人的姓名。

nickName

NickName

是

是

联系人的昵称。

note

Note

是

是

联系人的备注。

organization

Organization

是

是

联系人的组织信息。

对象创建示例：

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

  1. let myContact = {
  2.     phoneNumbers: [{
  3.         phoneNumber: "138xxxxxxxx"
  4.     }],
  5.     name: {
  6.         fullName: "fullName",
  7.         namePrefix: "namePrefix"
  8.     },
  9.     nickName: {
  10.         nickName: "nickName"
  11.     }
  12. };

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

  1. let myContact = new contact.Contact();
  2. let name = new contact.Name();
  3. name.fullName = "fullName";
  4. let phoneNumber = new contact.PhoneNumber();
  5. phoneNumber.phoneNumber = "138xxxxxxxx";
  6. myContact.name = name;
  7. myContact.phoneNumbers = [phoneNumber];

ContactAttributes

联系人属性列表，一般作为入参用来标识希望查询的联系人属性。

当传入为null时，默认查询全部属性。

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

名称

类型

可读

可写

说明

attributes

Attribute[]

是

是

联系人属性列表。

对象创建示例：

使用JSON格式创建数据：

  1. let contactAttributes = {
  2.     attributes: [
  3.         contact.Attribute.ATTR_EMAIL,
  4.         contact.Attribute.ATTR_NAME,
  5.         contact.Attribute.ATTR_PHONE
  6.     ]
  7. };

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

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

Attribute

枚举，联系人属性列表。

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

名称

说明

ATTR_CONTACT_EVENT

联系人的生日、周年纪念等重要日期。

ATTR_EMAIL

联系人的邮箱地址。

ATTR_GROUP_MEMBERSHIP

联系人的群组。

ATTR_IM

联系人的即时消息地址。

ATTR_NAME

联系人的姓名。

ATTR_NICKNAME

联系人的昵称。

ATTR_NOTE

联系人的备注。

ATTR_ORGANIZATION

联系人的组织信息。

ATTR_PHONE

联系人的电话号码。

ATTR_PORTRAIT

联系人的头像。

ATTR_POSTAL_ADDRESS

联系人的邮政地址。

ATTR_RELATION

联系人的关系。

ATTR_SIP_ADDRESS

联系人的会话发起协议（SIP）地址。

ATTR_WEBSITE

联系人的网站。

对象创建示例：

使用JSON格式创建数据：

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

Email

联系人的邮箱。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义邮箱类型。

EMAIL_HOME

1

家庭邮箱类型。

EMAIL_WORK

2

工作邮箱类型。

EMAIL_OTHER

3

其它邮箱类型。

INVALID_LABEL_ID

-1

无效邮箱类型。

属性

名称

类型

可读

可写

说明

email

string

是

是

邮箱地址。

labelName

string

是

是

邮箱的类型名称。

displayName

string

是

是

邮箱的显示名称。

labelId

number

是

是

邮箱的类型。

对象创建示例：

使用JSON格式创建数据：

  1. let email = {
  2.     email: "xxx@email.com",
  3.     displayName: "displayName"
  4. }

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

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

Holder

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

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

名称

类型

可读

可写

说明

bundleName

string

是

否

包名。

displayName

string

是

否

应用名称。

holderId

number

是

是

应用id。

对象创建示例：

使用JSON格式创建数据：

  1. let holder = {
  2.   holderId: 0
  3. };

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

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

Event

联系人事件类。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义事件类型。

EVENT_ANNIVERSARY

1

周年纪念事件类型。

EVENT_OTHER

2

其它事件类型。

EVENT_BIRTHDAY

3

生日事件类型。

INVALID_LABEL_ID

-1

无效事件类型。

属性

名称

类型

可读

可写

说明

eventDate

string

是

是

事件的日期。

labelName

string

是

是

事件类型名称。

labelId

number

是

是

事件类型。

对象创建示例：

使用JSON格式创建数据：

  1. let event = {
  2.     eventDate: "xxxxxx"
  3. };

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

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

Group

联系人的群组类。

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

名称

类型

可读

可写

说明

groupId

number

是

是

联系人群组的id。

title

string

是

是

联系人群组的名称。

对象创建示例：

使用JSON格式创建数据：

  1. let group = {
  2.     groupId: 1,
  3.     title: "title"
  4. };

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

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

ImAddress

联系人的即时消息地址。

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

常量

名称

值

说明

CUSTOM_LABEL

-1

自定义即时消息类型。

IM_AIM

0

AIM即时消息类型。

IM_MSN

1

MSN即时消息类型。

IM_YAHOO

2

YAHOO即时消息类型。

IM_SKYPE

3

SKYPE即时消息类型。

IM_QQ

4

QQ即时消息类型。

IM_ICQ

6

ICQ即时消息类型。

IM_JABBER

7

JABBER即时消息类型。

INVALID_LABEL_ID

-2

无效的即时消息类型。

属性

名称

类型

可读

可写

说明

imAddress

string

是

是

即时消息地址。

labelName

string

是

是

即时消息类型名称。

labelId

number

是

是

即时消息类型。

对象创建示例：

使用JSON格式创建数据：

  1. let imAddress = {
  2.     imAddress: "imAddress",
  3.     labelName: "labelName"
  4. };

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

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

Name

联系人的名字类。

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

名称

类型

可读

可写

说明

familyName

string

是

是

联系人的家庭姓名。

familyNamePhonetic

string

是

是

联系人的家庭姓名拼音。

fullName

string

是

是

联系人的全名。

givenName

string

是

是

联系人的名称（firstName）。

givenNamePhonetic

string

是

是

联系人的名称拼音。

middleName

string

是

是

联系人的中间名。

middleNamePhonetic

string

是

是

联系人的中间名拼音。

namePrefix

string

是

是

联系人的姓名前缀。

nameSuffix

string

是

是

联系人的姓名后缀。

对象创建示例：

使用JSON格式创建数据：

  1. let name = {
  2.     familyName: "familyName",
  3.     fullName: "fullName"
  4. };

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

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

NickName

联系人的昵称类。

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

名称

类型

可读

可写

说明

nickName

string

是

是

联系人的昵称。

对象创建示例：

使用JSON格式创建数据：

  1. let nickName = {
  2.     nickName: "nickName"
  3. };

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

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

Note

联系人的备注类。

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

名称

类型

可读

可写

说明

noteContent

string

是

是

联系人的备注内容。

对象创建示例：

使用JSON格式创建数据：

  1. let note = {
  2.     noteContent: "noteContent"
  3. };

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

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

Organization

联系人的组织类。

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

名称

类型

可读

可写

说明

name

string

是

是

组织名称。

title

string

是

是

组织标题。

对象创建示例：

使用JSON格式创建数据：

  1. let organization = {
  2.     name: "name",
  3.     title: "title"
  4. };

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

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

PhoneNumber

联系人电话号码类。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义电话类型。

NUM_HOME

1

家庭电话类型。

NUM_MOBILE

2

移动电话类型。

NUM_WORK

3

工作电话类型。

NUM_FAX_WORK

4

工作传真电话类型。

NUM_FAX_HOME

5

家庭传真电话类型。

NUM_PAGER

6

寻呼机电话类型。

NUM_OTHER

7

其它电话类型。

NUM_CALLBACK

8

回呼电话类型。

NUM_CAR

9

车机电话类型。

NUM_COMPANY_MAIN

10

公司电话类型。

NUM_ISDN

11

综合业务数字网（ISDN）电话类型。

NUM_MAIN

12

主电话类型。

NUM_OTHER_FAX

13

其它传真类型。

NUM_RADIO

14

无线电话类型。

NUM_TELEX

15

电传电话类型。

NUM_TTY_TDD

16

电传打字机（TTY）或测试驱动开发（TDD）电话类型。

NUM_WORK_MOBILE

17

工作移动电话类型。

NUM_WORK_PAGER

18

工作寻呼机电话类型。

NUM_ASSISTANT

19

助理电话类型。

NUM_MMS

20

彩信电话类型。

INVALID_LABEL_ID

-1

无效电话类型。

属性

名称

类型

可读

可写

说明

labelName

string

是

是

电话号码类型名称。

phoneNumber

string

是

是

电话号码。

labelId

number

是

是

电话号码类型。

对象创建示例：

使用JSON格式创建数据：

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

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

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

Portrait

联系人的头像类。

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

名称

类型

可读

可写

说明

uri

string

是

是

联系人的头像。

对象创建示例：

使用JSON格式创建数据：

  1. let portrait = {
  2.     uri: "uri"
  3. };

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

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

PostalAddress

联系人的邮政地址类。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义邮政地址类型。

ADDR_HOME

1

家庭地址类型。

ADDR_WORK

2

工作地址类型。

ADDR_OTHER

3

其它地址类型。

INVALID_LABEL_ID

-1

无效地址类型。

属性

名称

类型

可读

可写

说明

city

string

是

是

联系人所在的城市。

country

string

是

是

联系人所在的国家。

labelName

string

是

是

邮政地址类型名称。

neighborhood

string

是

是

联系人的邻居。

pobox

string

是

是

联系人的邮箱。

postalAddress

string

是

是

联系人的邮政地址。

postcode

string

是

是

联系人所在区域的邮政编码。

region

string

是

是

联系人所在的区域。

street

string

是

是

联系人所在的街道。

labelId

number

是

是

邮政地址类型。

对象创建示例：

使用JSON格式创建数据：

  1. let postalAddress = {
  2.     city: "city"
  3. };

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

  1. let postalAddress = new contact.PostalAddress();
  2. postalAddress.city = "city";

Relation

联系人的关系类。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义关系类型。

RELATION_ASSISTANT

1

助手关系类型。

RELATION_BROTHER

2

兄弟关系类型。

RELATION_CHILD

3

子女关系类型。

RELATION_DOMESTIC_PARTNER

4

同居同伴关系类型。

RELATION_FATHER

5

父亲关系类型。

RELATION_FRIEND

6

朋友关系类型。

RELATION_MANAGER

7

管理者关系类型。

RELATION_MOTHER

8

母亲关系类型。

RELATION_PARENT

9

父母关系类型。

RELATION_PARTNER

10

合作伙伴关系类型。

RELATION_REFERRED_BY

11

推荐人关系类型。

RELATION_RELATIVE

12

亲属关系类型。

RELATION_SISTER

13

姐妹关系类型。

RELATION_SPOUSE

14

配偶关系类型。

INVALID_LABEL_ID

-1

无效的关系类型。

属性

名称

类型

可读

可写

说明

labelName

string

是

是

关系类型名称。

relationName

string

是

是

关系名称。

labelId

number

是

是

关系类型。

对象创建示例：

使用JSON格式创建数据：

  1. let relation = {
  2.     relationName: "relationName",
  3.     labelId: contact.Relation.RELATION_ASSISTANT
  4. };

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

  1. let relation = new contact.Relation();
  2. relation.relationName = "relationName";
  3. relation.labelId = contact.Relation.RELATION_ASSISTANT;

SipAddress

联系人的会话发起协议（SIP）地址类。

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

常量

名称

值

说明

CUSTOM_LABEL

0

自定义会话发起协议（SIP）地址类型。

SIP_HOME

1

家庭会话发起协议（SIP）地址类型。

SIP_WORK

2

工作会话发起协议（SIP）地址类型。

SIP_OTHER

3

其它会话发起协议（SIP）地址类型。

INVALID_LABEL_ID

-1

无效会话发起协议（SIP）地址类型。

属性

名称

类型

可读

可写

说明

labelName

string

是

是

会话发起协议（SIP）地址类型名称。

sipAddress

string

是

是

会话发起协议（SIP）地址。

labelId

number

是

是

会话发起协议（SIP）地址类型。

对象创建示例：

使用JSON格式创建数据：

  1. var sipAddress = {
  2.     sipAddress: "sipAddress"
  3. };

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

  1. let sipAddress = new contact.SipAddress();
  2. sipAddress.sipAddress = "sipAddress";

Website

联系人的网站信息类。

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

名称

类型

可读

可写

说明

website

string

是

是

联系人的网站信息。

对象创建示例：

使用JSON格式创建数据：

  1. let website = {
  2.     website: "website"
  3. };

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

  1. let website = new contact.Website();
  2. website.website = "website"
应用空间统计
拨打电话
温馨提示
下载编程狮App，免费阅读超1000+编程语言教程
取消
确定
目录

通用事件

通用属性

手势处理

基础组件

容器组件

媒体组件

绘制组件

画布组件

动画

弹窗

生命周期

状态管理

像素

枚举

类型

接口

错误码合集

关闭

 MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }