Class ContactsFilter

Definition

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

A filter includes the conditions for the search.

public class ContactsFilter : IDisposable
Inheritance
Object
ContactsFilter
Implements
IDisposable

Constructors

View Source

ContactsFilter(String, UInt32, Boolean)

Creates a filter with a condition for a boolean type property.

Declaration
public ContactsFilter(string viewUri, uint propertyId, bool matchValue)
Parameters
Type Name Description
String viewUri

The view URI of a filter.
UInt32 propertyId

The property ID to add a condition.
Boolean matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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
View Source

ContactsFilter(String, UInt32, ContactsFilter.IntegerMatchType, Double)

Creates a filter with a condition for a double type property.

Declaration
public ContactsFilter(string viewUri, uint propertyId, ContactsFilter.IntegerMatchType matchType, double matchValue)
Parameters
Type Name Description
String viewUri

The view URI of a filter.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Double matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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
View Source

ContactsFilter(String, UInt32, ContactsFilter.IntegerMatchType, Int32)

Creates a filter with a condition for an integer type property.

Declaration
public ContactsFilter(string viewUri, uint propertyId, ContactsFilter.IntegerMatchType matchType, int matchValue)
Parameters
Type Name Description
String viewUri

The view URI of a filter.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Int32 matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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
View Source

ContactsFilter(String, UInt32, ContactsFilter.IntegerMatchType, Int64)

Creates a filter with a condition for a long type property.

Declaration
public ContactsFilter(string viewUri, uint propertyId, ContactsFilter.IntegerMatchType matchType, long matchValue)
Parameters
Type Name Description
String viewUri

The view URI of a filter.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Int64 matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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
View Source

ContactsFilter(String, UInt32, ContactsFilter.StringMatchType, String)

Creates a filter with a condition for a string type property.

Declaration
public ContactsFilter(string viewUri, uint propertyId, ContactsFilter.StringMatchType matchType, string matchValue)
Parameters
Type Name Description
String viewUri

The view URI of a filter.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.StringMatchType matchType

The match flag.
String matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddCondition(ContactsFilter.LogicalOperator, UInt32, Boolean)

Adds a condition for a boolean type property.

Declaration
public void AddCondition(ContactsFilter.LogicalOperator logicalOperator, uint propertyId, bool matchValue)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
UInt32 propertyId

The property ID to add a condition.
Boolean matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddCondition(ContactsFilter.LogicalOperator, UInt32, ContactsFilter.IntegerMatchType, Double)

Adds a condition for a double type property.

Declaration
public void AddCondition(ContactsFilter.LogicalOperator logicalOperator, uint propertyId, ContactsFilter.IntegerMatchType matchType, double matchValue)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Double matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddCondition(ContactsFilter.LogicalOperator, UInt32, ContactsFilter.IntegerMatchType, Int32)

Adds a condition for an integer type property.

Declaration
public void AddCondition(ContactsFilter.LogicalOperator logicalOperator, uint propertyId, ContactsFilter.IntegerMatchType matchType, int matchValue)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Int32 matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddCondition(ContactsFilter.LogicalOperator, UInt32, ContactsFilter.IntegerMatchType, Int64)

Adds a condition for a long type property.

Declaration
public void AddCondition(ContactsFilter.LogicalOperator logicalOperator, uint propertyId, ContactsFilter.IntegerMatchType matchType, long matchValue)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.IntegerMatchType matchType

The match flag.
Int64 matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddCondition(ContactsFilter.LogicalOperator, UInt32, ContactsFilter.StringMatchType, String)

Adds a condition for a string type property.

Declaration
public void AddCondition(ContactsFilter.LogicalOperator logicalOperator, uint propertyId, ContactsFilter.StringMatchType matchType, string matchValue)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
UInt32 propertyId

The property ID to add a condition.
ContactsFilter.StringMatchType matchType

The match flag.
String matchValue

The match value.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

AddFilter(ContactsFilter.LogicalOperator, ContactsFilter)

Adds a child filter to a parent filter.

Declaration
public void AddFilter(ContactsFilter.LogicalOperator logicalOperator, ContactsFilter filter)
Parameters
Type Name Description
ContactsFilter.LogicalOperator logicalOperator

The operator type.
ContactsFilter filter

The child filter.
Exceptions
Type Condition
NotSupportedException

Thrown when the feature is not supported.
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

Dispose()

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

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

Dispose(Boolean)

Releases all the resources used by the ContactsFilter.

Declaration
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
protected void Finalize()
API Level: 4

Implements