聯系人

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 7開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import contact from '@ohos.contact';

contact.addContact

addContact(contact:Contact, callback:AsyncCallback): void

添加聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.addContact

addContact(contact: Contact): Promise

添加聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.deleteContact

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

刪除聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.deleteContact

deleteContact(key: string): Promise

刪除聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.updateContact

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

更新聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

contact.updateContact({
    name: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, (err) = > {
    if (err) {
        console.log('updateContact callback: err- >${JSON.stringify(err)}');
        return;
    }
    console.log('updateContact success');
});

contact.updateContact

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

更新聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

contact.updateContact({
    fullName: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
},{
    attributes:['ATTR_EMAIL', 'ATTR_NAME']
}, (err) = > {
    if (err) {
        console.log('updateContact callback: err- >${JSON.stringify(err)}');
        return;
    }
    console.log('updateContact success');
});

contact.updateContact

updateContact(contact: Contact, attrs?: ContactAttributes): Promise

更新聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.WRITE_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

let promise = contact.updateContact({
    fullName: {fullName: 'xxx'},
    phoneNumbers: [{phoneNumber: '138xxxxxxxx'}]
}, {
    attributes: ["ATTR_EMAIL", "ATTR_NAME"]
});
promise.then(() = > {
    console.log('updateContact success');
}).catch((err) = > {
    console.error(`updateContact fail: err- >${JSON.stringify(err)}`);
});

contact.isLocalContact

isLocalContact(id: number, callback: AsyncCallback): void

判斷當前聯系人id是否在電話簿中，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.isLocalContact

isLocalContact(id: number): Promise

判斷當前聯系人id是否在電話簿中，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.isMyCard

isMyCard(id: number, callback: AsyncCallback): void

判斷是否為“我的名片”，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.isMyCard

isMyCard(id: number): Promise

判斷是否為“我的名片”，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.queryMyCard

queryMyCard(callback: AsyncCallback): void

查詢“我的名片”，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryMyCard

queryMyCard(attrs: ContactAttributes, callback: AsyncCallback): void

查詢“我的名片”，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryMyCard

queryMyCard(attrs?: ContactAttributes): Promise

查詢“我的名片”，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

let promise = contact.queryMyCard({
    attributes:['ATTR_EMAIL', 'ATTR_NAME']
});
promise.then((data) = > {
    console.log(`queryMyCard success: data- >${JSON.stringify(data)}`);
}).catch((err) = > {
    console.error(`queryMyCard fail: err- >${JSON.stringify(err)}`);
});

contact.selectContact

selectContact(callback: AsyncCallback>): void

選擇聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.selectContact

selectContact(): Promise>

選擇聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData

返回值：

示例：

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

contact.queryContact

queryContact(key: string, callback: AsyncCallback): void

根據key查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContact

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

根據key查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

contact.queryContact('xxx', {
    holderId: 0
}, (err, data) = > {
    if (err) {
        console.log(`queryContact callback: err- >${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContact callback: success data- >${JSON.stringify(data)}`);
});

contact.queryContact

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

根據key查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContact

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

根據key查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContact

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

根據key查詢聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.queryContacts

queryContacts(callback: AsyncCallback>): void

查詢所有聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContacts

queryContacts(holder: Holder, callback: AsyncCallback>): void

查詢所有聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContacts

queryContacts(attrs: ContactAttributes, callback: AsyncCallback>): void

查詢所有聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContacts

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

查詢所有聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContacts

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

查詢所有聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

ontact.queryContactsByPhoneNumber

queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback>): void

根據電話號碼查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByPhoneNumber

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

根據電話號碼查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByPhoneNumber

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

根據電話號碼查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByPhoneNumber

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

根據電話號碼查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

contact.queryContactsByPhoneNumber('138xxxxxxxx', {
    holderId: 0
}, {
    attributes: ["ATTR_EMAIL", "ATTR_NAME"]
}, (err, data) = > {
    if (err) {
        console.log(`queryContactsByPhoneNumber callback: err- >${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryContactsByPhoneNumber callback: success data- >${JSON.stringify(data)}`);
});

contact.queryContactsByPhoneNumber

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

根據電話號碼查詢聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.queryContactsByEmail

queryContactsByEmail(email: string, callback: AsyncCallback>): void

根據email查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByEmail

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

根據email查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByEmail

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

根據email查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByEmail

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

根據email查詢聯系人，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryContactsByEmail

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

根據email查詢聯系人，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.queryGroups

queryGroups(callback: AsyncCallback>): void

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

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryGroups

queryGroups(holder: Holder, callback: AsyncCallback>): void

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

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryGroups

queryGroups(holder?: Holder): Promise>

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

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

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

contact.queryHolders

queryHolders(callback: AsyncCallback>): void

查詢所有創建聯系人的應用信息，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryHolders

queryHolders(): Promise>

查詢所有創建聯系人的應用信息，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

返回值：

示例：

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

contact.queryKey

queryKey(id: number, callback: AsyncCallback): void

根據聯系人的id查詢聯系人的key，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

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

contact.queryKey

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

根據聯系人的id查詢聯系人的key，使用callback方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

示例：

contact.queryKey(id, {
    holderId:1
}, (err, data) = > {
    if (err) {
        console.log(`queryKey callback: err- >${JSON.stringify(err)}`);
        return;
    }
    console.log(`queryKey callback: success data- >${JSON.stringify(data)}`);
});

contact.queryKey

queryKey(id: number, holder?: Holder): Promise

根據聯系人的id查詢聯系人的key，使用Promise方式作為異步方法。

需要權限 ：ohos.permission.READ_CONTACTS

系統能力 ：SystemCapability.Applications.ContactsData

參數：

返回值：

示例：

let promise = contact.queryKey(id, {
    holderId: 0
});
promise.then((data) = > {
    console.log(`queryKey success: data- >${JSON.stringify(data)}`);
}).catch((err) = > {
    console.error(`queryKey fail: err- >${JSON.stringify(err)}`);
});

Contact

聯系人對象類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建聯系人數據：

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

或使用new一個Contact對象的方式創建數據：

let myContact = new contact.Contact();
let name = new contact.Name();
name.fullName = "fullName";
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
myContact.name = name;
myContact.phoneNumbers = [phoneNumber];

ContactAttributes

聯系人屬性列表，一般作為入參用來標識希望查詢的聯系人屬性。 當傳入為null時，默認查詢全部屬性。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

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

或使用new一個ContactAttributes對象的方式創建數據：

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

Attribute

枚舉，聯系人屬性列表。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

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

Email

聯系人的郵箱。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

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

或使用new一個Email對象的方式創建數據：

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

Holder

創建聯系人的應用信息類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let holder = {
  holderId: 0
};

或使用new一個Holder對象的方式創建數據：

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

Event

聯系人事件類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

let event = {
    eventDate: "xxxxxx"
};

或使用new一個Event對象的方式創建數據：

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

Group

聯系人的群組類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

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

或使用new一個Group對象的方式創建數據：

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

ImAddress

聯系人的即時消息地址。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

let imAddress = {
    imAddress: "imAddress",
    labelName: "labelName"
};

或使用new一個ImAddress對象的方式創建數據：

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

Name

聯系人的名字類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let name = {
    familyName: "familyName",
    fullName: "fullName"
};

或使用new一個name對象的方式創建數據：

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

NickName

聯系人的昵稱類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let nickName = {
    nickName: "nickName"
};

或使用new一個NickName對象的方式創建數據：

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

Note

聯系人的備注類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let note = {
    noteContent: "noteContent"
};

或使用new一個Note對象的方式創建數據：

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

Organization

聯系人的組織類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let organization = {
    name: "name",
    title: "title"
};

或使用new一個Organization對象的方式創建數據：

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

PhoneNumber

聯系人電話號碼類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

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

或使用new一個PhoneNumber對象的方式創建數據：

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

Portrait

聯系人的頭像類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let portrait = {
    uri: "uri"
};

或使用new一個Portrait對象的方式創建數據：

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

PostalAddress

聯系人的郵政地址類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

let postalAddress = {
    city: "city"
};

或使用new一個PostalAddress對象的方式創建數據：

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

Relation

聯系人的關系類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

let relation = {
    relationName: "relationName",
    labelId: contact.Relation.RELATION_ASSISTANT
};

或使用new一個Relation對象的方式創建數據：

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

SipAddress

聯系人的會話發起協議（SIP）地址類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

常量

屬性

對象創建示例：

使用JSON格式創建數據：

var sipAddress = {
    sipAddress: "sipAddress"
};

或使用new一個SipAddress對象的方式創建數據：

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

Website

聯系人的網站信息類。

系統能力 ：以下各項對應的系統能力均為SystemCapability.Applications.ContactsData。

對象創建示例：

使用JSON格式創建數據：

let website = {
    website: "website"
};

或使用new一個Website對象的方式創建數據：

let website = new contact.Website();
website.website = "website";

審核編輯 黃宇