聯(lián)系人

2024-01-23 16:34 更新

本模塊提供聯(lián)系人管理能力，包括添加聯(lián)系人、刪除聯(lián)系人、更新聯(lián)系人等

說明

本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

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

contact.addContact

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

添加聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

contact

Contact

是

聯(lián)系人信息。

callback

AsyncCallback<number>

是

回調(diào)函數(shù)，返回添加的聯(lián)系人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>

添加聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

contact

Contact

是

聯(lián)系人信息。

返回值：

類型

說明

Promise<number>

以Promise形式返回結(jié)果，返回添加的聯(lián)系人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

刪除聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

callback

AsyncCallback<void>

是

異步刪除聯(lián)系人之后的回調(diào)。

示例：

  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>

刪除聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

返回值：

類型

說明

Promise<void>

返回一個(gè)Promise對(duì)象。

示例：

  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

更新聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

contact

Contact

是

聯(lián)系人信息。

callback

AsyncCallback<void>

是

異步更新聯(lián)系人之后的回調(diào)。

示例：

  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

更新聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

contact

Contact

是

聯(lián)系人信息。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<void>

是

異步更新聯(lián)系人之后的回調(diào)。

示例：

  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>

更新聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.WRITE_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

contact

Contact

是

聯(lián)系人信息。

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<void>

返回一個(gè)Promise對(duì)象。

示例：

  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

判斷當(dāng)前聯(lián)系人id是否在電話簿中，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)id。

callback

AsyncCallback<boolean>

是

回調(diào)函數(shù)，返回布爾值。true代表聯(lián)系人id在本地電話簿中，false則代表聯(lián)系人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>

判斷當(dāng)前聯(lián)系人id是否在電話簿中，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)id。

返回值：

類型

說明

Promise<boolean>

以Promise形式返回結(jié)果，返回布爾值。true代表聯(lián)系人id在本地電話簿中，false則代表聯(lián)系人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模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性。

callback

AsyncCallback<boolean>

是

回調(diào)函數(shù)，返回是否為“我的名片”的布爾值。true代表此聯(lián)系人是“我的名片”，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模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性。

返回值：

類型

說明

Promise<boolean>

以Promise形式返回結(jié)果，返回是否為“我的名片”的布爾值。true代表此聯(lián)系人是“我的名片”，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模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回“我的名片”信息。

示例：

  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模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回“我的名片”信息。

示例：

  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模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<Contact>

以Promise形式返回結(jié)果，返回“我的名片”信息。

示例：

  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

調(diào)用選擇聯(lián)系人接口，打開選擇聯(lián)系人UI界面，選定的聯(lián)系人使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

系統(tǒng)能力：SystemCapability.Applications.Contacts

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回選擇的聯(lián)系人對(duì)象數(shù)組。

示例：

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

調(diào)用選擇聯(lián)系人接口，打開選擇聯(lián)系人UI界面，選定的聯(lián)系人使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

系統(tǒng)能力：SystemCapability.Applications.Contacts

返回值：

類型

說明

Promise<Array<Contact>>

以Promise形式返回結(jié)果，返回選擇的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)key查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回查詢的聯(lián)系人對(duì)象。

示例：

  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

根據(jù)key查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回查詢的聯(lián)系人對(duì)象。

示例：

  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

根據(jù)key查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回查詢的聯(lián)系人對(duì)象。

示例：

  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

根據(jù)key查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Contact>

是

回調(diào)函數(shù)，返回查詢的聯(lián)系人對(duì)象。

示例：

  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>

根據(jù)key查詢聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

key

string

是

聯(lián)系人的key值，一個(gè)聯(lián)系人對(duì)應(yīng)一個(gè)key。

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<Contact>

以Promise形式返回結(jié)果，返回查詢到的聯(lián)系人對(duì)象。

示例：

  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

查詢所有聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

查詢所有聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

查詢所有聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

查詢所有聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

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

查詢所有聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<Array<Contact>>

以Promise形式返回結(jié)果，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)電話號(hào)碼查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

phoneNumber

string

是

聯(lián)系人的電話號(hào)碼。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)電話號(hào)碼查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

phoneNumber

string

是

聯(lián)系人的電話號(hào)碼。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)電話號(hào)碼查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

phoneNumber

string

是

聯(lián)系人的電話號(hào)碼。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)電話號(hào)碼查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

phoneNumber

string

是

聯(lián)系人的電話號(hào)碼。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

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

根據(jù)電話號(hào)碼查詢聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

phoneNumber

string

是

聯(lián)系人的電話號(hào)碼。

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<Array<Contact>>

以Promise形式返回結(jié)果，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)email查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

email

string

是

聯(lián)系人的郵箱地址。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)email查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

email

string

是

聯(lián)系人的郵箱地址。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)email查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

email

string

是

聯(lián)系人的郵箱地址。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到聯(lián)系人對(duì)象數(shù)組。

示例：

  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

根據(jù)email查詢聯(lián)系人，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

email

string

是

聯(lián)系人的郵箱地址。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

是

聯(lián)系人的屬性列表。

callback

AsyncCallback<Array<Contact>>

是

回調(diào)函數(shù)，返回查詢到聯(lián)系人對(duì)象數(shù)組。

示例：

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

根據(jù)email查詢聯(lián)系人，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

email

string

是

聯(lián)系人的郵箱地址。

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

attrs

ContactAttributes

否

聯(lián)系人的屬性列表。

返回值：

類型

說明

Promise<Array<Contact>>

以Promise形式返回結(jié)果，返回查詢到的聯(lián)系人對(duì)象數(shù)組。

示例：

  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

查詢聯(lián)系人的所有群組，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<Group>>

是

回調(diào)函數(shù)，返回查詢到的群組對(duì)象數(shù)組。

示例：

  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

查詢聯(lián)系人的所有群組，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<Array<Group>>

是

回調(diào)函數(shù)，返回查詢到的群組對(duì)象數(shù)組。

示例：

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

查詢聯(lián)系人的所有群組，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

返回值：

類型

說明

Promise<Array<Group>>

以Promise形式返回結(jié)果，返回查詢到的群組對(duì)象數(shù)組。

示例：

  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

查詢所有創(chuàng)建聯(lián)系人的應(yīng)用信息，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

callback

AsyncCallback<Array<Holder>>

是

回調(diào)函數(shù)，返回查詢到的創(chuàng)建聯(lián)系人應(yīng)用信息的對(duì)象數(shù)組。

示例：

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

查詢所有創(chuàng)建聯(lián)系人的應(yīng)用信息，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

返回值：

類型

說明

Promise<Array<Holder>>

以Promise形式返回結(jié)果，返回查詢到的創(chuàng)建聯(lián)系人應(yīng)用信息的對(duì)象數(shù)組。

示例：

  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

根據(jù)聯(lián)系人的id查詢聯(lián)系人的key，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性。

callback

AsyncCallback<string>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)應(yīng)的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

根據(jù)聯(lián)系人的id查詢聯(lián)系人的key，使用callback方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性。

holder

Holder

是

創(chuàng)建聯(lián)系人的應(yīng)用信息。

callback

AsyncCallback<string>

是

回調(diào)函數(shù)，返回查詢到的聯(lián)系人對(duì)應(yīng)的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>

根據(jù)聯(lián)系人的id查詢聯(lián)系人的key，使用Promise方式作為異步方法。

該接口僅支持在FA模型中調(diào)用。

需要權(quán)限：ohos.permission.READ_CONTACTS

系統(tǒng)能力：SystemCapability.Applications.ContactsData

參數(shù)：

參數(shù)名

類型

必填

說明

id

number

是

聯(lián)系人對(duì)象的id屬性。

holder

Holder

否

創(chuàng)建聯(lián)系人的應(yīng)用信息。

返回值：

類型

說明

Promise<string>

以Promise形式返回結(jié)果，返回查詢到的聯(lián)系人對(duì)應(yīng)的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

聯(lián)系人對(duì)象類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

INVALID_CONTACT_ID

-1

