ContactRemoteSearchFilters

#include <bb/pim/contacts/ContactRemoteSearchFilters>

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

The ContactRemoteSearchFilters class represents a set of filters that are used for remote searches.

You can use this class to filter search results that you retrieve using ContactService::searchRemote(). You can specify the string to search for, start index, end index, and account to search.

These filters allow pagination, but only when used with a specific account. When used without the account specified, the query tries to fetch the specified page of contacts from all remote searchable sources.

See:

ContactService::searchRemote()

Since:

BlackBerry 10.0.0

Public Functions Index

ContactRemoteSearchFilters ()
~ContactRemoteSearchFilters ()
ContactRemoteSearchFilters (const ContactRemoteSearchFilters &copy)
ContactRemoteSearchFilters &operator= (const ContactRemoteSearchFilters &operand)
ContactRemoteSearchFilters &setSearchValue (QString &value)
ContactRemoteSearchFilters &setStartIndex (int start)
ContactRemoteSearchFilters &setEndIndex (int end)
ContactRemoteSearchFilters &setAccount (AccountId accountId)

Public Functions

ContactRemoteSearchFilters ()

Constructs a new ContactRemoteSearchFilters.

Since:

BlackBerry 10.0.0

~ContactRemoteSearchFilters ()

Destructor.

Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters (

Copy constructor.

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

Parameters
copy

The ContactRemoteSearchFilters to be copied.
Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters & operator= (

Assignment operator.

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

Parameters
operand

The ContactRemoteSearchFilters from which to copy all values.
Return:

A ContactRemoteSearchFilters with all copied data

Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters & setSearchValue (

Sets the search value of this ContactRemoteSearchFilters.

This is a required field.

Parameters
value

The search value to set.
Return:

A ContactRemoteSearchFilters with the provided search value.

Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters & setStartIndex (
  • intstart)

Sets the start index of this ContactRemoteSearchFilters.

The start index is 0-based (that is, the first element to be searched is at index 0) and is inclusive.

Parameters
start

The start index to set.
Return:

A ContactRemoteSearchFilters with the provided start index.

Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters & setEndIndex (
  • intend)

Sets the end index of this ContactRemoteSearchFilters.

The end index is 0-based (that is, the first element to be searched is at index 0) and is inclusive.

Parameters
end

The end index to set.
Return:

A ContactRemoteSearchFilters with the provided end index.

Since:

BlackBerry 10.0.0

ContactRemoteSearchFilters & setAccount (
  • AccountIdaccountId)

Sets the account ID for this ContactRemoteSearchFilters.

The account ID specifies the account that the remote search should apply to.

Parameters
accountId

The account ID to set.
Return:

A ContactRemoteSearchFilters with the provided account ID.

Since:

BlackBerry 10.0.0