首页 > 其他分享 >鸿蒙开发电话服务:【@ohos.contact (联系人)】

鸿蒙开发电话服务:【@ohos.contact (联系人)】

时间:2024-06-14 22:33:28浏览次数:7  
标签:鸿蒙 err 联系人 callback JSON contact ohos data

联系人

说明:

本模块首批接口从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[Contact]联系人信息。
callbackAsyncCallback回调函数,返回添加的联系人id。

示例:

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

参数:

参数名类型必填说明
contact[Contact]联系人信息。

返回值:

类型说明
Promise以Promise形式返回结果,返回添加的联系人id。

示例:

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

参数:

参数名类型必填说明
keystring联系人key值,一个联系人对应一个key。
callbackAsyncCallback回调函数,返回删除联系人的结果。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。

返回值:

类型说明
Promise以Promise形式返回结果,返回删除联系人的结果。

示例:

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[Contact]联系人信息。
callbackAsyncCallback回调函数,返回更新联系人的更新结果。

示例:

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[Contact]联系人信息。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback回调函数,返回更新联系人的更新结果。

示例:

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

参数:

参数名类型必填说明
contact[Contact]联系人信息。
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise以Promise形式返回结果,返回更新联系人的更新结果。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性,一个联系人对应一个id。
callbackAsyncCallback回调函数,返回布尔值。true代表联系人id在本地电话簿中,false则代表联系人id不在本地电话簿中。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性,一个联系人对应一个id。

返回值:

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

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性。
callbackAsyncCallback回调函数,返回是否为“我的名片”的布尔值。true代表此联系人是“我的名片”,false则代表不是。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性。

返回值:

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

示例:

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

参数:

参数名类型必填说明
callbackAsyncCallback<[Contact]>回调函数,返回“我的名片”信息。

示例:

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

参数:

参数名类型必填说明
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<[Contact]>回调函数,返回“我的名片”信息。

示例:

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

参数:

参数名类型必填说明
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise<[Contact]>以Promise形式返回结果,返回“我的名片”信息。

示例:

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<Array>): void

选择联系人,使用callback方式作为异步方法。

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[Contact]>>回调函数,返回选择的联系人对象数组。

示例:

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

选择联系人,使用Promise方式作为异步方法。

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData

返回值:

类型说明
Promise<Array<[Contact]>>以Promise形式返回结果,返回选择的联系人对象数组。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。
callbackAsyncCallback<[Contact]>回调函数,返回查询的联系人对象。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。
holder[Holder]创建联系人的应用信息。
callbackAsyncCallback<[Contact]>回调函数,返回查询的联系人对象。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<[Contact]>回调函数,返回查询的联系人对象。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<[Contact]>回调函数,返回查询的联系人对象。

示例:

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

参数:

参数名类型必填说明
keystring联系人的key值,一个联系人对应一个key。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise<[Contact]>以Promise形式返回结果,返回查询到的联系人对象。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
holder[Holder]创建联系人的应用信息。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise<Array<[Contact]>>以Promise形式返回结果,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
phoneNumberstring联系人的电话号码。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
phoneNumberstring联系人的电话号码。
holder[Holder]创建联系人的应用信息。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
phoneNumberstring联系人的电话号码。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
phoneNumberstring联系人的电话号码。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

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

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
phoneNumberstring联系人的电话号码。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise<Array<[Contact]>>以Promise形式返回结果,返回查询到的联系人对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
emailstring联系人的邮箱地址。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

