QContactFetchRequest Class

The QContactFetchRequest class allows a client to asynchronously request contacts from a contacts store manager. More...

Header: #include <QContactFetchRequest>
Inherits: QContactAbstractRequest

Public Functions

QContactFetchRequest(QObject * parent = 0)
~QContactFetchRequest()
QList<QContact> contacts() const
QContactFetchHint fetchHint() const
QContactFilter filter() const
void setFetchHint(const QContactFetchHint & fetchHint)
void setFilter(const QContactFilter & filter)
void setSorting(const QList<QContactSortOrder> & sorting)
void setStorageLocations(QContactAbstractRequest::StorageLocations storageLocations)
QList<QContactSortOrder> sorting() const
QContactAbstractRequest::StorageLocations storageLocations() const

Additional Inherited Members

Detailed Description

The QContactFetchRequest class allows a client to asynchronously request contacts from a contacts store manager.

For a QContactFetchRequest, the resultsAvailable() signal will be emitted when the resultant contacts (which may be retrieved by calling contacts()), are updated, as well as if the overall operation error (which may be retrieved by calling error()) is updated.

Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics.

Member Function Documentation

QContactFetchRequest::QContactFetchRequest(QObject * parent = 0)

Constructs a new contact fetch request whose parent is the specified parent

QContactFetchRequest::~QContactFetchRequest()

Frees any memory used by this request

QList<QContact> QContactFetchRequest::contacts() const

Returns the list of contacts retrieved by this request

QContactFetchHint QContactFetchRequest::fetchHint() const

Returns the fetch hint which may be used by the backend to optimize contact retrieval. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).

See also setFetchHint() and QContactFetchHint.

QContactFilter QContactFetchRequest::filter() const

Returns the filter that will be used to select contacts to be returned

See also setFilter().

void QContactFetchRequest::setFetchHint(const QContactFetchHint & fetchHint)

Sets the fetch hint which may be used by the backend to optimize contact retrieval to fetchHint. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).

See also fetchHint() and QContactFetchHint.

void QContactFetchRequest::setFilter(const QContactFilter & filter)

Sets the contact filter used to determine which contacts will be retrieved to filter.

See also filter().

void QContactFetchRequest::setSorting(const QList<QContactSortOrder> & sorting)

Sets the sort order of the result to sorting. Only has an effect if called prior to calling start()

See also sorting().

void QContactFetchRequest::setStorageLocations(QContactAbstractRequest::StorageLocations storageLocations)

Sets the storage location from where the contacts will be retrieved.

storageLocations is a flag so it is possible to define multiple locations in it. However, some backend implementations may accept only one flag to be set. In case multiple flags are set fetching is done from the default storage location.

See also storageLocations(), QContactAbstractRequest::StorageLocation, and QContactAbstractRequest::StorageLocations.

QList<QContactSortOrder> QContactFetchRequest::sorting() const

Returns the sort ordering that will be used sort the results of this request

See also setSorting().

QContactAbstractRequest::StorageLocations QContactFetchRequest::storageLocations() const

Returns the storage locations from where the contacts will be retrieved.

See also setStorageLocations(), QContactAbstractRequest::StorageLocation, and QContactAbstractRequest::StorageLocations.