Class ContactsFilter

View Source

Definition

Namespace:
Tizen.Pims.Contacts
Assembly:
Tizen.Pims.Contacts.dll

A filter includes the conditions for the search.


                
C#

                

                    
Copy

                    

                

            
public class ContactsFilter : IDisposable
Inheritance
object
ContactsFilter
Implements
System.IDisposable

Constructors

View Source

ContactsFilter(string, uint, bool)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

The view URI of a filter.
uint propertyId

The property ID to add a condition.
bool matchValue

The match value.
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.
View Source

ContactsFilter(string, uint, IntegerMatchType, double)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

The view URI of a filter.
uint propertyId

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

The match flag.
double matchValue

The match value.
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.
View Source

ContactsFilter(string, uint, IntegerMatchType, int)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

The view URI of a filter.
uint propertyId

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

The match flag.
int matchValue

The match value.
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.
View Source

ContactsFilter(string, uint, IntegerMatchType, long)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

The view URI of a filter.
uint propertyId

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

The match flag.
long matchValue

The match value.
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.
View Source

ContactsFilter(string, uint, StringMatchType, string)

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

Declaration

                
C#

                

                    
Copy

                    

                

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

The view URI of a filter.
uint propertyId

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

The match flag.
string matchValue

The match value.
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

View Source

AddCondition(LogicalOperator, uint, bool)

Adds a condition for a boolean type property.

Declaration

                
C#

                

                    
Copy

                    

                

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

The operator type.
uint propertyId

The property ID to add a condition.
bool matchValue

The match value.
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.
View Source

AddCondition(LogicalOperator, uint, IntegerMatchType, double)

Adds a condition for a double type property.

Declaration

                
C#

                

                    
Copy

                    

                

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

The operator type.
uint propertyId

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

The match flag.
double matchValue

The match value.
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.
View Source

AddCondition(LogicalOperator, uint, IntegerMatchType, int)

Adds a condition for an integer type property.

Declaration

                
C#

                

                    
Copy

                    

                

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

The operator type.
uint propertyId

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

The match flag.
int matchValue

The match value.
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.
View Source

AddCondition(LogicalOperator, uint, IntegerMatchType, long)

Adds a condition for a long type property.

Declaration

                
C#

                

                    
Copy

                    

                

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

The operator type.
uint propertyId

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

The match flag.
long matchValue

The match value.
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.
View Source

AddCondition(LogicalOperator, uint, StringMatchType, string)

Adds a condition for a string type property.

Declaration

                
C#

                

                    
Copy

                    

                

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

The operator type.
uint propertyId

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

The match flag.
string matchValue

The match value.
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.
View Source

AddFilter(LogicalOperator, ContactsFilter)

Adds a child filter to a parent filter.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
System.NotSupportedException

Thrown when the feature is not supported.
System.ArgumentException

Thrown when one of the arguments provided to a method is not valid.
View Source

Dispose()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
View Source

Dispose(bool)

Releases all the resources used by the ContactsFilter.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Disposing by the user.
View Source

~ContactsFilter()

The destructor.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ~ContactsFilter()

Implements

System.IDisposable