contact.queryContactsByEmail('[email protected]', (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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
emailstring联系人的邮箱地址。
holder[Holder]创建联系人的应用信息。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到的联系人对象数组。

示例:

contact.queryContactsByEmail('[email protected]', {
    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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
emailstring联系人的邮箱地址。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到联系人对象数组。

示例:

contact.queryContactsByEmail('[email protected]', {
    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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
emailstring联系人的邮箱地址。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。
callbackAsyncCallback<Array<[Contact]>>回调函数,返回查询到联系人对象数组。

示例:

contact.queryContactsByEmail('[email protected]', {
    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<Array>

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
emailstring联系人的邮箱地址。
holder[Holder]创建联系人的应用信息。
attrs[ContactAttributes]联系人的属性列表。

返回值:

类型说明
Promise<Array<[Contact]>>以Promise形式返回结果,返回查询到的联系人对象数组。

示例:

let promise = contact.queryContactsByEmail('[email protected]', {
    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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[Group]>>回调函数,返回查询到的群组对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
holderHolder创建联系人的应用信息。
callbackAsyncCallback<Array<[Group]>>回调函数,返回查询到的群组对象数组。

示例:

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

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
holder[Holder]创建联系人的应用信息。

返回值:

类型说明
Promise<Array<[Group]>>以Promise形式返回结果,返回查询到的群组对象数组。

示例:

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<Array>): void

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

参数:

参数名类型必填说明
callbackAsyncCallback<Array<[Holder]>>回调函数,返回查询到的创建联系人应用信息的对象数组。

示例:

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

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

需要权限:ohos.permission.READ_CONTACTS

系统能力:SystemCapability.Applications.ContactsData

返回值:

类型说明
Promise<Array<[Holder]>>以Promise形式返回结果,返回查询到的创建联系人应用信息的对象数组。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性。
callbackAsyncCallback回调函数,返回查询到的联系人对应的key。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性。
holder[Holder]创建联系人的应用信息。
callbackAsyncCallback回调函数,返回查询到的联系人对应的key。

示例:

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

参数:

参数名类型必填说明
idnumber联系人对象的id属性。
holder[Holder]创建联系人的应用信息。

返回值:

类型说明
Promise以Promise形式返回结果,返回查询到的联系人对应的key。

示例:

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。

常量

名称说明
INVALID_CONTACT_ID-1默认联系人的id。

属性

名称参数类型可读可写说明
idnumber联系人的id。
keystring联系人的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格式创建联系人数据:

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。

名称参数类型可读可写说明
attributes[Attribute][]联系人属性列表。

对象创建示例:

使用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。

名称说明
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格式创建数据:

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

Email

联系人的邮箱。

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

常量

名称说明
CUSTOM_LABEL0自定义邮箱类型。
EMAIL_HOME1家庭邮箱类型。
EMAIL_WORK2工作邮箱类型。
EMAIL_OTHER3其它邮箱类型。
INVALID_LABEL_ID-1无效邮箱类型。

属性

名称参数类型可读可写说明
emailstring邮箱地址。
labelNamestring邮箱的类型名称。
displayNamestring邮箱的显示名称。
labelIdnumber邮箱的类型。

对象创建示例:

使用JSON格式创建数据:

let email = {
    email: "[email protected]",
    displayName: "displayName"
}

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

let email = new contact.Email();
email.email = "[email protected]";

Holder

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

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

名称参数类型可读可写说明
bundleNamestring包名。
displayNamestring应用名称。
holderIdnumber应用id。

对象创建示例:

使用JSON格式创建数据:

let holder = {
  holderId: 0
};

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

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

Event

联系人事件类。

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

常量

名称说明
CUSTOM_LABEL0自定义事件类型。
EVENT_ANNIVERSARY1周年纪念事件类型。
EVENT_OTHER2其它事件类型。
EVENT_BIRTHDAY3生日事件类型。
INVALID_LABEL_ID-1无效事件类型。

属性

名称参数类型可读可写说明
eventDatestring事件的日期。
labelNamestring事件类型名称。
labelIdnumber事件类型。

对象创建示例:

使用JSON格式创建数据:

let event = {
    eventDate: "xxxxxx"
};

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

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

Group

联系人的群组类。

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

名称参数类型可读可写说明
groupIdnumber联系人群组的id。
titlestring联系人群组的名称。

对象创建示例:

使用JSON格式创建数据:

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

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

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

ImAddress

联系人的即时消息地址。

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

常量

名称说明
CUSTOM_LABEL-1自定义即时消息类型。
IM_AIM0AIM即时消息类型。
IM_MSN1MSN即时消息类型。
IM_YAHOO2YAHOO即时消息类型。
IM_SKYPE3SKYPE即时消息类型。
IM_QQ4QQ即时消息类型。
IM_ICQ6ICQ即时消息类型。
IM_JABBER7JABBER即时消息类型。
INVALID_LABEL_ID-2无效的即时消息类型。

属性

名称参数类型可读可写说明
imAddressstring即时消息地址。
labelNamestring即时消息类型名称。
labelIdnumber即时消息类型。

对象创建示例:

使用JSON格式创建数据:

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

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

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

Name

联系人的名字类。

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

名称参数类型可读可写说明
familyNamestring联系人的家庭姓名。
familyNamePhoneticstring联系人的家庭姓名拼音。
fullNamestring联系人的全名。
givenNamestring联系人的名称(firstName)。
givenNamePhoneticstring联系人的名称拼音。
middleNamestring联系人的中间名。
middleNamePhoneticstring联系人的中间名拼音。
namePrefixstring联系人的姓名前缀。
nameSuffixstring联系人的姓名后缀。

对象创建示例:

使用JSON格式创建数据:

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

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

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

NickName

联系人的昵称类。

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

名称参数类型可读可写说明
nickNamestring联系人的昵称。

对象创建示例:

使用JSON格式创建数据:

let nickName = {
    nickName: "nickName"
};

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

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

Note

联系人的备注类。

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

名称参数类型可读可写说明
noteContentstring联系人的备注内容。

对象创建示例:

使用JSON格式创建数据:

let note = {
    noteContent: "noteContent"
};

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

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

Organization

联系人的组织类。

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

名称参数类型可读可写说明
namestring组织名称。
titlestring组织标题。

对象创建示例:

使用JSON格式创建数据:

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

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

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

PhoneNumber

联系人电话号码类。

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

常量

名称说明
CUSTOM_LABEL0自定义电话类型。
NUM_HOME1家庭电话类型。
NUM_MOBILE2移动电话类型。
NUM_WORK3工作电话类型。
NUM_FAX_WORK4工作传真电话类型。
NUM_FAX_HOME5家庭传真电话类型。
NUM_PAGER6寻呼机电话类型。
NUM_OTHER7其它电话类型。
NUM_CALLBACK8回呼电话类型。
NUM_CAR9车机电话类型。
NUM_COMPANY_MAIN10公司电话类型。
NUM_ISDN11综合业务数字网(ISDN)电话类型。
NUM_MAIN12主电话类型。
NUM_OTHER_FAX13其它传真类型。
NUM_RADIO14无线电话类型。
NUM_TELEX15电传电话类型。
NUM_TTY_TDD16电传打字机(TTY)或测试驱动开发(TDD)电话类型。
NUM_WORK_MOBILE17工作移动电话类型。
NUM_WORK_PAGER18工作寻呼机电话类型。
NUM_ASSISTANT19助理电话类型。
NUM_MMS20彩信电话类型。
INVALID_LABEL_ID-1无效电话类型。

属性

名称参数类型可读可写说明
labelNamestring电话号码类型名称。
phoneNumberstring电话号码。
labelIdnumber电话号码类型。

对象创建示例:

使用JSON格式创建数据:

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

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

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

Portrait

联系人的头像类。

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

名称参数类型可读可写说明
uristring联系人的头像。

对象创建示例:

使用JSON格式创建数据:

let portrait = {
    uri: "uri"
};

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

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

PostalAddress

联系人的邮政地址类。

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

常量

名称说明
CUSTOM_LABEL0自定义邮政地址类型。
ADDR_HOME1家庭地址类型。
ADDR_WORK2工作地址类型。
ADDR_OTHER3其它地址类型。
INVALID_LABEL_ID-1无效地址类型。

属性

名称参数类型可读可写说明
citystring联系人所在的城市。
countrystring联系人所在的国家。
labelNamestring邮政地址类型名称。
neighborhoodstring联系人的邻居。
poboxstring联系人的邮箱。
postalAddressstring联系人的邮政地址。
postcodestring联系人所在区域的邮政编码。
regionstring联系人所在的区域。
streetstring联系人所在的街道。
labelIdnumber邮政地址名称。

对象创建示例:

使用JSON格式创建数据:

let postalAddress = {
    city: "city"
};

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

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

Relation

联系人的关系类。

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

常量

名称说明
CUSTOM_LABEL0自定义关系类型。
RELATION_ASSISTANT1助手关系类型。
RELATION_BROTHER2兄弟关系类型。
RELATION_CHILD3子女关系类型。
RELATION_DOMESTIC_PARTNER4同居同伴关系类型。
RELATION_FATHER5父亲关系类型。
RELATION_FRIEND6朋友关系类型。
RELATION_MANAGER7管理者关系类型。
RELATION_MOTHER8母亲关系类型。
RELATION_PARENT9父母关系类型。
RELATION_PARTNER10合作伙伴关系类型。
RELATION_REFERRED_BY11推荐人关系类型。
RELATION_RELATIVE12亲属关系类型。
RELATION_SISTER13姐妹关系类型。
RELATION_SPOUSE14配偶关系类型。
INVALID_LABEL_ID-1无效的关系类型。

属性

名称参数类型可读可写说明
labelNamestring关系类型名称。
relationNamestring关系名称。
labelIdnumber关系类型。

对象创建示例:

使用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。

常量

名称说明
CUSTOM_LABEL0自定义会话发起协议(SIP)地址类型。
SIP_HOME1家庭会话发起协议(SIP)地址类型。
SIP_WORK2工作会话发起协议(SIP)地址类型。
SIP_OTHER3其它会话发起协议(SIP)地址类型。
INVALID_LABEL_ID-1无效会话发起协议(SIP)地址类型。

属性

名称参数类型可读可写说明
labelNamestring会话发起协议(SIP)地址类型名称。
sipAddressstring会话发起协议(SIP)地址。
labelIdnumber会话发起协议(SIP)地址类型。

对象创建示例:

使用JSON格式创建数据:

var sipAddress = {
    sipAddress: "sipAddress"
};

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

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

Website

联系人的网站信息类。

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

名称参数类型可读可写说明
websitestring联系人的网站信息。

对象创建示例:

使用JSON格式创建数据:

let website = {
    website: "website"
};

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

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

标签:鸿蒙,err,联系人,callback,JSON,contact,ohos,data
From: https://blog.csdn.net/2301_76813281/article/details/139665197

相关文章

  • 鸿蒙开发文件管理:【@ohos.fileManager (公共文件访问与管理)】
    公共文件访问与管理该模块提供公共文件访问和管理的服务接口,向下对接底层文件管理服务,如媒体库、外卡管理;向上对应用程序提供公共文件查询、创建的能力。 说明:本模块首批接口从APIversion9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。本模块接口......
  • 鸿蒙开发电话服务:【@ohos.telephony.observer (observer)】
    observer说明:本模块首批接口从APIversion6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。导入模块importobserverfrom'@ohos.telephony.observer'observer.on(‘networkStateChange’)on(type:‘networkStateChange’,callback:Callback......
  • 鸿蒙开发文件管理:【@ohos.securityLabel (数据标签)】
    数据标签该模块提供文件数据安全等级的相关功能:向应用程序提供查询、设置文件数据安全等级的JS接口。 说明: 本模块首批接口从APIversion9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。导入模块importsecurityLabelfrom'@ohos.securityLabe......
  • 鸿蒙ArkTS声明式开发:跨平台支持列表【点击回弹效果】 通用属性
    点击回弹效果设置组件点击时回弹效果。说明:从APIVersion10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。属性名称参数类型描述clickEffect[ClickEffect]nullClickEffect对象说明名称参数类型必填描述level[ClickEffectLevel]是设置当前......
  • 鸿蒙ArkTS声明式开发:跨平台支持列表【无障碍属性】 通用属性
    无障碍属性组件可以设置相应的无障碍属性和事件来更好地使用无障碍能力。说明:从APIVersion10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。属性名称参数类型描述accessibilityGroupboolean无障碍组,设置为true时表示该组件及其所有子组件......
  • 鸿蒙ArkTS声明式开发:跨平台支持列表【触摸热区设置】触摸交互控制
    触摸热区设置适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。说明:从APIVersion8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。属性名称参数类型描述responseRegionArray<[Rectangle]>[Rectangle]Rectangle对象说明从APIv......
  • 鸿蒙开发:应用组件跨设备交互(流转)【概述】
    流转概述场景介绍随着全场景多设备的生活方式不断深入,用户拥有的设备越来越多,不同设备都能在适合的场景下提供良好的体验,例如手表可以提供及时的信息查看能力,电视可以带来沉浸的观影体验。但是,每个设备也有使用场景的局限,例如在电视上输入文本相对移动设备来说是非常糟糕......
  • 鸿蒙开发:应用组件跨设备交互(流转)【跨端迁移】
    跨端迁移概述在用户使用设备的过程中,当使用情境发生变化时(例如从室内走到户外或者周围有更适合的设备等),之前使用的设备可能已经不适合继续当前的任务,此时,用户可以选择新的设备来继续当前的任务,原设备可按需决定是否退出任务,这个就是跨端迁移的场景。常见的跨端迁移场景实......
  • 鸿蒙开发:应用组件跨设备交互(流转)【多端协同】
    多端协同功能描述多端协同主要包括如下场景:[通过跨设备启动UIAbility和ServiceExtensionAbility组件实现多端协同(无返回数据)][通过跨设备启动UIAbility组件实现多端协同(获取返回数据)][通过跨设备连接ServiceExtensionAbility组件实现多端协同][通过跨设备Call调用实现多......
  • 鸿蒙开发:【Stage模型应用配置文件】
    Stage模型应用配置文件应用配置文件中包含应用配置信息、应用组件信息、权限信息、开发者自定义信息等,这些信息在编译构建、分发和运行解决分别提供给编译工具、应用市场和操作系统使用。在基于Stage模型开发的应用项目代码下,都存在app.json5(一个)及module.json5(一个或多个......