默認(rèn)聯(lián)系人的id。

屬性

名稱

類型

可讀

可寫

說明

id

number

是

否

聯(lián)系人的id。

key

string

是

否

聯(lián)系人的key。

contactAttributes

ContactAttributes

是

是

聯(lián)系人的屬性列表。

emails

Email[]

是

是

聯(lián)系人的郵箱地址列表。

events

Event[]

是

是

聯(lián)系人的生日、周年紀(jì)念等重要日期列表。

groups

Group[]

是

是

聯(lián)系人的群組列表。

imAddresses

ImAddress[]

是

是

聯(lián)系人的即時(shí)消息地址列表。

phoneNumbers

PhoneNumber[]

是

是

聯(lián)系人的電話號(hào)碼列表。

portrait

Portrait

是

是

聯(lián)系人的頭像。

postalAddresses

PostalAddress[]

是

是

聯(lián)系人的郵政地址列表。

relations

Relation[]

是

是

聯(lián)系人的關(guān)系列表。

sipAddresses

SipAddress[]

是

是

聯(lián)系人的會(huì)話發(fā)起協(xié)議（SIP）地址列表。

websites

Website[]

是

是

聯(lián)系人的網(wǎng)站列表。

name

Name

是

是

聯(lián)系人的姓名。

nickName

NickName

是

是

聯(lián)系人的昵稱。

note

Note

是

是

聯(lián)系人的備注。

organization

Organization

是

是

聯(lián)系人的組織信息。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建聯(lián)系人數(shù)據(jù)：

  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一個(gè)Contact對(duì)象的方式創(chuàng)建數(shù)據(jù)：

  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

聯(lián)系人屬性列表，一般作為入?yún)⒂脕順?biāo)識(shí)希望查詢的聯(lián)系人屬性。

當(dāng)傳入為null時(shí)，默認(rèn)查詢?nèi)繉傩浴?/p>

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

attributes

Attribute[]

是

是

聯(lián)系人屬性列表。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)ContactAttributes對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Attribute

枚舉，聯(lián)系人屬性列表。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

說明

ATTR_CONTACT_EVENT

聯(lián)系人的生日、周年紀(jì)念等重要日期。

ATTR_EMAIL

聯(lián)系人的郵箱地址。

ATTR_GROUP_MEMBERSHIP

聯(lián)系人的群組。

ATTR_IM

聯(lián)系人的即時(shí)消息地址。

ATTR_NAME

聯(lián)系人的姓名。

ATTR_NICKNAME

聯(lián)系人的昵稱。

ATTR_NOTE

聯(lián)系人的備注。

ATTR_ORGANIZATION

聯(lián)系人的組織信息。

ATTR_PHONE

聯(lián)系人的電話號(hào)碼。

ATTR_PORTRAIT

聯(lián)系人的頭像。

ATTR_POSTAL_ADDRESS

聯(lián)系人的郵政地址。

ATTR_RELATION

聯(lián)系人的關(guān)系。

ATTR_SIP_ADDRESS

聯(lián)系人的會(huì)話發(fā)起協(xié)議（SIP）地址。

ATTR_WEBSITE

聯(lián)系人的網(wǎng)站。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

Email

聯(lián)系人的郵箱。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為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

是

是

郵箱的類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Email對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Holder

創(chuàng)建聯(lián)系人的應(yīng)用信息類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

bundleName

string

是

否

包名。

displayName

string

是

否

應(yīng)用名稱。

holderId

number

是

是

應(yīng)用id。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Holder對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Event

聯(lián)系人事件類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

0

自定義事件類型。

EVENT_ANNIVERSARY

1

周年紀(jì)念事件類型。

EVENT_OTHER

2

其它事件類型。

EVENT_BIRTHDAY

3

生日事件類型。

INVALID_LABEL_ID

-1

無效事件類型。

屬性

名稱

類型

可讀

可寫

說明

eventDate

string

是

是

事件的日期。

labelName

string

是

是

事件類型名稱。

labelId

number

是

是

事件類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Event對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Group

聯(lián)系人的群組類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

