QContactIdFetchRequest Class

The QContactIdFetchRequest class allows a client to asynchronously request a list of contact ids from a contacts store manager. More...

Header: #include <QContactIdFetchRequest>
Inherits: QContactAbstractRequest

Public Functions

QContactIdFetchRequest(QObject *parent = 0)
~QContactIdFetchRequest()
QContactFilter filter() const
QList<QContactId> ids() const
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 QContactIdFetchRequest class allows a client to asynchronously request a list of contact ids from a contacts store manager.

For a QContactIdFetchRequest, the resultsAvailable() signal will be emitted when the resultant contact ids (which may be retrieved by calling ids()), 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

QContactIdFetchRequest::QContactIdFetchRequest(QObject *parent = 0)

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

QContactIdFetchRequest::~QContactIdFetchRequest()

Frees any memory used by this request

QContactFilter QContactIdFetchRequest::filter() const

Returns the filter which will be used to select the contacts whose ids will be returned

See also setFilter().

QList<QContactId> QContactIdFetchRequest::ids() const

Returns the list of ids of contacts which matched the request

void QContactIdFetchRequest::setFilter(const QContactFilter &filter)

Sets the filter which will be used to select the contacts whose ids will be returned to filter

See also filter().

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

Sets the future sort ordering of the result of the request to sorting. This function only has effect on the result if called prior to calling start()

See also sorting().

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

Sets the storage location from where the contact ids will be retrieved. storageLocations is a flag so it is possible to define multiple locations in it.

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

QList<QContactSortOrder> QContactIdFetchRequest::sorting() const

Returns the sort ordering which will be used to sort the result

See also setSorting().

QContactAbstractRequest::StorageLocations QContactIdFetchRequest::storageLocations() const

Returns the storage locations from where the contact ids will be retrieved.

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