MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9
QtMobility Reference Documentation

Contents

QContactRelationshipFetchRequest Class Reference

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

 #include <QContactRelationshipFetchRequest>

Inherits: QContactAbstractRequest.

This class was introduced in Qt Mobility 1.0.

Public Functions

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

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

QContactId QContactRelationshipFetchRequest::first () const

Returns the source contact criterion of the fetch request

This function was introduced in Qt Mobility 1.0.

See also setFirst().

QString QContactRelationshipFetchRequest::relationshipType () const

Returns the relationship type criterion of the fetch request

This function was introduced in Qt Mobility 1.0.

See also setRelationshipType().

QList<QContactRelationship> QContactRelationshipFetchRequest::relationships () const

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

This function was introduced in Qt Mobility 1.0.

QContactId QContactRelationshipFetchRequest::second () const

Returns the destination contact criterion of the fetch request

This function was introduced in Qt Mobility 1.0.

See also setSecond().

void QContactRelationshipFetchRequest::setFirst ( const QContactId & firstId )

Sets the source contact criterion of the fetch request to firstId. If firstId is the default-constructed id, or the first contact id is not set, the request will fetch relationships involving any first contact.

This function was introduced in Qt Mobility 1.0.

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.

This function was introduced in Qt Mobility 1.0.

See also relationshipType().

void QContactRelationshipFetchRequest::setSecond ( const QContactId & secondId )

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

This function was introduced in Qt Mobility 1.0.

See also second().

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.