groupId

number

是

是

聯(lián)系人群組的id。

title

string

是

是

聯(lián)系人群組的名稱。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Group對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

ImAddress

聯(lián)系人的即時(shí)消息地址。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

-1

自定義即時(shí)消息類型。

IM_AIM

0

AIM即時(shí)消息類型。

IM_MSN

1

MSN即時(shí)消息類型。

IM_YAHOO

2

YAHOO即時(shí)消息類型。

IM_SKYPE

3

SKYPE即時(shí)消息類型。

IM_QQ

4

QQ即時(shí)消息類型。

IM_ICQ

6

ICQ即時(shí)消息類型。

IM_JABBER

7

JABBER即時(shí)消息類型。

INVALID_LABEL_ID

-2

無效的即時(shí)消息類型。

屬性

名稱

類型

可讀

可寫

說明

imAddress

string

是

是

即時(shí)消息地址。

labelName

string

是

是

即時(shí)消息類型名稱。

labelId

number

是

是

即時(shí)消息類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)ImAddress對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Name

聯(lián)系人的名字類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

familyName

string

是

是

聯(lián)系人的家庭姓名。

familyNamePhonetic

string

是

是

聯(lián)系人的家庭姓名拼音。

fullName

string

是

是

聯(lián)系人的全名。

givenName

string

是

是

聯(lián)系人的名稱（firstName）。

givenNamePhonetic

string

是

是

聯(lián)系人的名稱拼音。

middleName

string

是

是

聯(lián)系人的中間名。

middleNamePhonetic

string

是

是

聯(lián)系人的中間名拼音。

namePrefix

string

是

是

聯(lián)系人的姓名前綴。

nameSuffix

string

是

是

聯(lián)系人的姓名后綴。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)name對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

NickName

聯(lián)系人的昵稱類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

nickName

string

是

是

聯(lián)系人的昵稱。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)NickName對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Note

聯(lián)系人的備注類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

noteContent

string

是

是

聯(lián)系人的備注內(nèi)容。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Note對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Organization

聯(lián)系人的組織類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

name

string

是

是

組織名稱。

title

string

是

是

組織標(biāo)題。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Organization對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

PhoneNumber

聯(lián)系人電話號(hào)碼類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

0

自定義電話類型。

NUM_HOME

1

家庭電話類型。

NUM_MOBILE

2

移動(dòng)電話類型。

NUM_WORK

3

工作電話類型。

NUM_FAX_WORK

4

工作傳真電話類型。

NUM_FAX_HOME

5

家庭傳真電話類型。

NUM_PAGER

6

尋呼機(jī)電話類型。

NUM_OTHER

7

其它電話類型。

NUM_CALLBACK

8

回呼電話類型。

NUM_CAR

9

車機(jī)電話類型。

NUM_COMPANY_MAIN

10

公司電話類型。

NUM_ISDN

11

綜合業(yè)務(wù)數(shù)字網(wǎng)（ISDN）電話類型。

NUM_MAIN

12

主電話類型。

NUM_OTHER_FAX

13

其它傳真類型。

NUM_RADIO

14

無線電話類型。

NUM_TELEX

15

電傳電話類型。

NUM_TTY_TDD

16

電傳打字機(jī)（TTY）或測試驅(qū)動(dòng)開發(fā)（TDD）電話類型。

NUM_WORK_MOBILE

17

工作移動(dòng)電話類型。

NUM_WORK_PAGER

18

工作尋呼機(jī)電話類型。

NUM_ASSISTANT

19

助理電話類型。

NUM_MMS

20

彩信電話類型。

INVALID_LABEL_ID

-1

無效電話類型。

屬性

名稱

類型

可讀

可寫

說明

labelName

string

是

是

電話號(hào)碼類型名稱。

phoneNumber

string

是

是

電話號(hào)碼。

labelId

number

是

是

電話號(hào)碼類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)PhoneNumber對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Portrait

聯(lián)系人的頭像類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

uri

string

是

是

聯(lián)系人的頭像。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Portrait對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

PostalAddress

聯(lián)系人的郵政地址類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

0

自定義郵政地址類型。

ADDR_HOME

1

家庭地址類型。

ADDR_WORK

2

工作地址類型。

ADDR_OTHER

3

其它地址類型。

INVALID_LABEL_ID

-1

無效地址類型。

屬性

名稱

類型

可讀

可寫

說明

city

string

是

是

聯(lián)系人所在的城市。

country

string

是

是

聯(lián)系人所在的國家。

labelName

string

是

是

郵政地址類型名稱。

neighborhood

string

是

是

聯(lián)系人的鄰居。

pobox

string

是

是

聯(lián)系人的郵箱。

postalAddress

string

是

是

聯(lián)系人的郵政地址。

postcode

string

是

是

聯(lián)系人所在區(qū)域的郵政編碼。

region

string

是

是

聯(lián)系人所在的區(qū)域。

street

string

是

是

聯(lián)系人所在的街道。

labelId

number

是

是

郵政地址類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)PostalAddress對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Relation

聯(lián)系人的關(guān)系類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

0

自定義關(guān)系類型。

RELATION_ASSISTANT

1

助手關(guān)系類型。

RELATION_BROTHER

2

兄弟關(guān)系類型。

RELATION_CHILD

3

子女關(guān)系類型。

RELATION_DOMESTIC_PARTNER

4

同居同伴關(guān)系類型。

RELATION_FATHER

5

父親關(guān)系類型。

RELATION_FRIEND

6

朋友關(guān)系類型。

RELATION_MANAGER

7

管理者關(guān)系類型。

RELATION_MOTHER

8

母親關(guān)系類型。

RELATION_PARENT

9

父母關(guān)系類型。

RELATION_PARTNER

10

合作伙伴關(guān)系類型。

RELATION_REFERRED_BY

11

推薦人關(guān)系類型。

RELATION_RELATIVE

12

親屬關(guān)系類型。

RELATION_SISTER

13

姐妹關(guān)系類型。

RELATION_SPOUSE

14

配偶關(guān)系類型。

INVALID_LABEL_ID

-1

無效的關(guān)系類型。

屬性

名稱

類型

可讀

可寫

說明

labelName

string

是

是

關(guān)系類型名稱。

relationName

string

是

是

關(guān)系名稱。

labelId

number

是

是

關(guān)系類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Relation對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

SipAddress

聯(lián)系人的會(huì)話發(fā)起協(xié)議（SIP）地址類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

常量

名稱

值

說明

CUSTOM_LABEL

0

自定義會(huì)話發(fā)起協(xié)議（SIP）地址類型。

SIP_HOME

1

家庭會(huì)話發(fā)起協(xié)議（SIP）地址類型。

SIP_WORK

2

工作會(huì)話發(fā)起協(xié)議（SIP）地址類型。

SIP_OTHER

3

其它會(huì)話發(fā)起協(xié)議（SIP）地址類型。

INVALID_LABEL_ID

-1

無效會(huì)話發(fā)起協(xié)議（SIP）地址類型。

屬性

名稱

類型

可讀

可寫

說明

labelName

string

是

是

會(huì)話發(fā)起協(xié)議（SIP）地址類型名稱。

sipAddress

string

是

是

會(huì)話發(fā)起協(xié)議（SIP）地址。

labelId

number

是

是

會(huì)話發(fā)起協(xié)議（SIP）地址類型。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)SipAddress對(duì)象的方式創(chuàng)建數(shù)據(jù)：

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

Website

聯(lián)系人的網(wǎng)站信息類。

系統(tǒng)能力：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Applications.ContactsData。

名稱

類型

可讀

可寫

說明

website

string

是

是

聯(lián)系人的網(wǎng)站信息。

對(duì)象創(chuàng)建示例：

使用JSON格式創(chuàng)建數(shù)據(jù)：

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

或使用new一個(gè)Website對(duì)象的方式創(chuàng)建數(shù)據(jù)：

  1. let website = new contact.Website();
  2. website.website = "website"
以上內(nèi)容是否對(duì)您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)