QContactFetchByIdRequest Class Reference

The QContactFetchByIdRequest class allows a client to asynchronously request contacts from a contacts store manager, given a list of contact IDs. More...

 #include <QContactFetchByIdRequest>

Inherits: QContactAbstractRequest.

List of all members, including inherited members

Public Functions

	QContactFetchByIdRequest ( QObject * parent = 0 )
	~QContactFetchByIdRequest ()
QList<QContact>	contacts () const
QMap<int, QContactManager::Error>	errorMap () const
QContactFetchHint	fetchHint () const
QList<QContactLocalId>	localIds () const
void	setFetchHint ( const QContactFetchHint & fetchHint )
void	setLocalIds ( const QList<QContactLocalId> & localIds )

9 public functions inherited from QContactAbstractRequest
29 public functions inherited from QObject

Additional Inherited Members

1 property inherited from QObject
3 public slots inherited from QContactAbstractRequest
1 public slot inherited from QObject
2 signals inherited from QContactAbstractRequest
1 signal inherited from QObject
1 public variable inherited from QObject
4 static public members inherited from QObject
7 protected functions inherited from QObject
2 protected variables inherited from QObject

Detailed Description

The QContactFetchByIdRequest class allows a client to asynchronously request contacts from a contacts store manager, given a list of contact IDs.

The contacts fetched by the backend should have a one-to-one correspondence to the IDs passed into this class. That is, the nth contact in the returned list should have an ID which is equal to the nth ID in the list of IDs. Any invalid ID should correspond to an empty QContact.

For a QContactFetchByIdRequest, 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

QContactFetchByIdRequest::QContactFetchByIdRequest ( QObject * parent = 0 )

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

QContactFetchByIdRequest::~QContactFetchByIdRequest ()

Frees any memory used by this request

QList<QContact> QContactFetchByIdRequest::contacts () const

Returns the list of contacts retrieved by this request

QMap<int, QContactManager::Error> QContactFetchByIdRequest::errorMap () const

Returns the map of input definition list indices to errors which occurred

QContactFetchHint QContactFetchByIdRequest::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.

QList<QContactLocalId> QContactFetchByIdRequest::localIds () const

Returns the list of ids of the contacts that the backend should retrieve.

See also setLocalIds().

void QContactFetchByIdRequest::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 QContactFetchByIdRequest::setLocalIds ( const QList<QContactLocalId> & localIds )

Sets the list of ids of the contacts that the backend should retrieve to localIds.

See also localIds().

Contents