程序包 ohos.sysappcomponents.contact

类 ContactsHelper

java.lang.Object

ohos.sysappcomponents.contact.ContactsHelper

public class ContactsHelper
extends Object

Contact management class that provides methods for creating, updating, deleting, and querying contacts.

从以下版本开始:

3

SystemCapability

SystemCapability.SysAppComponents#CONTACT

构造器概要

构造器

构造器	说明
ContactsHelper(Context context)	Creates a ContactsHelper instance.

方法概要

限定符和类型	方法	说明
long	addContact(Contact contact)	Creates a contact.
boolean	deleteContact(String key)	Deletes a specified contact.
boolean	isLocalContact(long id)	Checks whether the contact ID is in the local phone book.
boolean	isMyCard(long id)	Checks whether the contact ID is of "my card".
Contact	queryContact(String key, Holder holder, ContactAttributes attrs)	Queries a specified contact of specified attributes.
ContactsCollection	queryContacts(Holder holder, ContactAttributes attrs)	Queries contacts with query conditions.
ContactsCollection	queryContactsByEmail(String email, Holder holder, ContactAttributes attrs)	Queries contacts by a specified email address, contact holder, and contact attributes.
ContactsCollection	queryContactsByPhoneNumber(String phoneNumber, Holder holder, ContactAttributes attrs)	Queries contacts by a phone number, holder, and contact attribute.
List<Group>	queryGroups(Holder holder)	Queries contact groups.
HoldersCollection	queryHolders()	Queries contact holders.
String	queryKey(long id, Holder holder)	Obtains the query key of a contact based on a specified ID and holder.
Contact	queryMyCard(ContactAttributes attrs)	Queries information about "my card".
boolean	updateContact(Contact contact, ContactAttributes attrs)	Updates specified attributes of a contact.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ContactsHelper

public ContactsHelper(Context context)

Creates a ContactsHelper instance.

参数:

context - Indicates the application context.

从以下版本开始:

3

方法详细资料

queryContactsByPhoneNumber

public ContactsCollection queryContactsByPhoneNumber(String phoneNumber,
                                                     Holder holder,
                                                     ContactAttributes attrs)

Queries contacts by a phone number, holder, and contact attribute.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS.

参数:

phoneNumber - Indicates the phone number. Only full match is supported, and wildcards are not supported.

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

attrs - Indicates the contact attribute. If this parameter is null, all attributes will be used for matching.

返回:

Returns the ContactsCollection object.

从以下版本开始:

3

queryContactsByEmail

public ContactsCollection queryContactsByEmail(String email,
                                               Holder holder,
                                               ContactAttributes attrs)

Queries contacts by a specified email address, contact holder, and contact attributes.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

email - Indicates the email address.

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

attrs - Indicates the contact attributes. If this parameter is null, all attributes are used for matching.

返回:

Returns a ContactsCollection object.

从以下版本开始:

3

queryHolders

public HoldersCollection queryHolders()

Queries contact holders.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

返回:

Returns the HoldersCollection object.

从以下版本开始:

3

queryContacts

public ContactsCollection queryContacts(Holder holder,
                                        ContactAttributes attrs)

Queries contacts with query conditions.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

attrs - Indicates the contact attributes. If this parameter is null, all attributes are used for matching.

返回:

Returns the ContactsCollection object.

从以下版本开始:

3

queryMyCard

public Contact queryMyCard(ContactAttributes attrs)

Queries information about "my card".

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

attrs - Indicates the contact attributes. If this parameter is null, all attributes are used for matching.

返回:

Returns information about "my card".

从以下版本开始:

3

queryContact

public Contact queryContact(String key,
                            Holder holder,
                            ContactAttributes attrs)

Queries a specified contact of specified attributes.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

key - Indicates the unique query key of a contact.

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

attrs - Indicates the contact attributes. If this parameter is null, all attributes are used for matching.

返回:

Returns the specified contact.

从以下版本开始:

3

另请参阅:

ContactAttributes

addContact

public long addContact(Contact contact)

Creates a contact.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

contact - Indicates the contact information.

返回:

Returns the contact ID (which can be obtained by Contact#getId()) if the creation is successful; returns Contact#INVALID_CONTACT_ID if the creation fails.

从以下版本开始:

3

deleteContact

public boolean deleteContact(String key)

Deletes a specified contact.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

key - Indicates the unique query key of a contact to delete.

返回:

Returns true if the contact is deleted; returns false otherwise.

从以下版本开始:

3

updateContact

public boolean updateContact(Contact contact,
                             ContactAttributes attrs)

Updates specified attributes of a contact.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

contact - Indicates the contact whose information is to update.

attrs - Indicates the contact attributes to update. If this parameter is null, all available attributes will be updated.

返回:

Returns true if the update is successful; returns false otherwise.

从以下版本开始:

3

isMyCard

public boolean isMyCard(long id)

Checks whether the contact ID is of "my card".

参数:

id - Indicates the contact ID.

返回:

Returns true if the contact ID is of "my card"; returns false otherwise.

从以下版本开始:

3

queryGroups

public List<Group> queryGroups(Holder holder)

Queries contact groups.

Permissions: SystemPermission.READ_CONTACTS, SystemPermission.WRITE_CONTACTS

参数:

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

返回:

Returns the contact group list.

从以下版本开始:

3

queryKey

public String queryKey(long id,
                       Holder holder)

Obtains the query key of a contact based on a specified ID and holder.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

id - Indicates the contact ID.

holder - Indicates the contact holder. If this parameter is null, the default holder is used for matching.

返回:

Returns the query key of the contact.

从以下版本开始:

3

另请参阅:

Contact.getKey()

isLocalContact

public boolean isLocalContact(long id)

Checks whether the contact ID is in the local phone book.

Permissions required: SystemPermission.READ_CONTACTS and SystemPermission.WRITE_CONTACTS

参数:

id - Indicates the contact ID.

返回:

Returns true if the contact ID is in the local phone book; returns false otherwise.

从以下版本开始:

3