Class ContactsQuery

Definition

Namespace:

Tizen.Pims.Contacts

Assembly:

Tizen.Pims.Contacts.dll

A query is used to retrieve the data, which satisfies a given criteria.

public class ContactsQuery : IDisposable

Inheritance

object

ContactsQuery

Implements

System.IDisposable

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Constructors

ContactsQuery(string)

Creates a query.

Declaration

public ContactsQuery(string viewUri)

Parameters

Type	Name	Description
string	viewUri	The view URI of a query.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.
System.OutOfMemoryException	Thrown when failed due to out of memory.

Methods

Dispose()

Releases all the resources used by the ContactsQuery. It should be called after it has finished using the object.

Declaration

public void Dispose()

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Dispose(bool)

Releases all the resources used by the ContactsQuery.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Disposing by the user.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

~ContactsQuery()

The destructor.

Declaration

protected ~ContactsQuery()

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

SetDistinct(bool)

Sets the "distinct" option for projection.

Declaration

public void SetDistinct(bool set)

Parameters

Type	Name	Description
bool	set	If true it is set, otherwise if false it is unset.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.

SetFilter(ContactsFilter)

Sets the filter for a query.

Declaration

public void SetFilter(ContactsFilter filter)

Parameters

Type	Name	Description
ContactsFilter	filter	The filter.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

SetProjection(uint[])

Adds the property IDs for projection.

Declaration

public void SetProjection(uint[] propertyIdArray)

Parameters

Type	Name	Description
uint[]	propertyIdArray	The property ID array.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

SetSort(uint, bool)

Sets the sort mode for a query.

Declaration

public void SetSort(uint propertyId, bool isAscending)

Parameters

Type	Name	Description
uint	propertyId	The property ID to sort.
bool	isAscending	If true it sorts in ascending order, otherwise if false it sorts in descending order.

Remarks

A query is used to retrieve a person, group, speed dial, and log data, which satisfies a given criteria, such as an integer property being greater than a given value or a string property containing a given substring. A query needs a filter which can set the conditions for the search.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when one of the arguments provided to a method is not valid.

Implements

System.IDisposable