QContactRelationshipFetchRequest Class

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

Header: #include <QContactRelationshipFetchRequest>
Inherits: QContactAbstractRequest.

Public Functions

QContactRelationshipFetchRequest(QObject * parent = 0)
~QContactRelationshipFetchRequest()
QContact first() const
QString relationshipType() const
QList<QContactRelationship> relationships() const
QContact second() const
void setFirst(const QContact & firstContact)
void setRelationshipType(const QString & relationshipType)
void setSecond(const QContact & secondContact)

Additional Inherited Members

Detailed Description

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

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

QContactRelationshipFetchRequest::QContactRelationshipFetchRequest(QObject * parent = 0)

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

QContactRelationshipFetchRequest::~QContactRelationshipFetchRequest()

Frees any memory used by this request

QContact QContactRelationshipFetchRequest::first() const

Returns the source contact criterion of the fetch request

See also setFirst().

QString QContactRelationshipFetchRequest::relationshipType() const

Returns the relationship type criterion of the fetch request

See also setRelationshipType().

QList<QContactRelationship> QContactRelationshipFetchRequest::relationships() const

Returns the list of relationships that was the result of the request

QContact QContactRelationshipFetchRequest::second() const

Returns the destination contact criterion of the fetch request

See also setSecond().

void QContactRelationshipFetchRequest::setFirst(const QContact & firstContact)

Sets the source contact criterion of the fetch request to firstContact. If firstContact is empty, or the first contact is not set, the request will fetch relationships involving any first contact.

See also first().

void QContactRelationshipFetchRequest::setRelationshipType(const QString & relationshipType)

Sets the relationship type criterion of the fetch request to relationshipType. If relationshipType is empty, or the relationship type is not set, the request will fetch relationships of any type.

See also relationshipType().

void QContactRelationshipFetchRequest::setSecond(const QContact & secondContact)

Sets the destination contact criterion of the fetch request to secondContact. If secondContact is the default-constructed empty contact or the second contact is not set, the request will fetch relationships involving any second contact.

See also second().