Class ContactsQuery

Definition

Namespace:
Tizen.Pims.Contacts
Assembly:
Tizen.Pims.Contacts.dll
API Level:
4

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

C#
Copy
public class ContactsQuery : IDisposable
Inheritance
System.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

View Source

ContactsQuery(String)

Creates a query.

Declaration
C#
Copy
public ContactsQuery(string viewUri)
Parameters
Type Name Description
System.String viewUri

The view URI of a query.

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.

OutOfMemoryException

Thrown when failed due to out of memory.

API Level: 4
Feature: http://tizen.org/feature/contact

Methods

View Source

Dispose()

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

Declaration
C#
Copy
public void Dispose()
API Level: 4
View Source

Dispose(Boolean)

Releases all the resources used by the ContactsQuery.

Declaration
C#
Copy
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

Disposing by the user.

API Level: 4
View Source

Finalize()

The destructor.

Declaration
C#
Copy
protected void Finalize()
API Level: 4
View Source

SetDistinct(Boolean)

Sets the "distinct" option for projection.

Declaration
C#
Copy
public void SetDistinct(bool set)
Parameters
Type Name Description
Boolean set

If true it is set, otherwise if false it is unset.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the feature is not supported.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

SetFilter(ContactsFilter)

Sets the filter for a query.

Declaration
C#
Copy
public void SetFilter(ContactsFilter filter)
Parameters
Type Name Description
ContactsFilter filter

The filter.

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.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

SetProjection(UInt32[])

Adds the property IDs for projection.

Declaration
C#
Copy
public void SetProjection(uint[] propertyIdArray)
Parameters
Type Name Description
System.UInt32[] propertyIdArray

The property ID array.

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.

API Level: 4
Feature: http://tizen.org/feature/contact
View Source

SetSort(UInt32, Boolean)

Sets the sort mode for a query.

Declaration
C#
Copy
public void SetSort(uint propertyId, bool isAscending)
Parameters
Type Name Description
System.UInt32 propertyId

The property ID to sort.

Boolean isAscending

If true it sorts in ascending order, otherwise if false it sorts in descending order.

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.

API Level: 4
Feature: http://tizen.org/feature/contact

Implements

System.IDisposable