Contacts
NOTE
The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import contact from '@ohos.contact';
contact.addContact
addContact(contact:Contact, callback:AsyncCallback<number>): void
Adds a contact. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contact | Contact | Yes | Contact information. |
callback | AsyncCallback<number> | Yes | Callback used to return the contact ID. |
Example
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<number>
Adds a contact. This API uses a promise to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contact | Contact | Yes | Contact information. |
Return Value
Type | Description |
---|---|
Promise<number> | Promise used to return the contact ID. |
Example
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>): void
Deletes a contact based on the specified contact key. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
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<void>
Deletes a contact based on the specified contact key. This API uses a promise to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
Return Value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
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>): void
Updates a contact based on the specified contact information. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contact | Contact | Yes | Contact information. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
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>): void
Updates a contact based on the specified contact information and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contact | Contact | Yes | Contact information. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
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<void>
Updates a contact based on the specified contact information and attributes. This API uses a promise to return the result.
Permission required: ohos.permission.WRITE_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
contact | Contact | Yes | Contact information. |
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
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<boolean>): void
Checks whether the ID of this contact is in the local address book. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. Each contact corresponds to one ID. |
callback | AsyncCallback<boolean> | Yes | Callback used to return a boolean value. The value true indicates that the contact ID is in the local address book, and the value false indicates the opposite. |
Example
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<boolean>
Checks whether the ID of this contact is in the local address book. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. Each contact corresponds to one ID. |
Return Value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true indicates that the contact ID is in the local address book, and the value false indicates the opposite. |
Example
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<boolean>): void
Checks whether a contact is included in my card. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. The value true indicates that the contact is included in my card, and the value false indicates the opposite. |
Example
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<boolean>
Checks whether a contact is included in my card. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. |
Return Value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true indicates that the contact is included in my card, and the value false indicates the opposite. |
Example
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<Contact>): void
Queries my card. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>): void
Queries my card based on the specified contact attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>
Queries my card based on the specified contact attributes. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<Contact> | Promise used to return the result. |
Example
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<Contact>>): void
Selects a contact. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.Contacts and SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>
Selects a contact. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.Contacts and SystemCapability.Applications.ContactsData
Return Value
Type | Description |
---|---|
Promise<Array<Contact>> | Promise used to return the result. |
Example
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<Contact>): void
Queries a contact based on the specified key. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>): void
Queries contacts based on the specified key and application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>): void
Queries contacts based on the specified key and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>): void
Queries contacts based on the specified key, application, and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
holder | Holder | Yes | Application that creates the contacts. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Contact> | Yes | Callback used to return the result. |
Example
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<Contact>
Queries contacts based on the specified key, application, and attributes. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
key | string | Yes | Contact key. Each contact corresponds to one key. |
holder | Holder | No | Application that creates the contacts. |
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<Contact> | Promise used to return the result. |
Example
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<Contact>>): void
Queries all contacts. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries all contacts based on the specified application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries all contacts based on the specified attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries all contacts based on the specified application and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
holder | Holder | Yes | Application that creates the contacts. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>
Queries all contacts based on the specified application and attributes. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
holder | Holder | No | Application that creates the contacts. |
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<Array<Contact>> | Promise used to return the result. |
Example
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)}`);
});
contact.queryContactsByPhoneNumber
queryContactsByPhoneNumber(phoneNumber: string, callback: AsyncCallback<Array<Contact>>): void
Queries contacts based on the specified phone number. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
phoneNumber | string | Yes | Phone number of the contacts. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries contacts based on the specified phone number and application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
phoneNumber | string | Yes | Phone number of the contacts. |
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries contacts based on the specified phone number and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
phoneNumber | string | Yes | Phone number of the contacts. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>): void
Queries contacts based on the specified phone number, application, and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
phoneNumber | string | Yes | Phone number of the contacts. |
holder | Holder | Yes | Application that creates the contacts. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Contact>>
Queries contacts based on the specified phone number, application, and attributes. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
phoneNumber | string | Yes | Phone number of the contacts. |
holder | Holder | No | Application that creates the contacts. |
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<Array<Contact>> | Promise used to return the result. |
Example
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<Contact>>): void
Queries contacts based on the specified email address. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
string | Yes | Email address of the contact. | |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Array<Contact>>): void
Queries contacts based on the specified email address and application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
string | Yes | Email address of the contact. | |
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Array<Contact>>): void
Queries contacts based on the specified email address and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
string | Yes | Email address of the contact. | |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Array<Contact>>): void
Queries contacts based on the specified email address, application, and attributes. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
string | Yes | Email address of the contact. | |
holder | Holder | Yes | Application that creates the contacts. |
attrs | ContactAttributes | Yes | List of contact attributes. |
callback | AsyncCallback<Array<Contact>> | Yes | Callback used to return the result. |
Example
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<Array<Contact>>
Queries contacts based on the specified email address, application, and attributes. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
string | Yes | Email address of the contact. | |
holder | Holder | No | Application that creates the contacts. |
attrs | ContactAttributes | No | List of contact attributes. |
Return Value
Type | Description |
---|---|
Promise<Array<Contact>> | Promise used to return the result. |
Example
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<Array<Group>>): void
Queries all groups of this contact. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<Group>> | Yes | Callback used to return the result. |
Example
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<Group>>): void
Queries all groups of this contact based on the specified application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<Array<Group>> | Yes | Callback used to return the result. |
Example
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<Group>>
Queries all groups of this contact based on the specified application. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
holder | Holder | No | Application that creates the contacts. |
Return Value
Type | Description |
---|---|
Promise<Array<Group>> | Promise used to return the result. |
Example
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<Holder>>): void
Queries all applications that have created contacts. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<Holder>> | Yes | Callback used to return the result. |
Example
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<Holder>>
Queries all applications that have created contacts. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Return Value
Type | Description |
---|---|
Promise<Array<Holder>> | Promise used to return the result. |
Example
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<string>): void
Queries the key of a contact based on the specified contact ID. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. |
callback | AsyncCallback<string> | Yes | Callback used to return the result. |
Example
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<string>): void
Queries the key of a contact based on the specified contact ID and application. This API uses an asynchronous callback to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. |
holder | Holder | Yes | Application that creates the contacts. |
callback | AsyncCallback<string> | Yes | Callback used to return the result. |
Example
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<string>
Queries the key of a contact based on the specified contact ID and application. This API uses a promise to return the result.
Permission required: ohos.permission.READ_CONTACTS
System capability: SystemCapability.Applications.ContactsData
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | number | Yes | Contact ID. |
holder | Holder | No | Application that creates the contacts. |
Return Value
Type | Description |
---|---|
Promise<string> | Promise used to return the result. |
Example
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
Defines a contact.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
INVALID_CONTACT_ID | -1 | Default contact ID. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
id | number | Yes | No | Contact ID. |
key | string | Yes | No | Contact key. |
contactAttributes | ContactAttributes | Yes | Yes | List of contact attributes. |
emails | Email[] | Yes | Yes | List of email addresses of the contact. |
events | Event[] | Yes | Yes | List of important dates such as birthdays and anniversaries of the contact. |
groups | Group[] | Yes | Yes | List of groups of the contact. |
imAddresses | ImAddress[] | Yes | Yes | List of instant message addresses of the contact. |
phoneNumbers | PhoneNumber[] | Yes | Yes | List of phone numbers of the contact. |
portrait | Portrait | Yes | Yes | Contact portrait. |
postalAddresses | PostalAddress[] | Yes | Yes | List of postal addresses of the contact. |
relations | Relation[] | Yes | Yes | List of relationships with the contact. |
sipAddresses | SipAddress[] | Yes | Yes | List of Session Initiation Protocol (SIP) addresses of the contact. |
websites | Website[] | Yes | Yes | List of websites of the contact. |
name | Name | Yes | Yes | Contact name. |
nickName | NickName | Yes | Yes | Contact nickname. |
note | Note | Yes | Yes | Contact notes. |
organization | Organization | Yes | Yes | Organization of the contact. |
Example
Create contact data in JSON format:
let myContact = {
phoneNumbers: [{
phoneNumber: "138xxxxxxxx"
}],
name: {
fullName: "fullName",
namePrefix: "namePrefix"
},
nickName: {
nickName: "nickName"
}
};
Or, create data by configuring a new Contact object.
let myContact = new contact.Contact();
let name = new contact.Name();
name.fullName = "fullName";
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
myContact.name = name;
myContact.phoneNumbers = [phoneNumber];
ContactAttributes
Provides a list of contact attributes, which are generally used as arguments. If null is passed, all attributes are queried by default.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
attributes | Attribute[] | Yes | Yes | List of contact attributes. |
Example
Create contact data in JSON format:
let contactAttributes = {
attributes: [
contact.Attribute.ATTR_EMAIL,
contact.Attribute.ATTR_NAME,
contact.Attribute.ATTR_PHONE
]
};
Or, create data by configuring a ContactAttributes object.
let contactAttributes = new contact.ContactAttributes();
contactAttributes.attributes = ["ATTR_EMAIL"];
Attribute
Enumerates contact attributes.
System capability: SystemCapability.Applications.ContactsData
Name | Description |
---|---|
ATTR_CONTACT_EVENT | Important dates such as birthday and anniversaries of the contact. |
ATTR_EMAIL | Email address of the contact. |
ATTR_GROUP_MEMBERSHIP | Groups of the contact. |
ATTR_IM | IM addresses of the contact. |
ATTR_NAME | Contact name. |
ATTR_NICKNAME | Contact nickname. |
ATTR_NOTE | Contact notes. |
ATTR_ORGANIZATION | Organization of the contact. |
ATTR_PHONE | Phone number of the contacts. |
ATTR_PORTRAIT | Contact portrait. |
ATTR_POSTAL_ADDRESS | Postal address of the contact. |
ATTR_RELATION | Relationship with the contact. |
ATTR_SIP_ADDRESS | SIP addresses of the contact. |
ATTR_WEBSITE | Website that stores the contact information. |
Example
Create contact data in JSON format:
let attributes = [contact.Attribute.ATTR_EMAIL, contact.Attribute.ATTR_NAME, contact.Attribute.ATTR_PHONE];
Defines a contact's email.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom mailbox type. |
EMAIL_HOME | 1 | Home mailbox. |
EMAIL_WORK | 2 | Work mailbox. |
EMAIL_OTHER | 3 | Other mailbox. |
INVALID_LABEL_ID | -1 | Invalid mailbox. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
string | Yes | Yes | Email addresses | |
labelName | string | Yes | Yes | Name of the mailbox type. |
displayName | string | Yes | Yes | Displayed name of the mailbox. |
labelId | number | Yes | Yes | Mailbox type. |
Example
Create contact data in JSON format:
let email = {
email: "xxx@email.com",
displayName: "displayName"
}
Or, create data by configuring an Email object.
let email = new contact.Email();
email.email = "xxx@email.com";
Holder
Defines an application that creates the contact.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
bundleName | string | Yes | No | Bundle name. |
displayName | string | Yes | No | Application name. |
holderId | number | Yes | Yes | Application ID. |
Example
Create contact data in JSON format:
let holder = {
holderId: 0
};
Or, create data by configuring a Holder object.
let holder = new contact.Holder();
holder.holderId = 0;
Event
Defines a contact's event.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom event. |
EVENT_ANNIVERSARY | 1 | Anniversary event. |
EVENT_OTHER | 2 | Other event. |
EVENT_BIRTHDAY | 3 | Birthday event. |
INVALID_LABEL_ID | -1 | Invalid event. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
eventDate | string | Yes | Yes | Event date. |
labelName | string | Yes | Yes | Event type. |
labelId | number | Yes | Yes | Event type ID. |
Example
Create contact data in JSON format:
let event = {
eventDate: "xxxxxx"
};
Or, create data by configuring an Event object.
let event = new contact.Event();
event.eventDate = "xxxxxx";
Group
Defines a contact group.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
groupId | number | Yes | Yes | ID of a contact group. |
title | string | Yes | Yes | Name of a contact group. |
Example
Create contact data in JSON format:
let group = {
groupId: 1,
title: "title"
};
Or, create data by configuring a Group object.
let group = new contact.Group();
group.title = "title";
ImAddress
Enumerates IM addresses.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | -1 | Custom IM |
IM_AIM | 0 | AIM |
IM_MSN | 1 | MSN |
IM_YAHOO | 2 | Yahoo |
IM_SKYPE | 3 | Skype |
IM_QQ | 4 | |
IM_ICQ | 6 | ICQ |
IM_JABBER | 7 | JABBER |
INVALID_LABEL_ID | -2 | Invalid IM |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
imAddress | string | Yes | Yes | IM address. |
labelName | string | Yes | Yes | IM name. |
labelId | number | Yes | Yes | IM ID. |
Example
Create contact data in JSON format:
let imAddress = {
imAddress: "imAddress",
labelName: "labelName"
};
Or, create data by configuring an ImAddress object.
let imAddress = new contact.ImAddress();
imAddress.imAddress = "imAddress";
Name
Defines a contact's name.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
familyName | string | Yes | Yes | Family name. |
familyNamePhonetic | string | Yes | Yes | Family name in pinyin. |
fullName | string | Yes | Yes | Full name of the contact. |
givenName | string | Yes | Yes | Given name of the contact. |
givenNamePhonetic | string | Yes | Yes | Given name of the contact in pinyin. |
middleName | string | Yes | Yes | Middle name of the contact. |
middleNamePhonetic | string | Yes | Yes | Middle name of the contact in pinyin. |
namePrefix | string | Yes | Yes | Prefix of the contact name. |
nameSuffix | string | Yes | Yes | Suffix of the contact name. |
Example
Create contact data in JSON format:
let name = {
familyName: "familyName",
fullName: "fullName"
};
Or, create data by configuring a Name object.
let name = new contact.Name();
name.familyName = "familyName";
name.fullName = "fullName";
NickName
Defines a contact's nickname.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
nickName | string | Yes | Yes | Contact nickname. |
Example
Create contact data in JSON format:
let nickName = {
nickName: "nickName"
};
Or, create data by configuring a NickName object.
let nickName = new contact.NickName();
nickName.nickName = "nickName";
Note
Defines a contact's note.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
noteContent | string | Yes | Yes | Notes of the contact. |
Example
Create contact data in JSON format:
let note = {
noteContent: "noteContent"
};
Or, create data by configuring a Note object.
let note = new contact.Note();
note.noteContent = "noteContent";
Organization
Defines a contact's organization.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
name | string | Yes | Yes | Organization name. |
title | string | Yes | Yes | Organization title. |
Example
Create contact data in JSON format:
let organization = {
name: "name",
title: "title"
};
Or, create data by configuring an Organization object.
let organization = new contact.Organization();
organization.name = "name";
organization.title = "title";
PhoneNumber
Defines a contact's phone number.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom phone type. |
NUM_HOME | 1 | Home phone. |
NUM_MOBILE | 2 | Mobile phone. |
NUM_WORK | 3 | Work phone. |
NUM_FAX_WORK | 4 | Work fax. |
NUM_FAX_HOME | 5 | Family fax. |
NUM_PAGER | 6 | Pager. |
NUM_OTHER | 7 | Other phone type. |
NUM_CALLBACK | 8 | Callback phone. |
NUM_CAR | 9 | Car phone. |
NUM_COMPANY_MAIN | 10 | Company phone. |
NUM_ISDN | 11 | Integrated Services Digital Network (ISDN) phone. |
NUM_MAIN | 12 | Main phone. |
NUM_OTHER_FAX | 13 | Other fax phone. |
NUM_RADIO | 14 | Wireless phone. |
NUM_TELEX | 15 | Telex phone. |
NUM_TTY_TDD | 16 | Teletypewriter (TTY) or Test Driven Development (TDD) phone. |
NUM_WORK_MOBILE | 17 | Work mobile phone. |
NUM_WORK_PAGER | 18 | Work pager. |
NUM_ASSISTANT | 19 | Assistant phone. |
NUM_MMS | 20 | MMS phone. |
INVALID_LABEL_ID | -1 | Invalid phone type. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
labelName | string | Yes | Yes | Phone number type. |
phoneNumber | string | Yes | Yes | Phone number. |
labelId | number | Yes | Yes | Phone number ID. |
Example
Create contact data in JSON format:
let phoneNumber = {
phoneNumber: "138xxxxxxxx",
labelId: contact.PhoneNumber.NUM_HOME
};
Or, create data by configuring a new PhoneNumber object.
let phoneNumber = new contact.PhoneNumber();
phoneNumber.phoneNumber = "138xxxxxxxx";
Portrait
Defines a contact's portrait.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
uri | string | Yes | Yes | Contact portrait. |
Example
Create contact data in JSON format:
let portrait = {
uri: "uri"
};
Or, create data by configuring a new Portrait object.
let portrait = new contact.Portrait();
portrait.uri = "uri";
PostalAddress
Defines a contact's postal address.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom postal address type. |
ADDR_HOME | 1 | Home address. |
ADDR_WORK | 2 | Work address. |
ADDR_OTHER | 3 | Other addresses. |
INVALID_LABEL_ID | -1 | Invalid address type. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
city | string | Yes | Yes | City where the contact is located. |
country | string | Yes | Yes | Country/Region where the contact is located. |
labelName | string | Yes | Yes | Postal address type. |
neighborhood | string | Yes | Yes | Neighbor of the contact. |
pobox | string | Yes | Yes | Email of the contact. |
postalAddress | string | Yes | Yes | Postal address of the contact. |
postcode | string | Yes | Yes | Postal code of the region where the contact is located. |
region | string | Yes | Yes | Area where the contact is located. |
street | string | Yes | Yes | Street where the contact resides. |
labelId | number | Yes | Yes | Postal address ID. |
Example
Create contact data in JSON format:
let postalAddress = {
city: "city"
};
Or, create data by configuring a new PostalAddress object.
let postalAddress = new contact.PostalAddress();
postalAddress.city = "city";
Relation
Defines a contact's relationship.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom relationship. |
RELATION_ASSISTANT | 1 | Assistant. |
RELATION_BROTHER | 2 | Sibling. |
RELATION_CHILD | 3 | Child. |
RELATION_DOMESTIC_PARTNER | 4 | Domestic partner. |
RELATION_FATHER | 5 | Father. |
RELATION_FRIEND | 6 | Friend. |
RELATION_MANAGER | 7 | Manager. |
RELATION_MOTHER | 8 | Mother. |
RELATION_PARENT | 9 | Parent. |
RELATION_PARTNER | 10 | Partner. |
RELATION_REFERRED_BY | 11 | Referrer. |
RELATION_RELATIVE | 12 | Relative. |
RELATION_SISTER | 13 | Sister. |
RELATION_SPOUSE | 14 | Spouse. |
INVALID_LABEL_ID | -1 | Invalid relationship. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
labelName | string | Yes | Yes | Relationship type. |
relationName | string | Yes | Yes | Relationship name. |
labelId | number | Yes | Yes | Relationship ID. |
Example
Create contact data in JSON format:
let relation = {
relationName: "relationName",
labelId: contact.Relation.RELATION_ASSISTANT
};
Or, create data by configuring a new Relation object.
let relation = new contact.Relation();
relation.relationName = "relationName";
relation.labelId = contact.Relation.RELATION_ASSISTANT;
SipAddress
Defines a contact's SIP address.
System capability: SystemCapability.Applications.ContactsData
Constant
Name | Value | Description |
---|---|---|
CUSTOM_LABEL | 0 | Custom SIP address. |
SIP_HOME | 1 | Home SIP address. |
SIP_WORK | 2 | Work SIP address. |
SIP_OTHER | 3 | Other SIP address. |
INVALID_LABEL_ID | -1 | Invalid SIP address. |
Attributes
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
labelName | string | Yes | Yes | SIP address type. |
sipAddress | string | Yes | Yes | SIP address. |
labelId | number | Yes | Yes | SIP address ID. |
Example
Create contact data in JSON format:
var sipAddress = {
sipAddress: "sipAddress"
};
Or, create data by configuring a new SipAddress object.
let sipAddress = new contact.SipAddress();
sipAddress.sipAddress = "sipAddress";
Website
Defines a contact's website.
System capability: SystemCapability.Applications.ContactsData
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
website | string | Yes | Yes | Website of the contact. |
Example
Create contact data in JSON format:
let website = {
website: "website"
};
Or, create data by configuring a new Website object.
let website = new contact.Website();
website.website = "website";