ContactAutoCompleteSearchFilters

Since: BlackBerry 10.0.0

#include <bb/pim/contacts/ContactAutoCompleteSearchFilters>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The ContactAutoCompleteSearchFilters class represents a set of search filters that are used for auto-complete searches.

You can use this class to provide support for auto-complete searches, which are performed by calling ContactService::searchContactsAutoComplete(). Auto-complete searches are designed to be fast, and are used primarily to display auto-completion results for email addresses. Users can type partial search terms and the API will try to find matching completions.


Overview

Public Functions Index

Public Functions

ContactAutoCompleteSearchFilters ()

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters (

Copy constructor.

This function constructs a ContactAutoCompleteSearchFilters containing exactly the same values as the provided ContactAutoCompleteFilters.

Parameters
copy

The ContactAutoCompleteSearchFilters to be copied.

Since:

BlackBerry 10.0.0

~ContactAutoCompleteSearchFilters ()

Destructor.

Since:

BlackBerry 10.0.0

bool includePhotos ()

Indicates whether the primary photo that's associated with a contact should be included as part of the search results.

Return:

true if the primary photo should be included in the results, false otherwise.

Since:

BlackBerry 10.0.0

int limit ()

Retrieves the result limit of this ContactAutoCompleteSearchFilters.

This value represents the maximum number of results that are returned for the auto-complete search.

Return:

The result limit of this ContactAutoCompleteSearchFilters.

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters & operator= (

Assignment operator.

This operator copies all values from the provided ContactAutoCompleteSearchFilters into this ContactAutoCompleteSearchFilters.

Parameters
operand

The ContactAutoCompleteSearchFilters from which to copy all values.

Return:

A ContactAutoCompleteSearchFilters with all copied data

Since:

BlackBerry 10.0.0

SearchAutoCompleteField::Type searchField ()

Retrieves the search field of this ContactAutoCompleteSearchFilters.

This value represents the search field that the auto-complete search applies to. For example, you can specify that the search should apply to emails, Twitter profile information, Facebook profile information, and so on.

Return:

The search field of this ContactAutoCompleteSearchFilters.

Since:

BlackBerry 10.0.0

QString searchValue ()

Retrieves the search value of this ContactAutoCompleteSearchFilters.

This value represents the string to search for in the list of contacts.

Return:

The search value of this ContactAutoCompleteSearchFilters.

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters & setIncludePhotos (
  • boolincludePhotos)

Sets whether to include the primary photo that's associated with a contact as part of the search results.

Parameters
includePhotos

If true the primary photo should be included in the results, if false the primary photo should not be included in the results.

Return:

A ContactAutoCompleteSearchFilter with the provided indication of whether to include the primary photo in the search results.

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters & setLimit (
  • intlimit)

Sets the result limit of this ContactAutoCompleteSearchFilters.

This value represents the maximum number of results that are returned for the auto-complete search. If no limit is set, the default value is 20 results.

Parameters
limit

The maximum number of results that are returned.

Return:

A ContactAutoCompleteSearchFilters with the provided result limit.

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters & setSearchField (

Sets the search field of this ContactAutoCompleteSearchFilters.

This function sets the search field that the auto-complete search applies to, according to the provided value from the SearchAutoCompleteField::Type enumeration. If no field is specified, the default search field is by email (SearchAutoCompleteField::Email).

Parameters
field

The search field to set.

Return:

A ContactAutoCompleteSearchFilter with the provided search field.

Since:

BlackBerry 10.0.0

ContactAutoCompleteSearchFilters & setSearchValue (

Sets the search value of this ContactAutoCompleteSearchFilters.

This value represents the string to search for in the list of contacts. This is a required field.

Parameters
value

The search value to set.

Return:

A ContactAutoCompleteSearchFilters with the provided search value.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus