Home · All Classes · All Functions ·

QContactRelationshipFetchRequest Class Reference

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

    #include <QContactRelationshipFetchRequest>

Inherits QContactAbstractRequest.


Public Functions

QContactRelationshipFetchRequest ()
~QContactRelationshipFetchRequest ()
QContactId first () const
QContactId participant () const
QContactRelationshipFilter::Role participantRole () const
QString relationshipType () const
QList<QContactRelationship> relationships () const
void setFirst ( const QContactId & contactId )
void setParticipant ( const QContactId & participantUri, QContactRelationshipFilter::Role role = QContactRelationshipFilter::Either )
void setRelationshipType ( const QString & relationshipType )

Signals

void progress ( QContactRelationshipFetchRequest * self, bool appendOnly )

Additional Inherited Members


Detailed Description

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


Member Function Documentation

QContactRelationshipFetchRequest::QContactRelationshipFetchRequest ()

Constructs a new relationship fetch request

QContactRelationshipFetchRequest::~QContactRelationshipFetchRequest ()

Cleans up the memory in use by this relationship fetch request

QContactId QContactRelationshipFetchRequest::first () const

Returns the source contact criterion of the fetch request

See also setFirst().

QContactId QContactRelationshipFetchRequest::participant () const

Returns the participant criterion of the fetch request

See also setParticipant().

QContactRelationshipFilter::Role QContactRelationshipFetchRequest::participantRole () const

Returns the role of the participant criterion of the fetch request

void QContactRelationshipFetchRequest::progress ( QContactRelationshipFetchRequest * self, bool appendOnly )   [signal]

This signal is emitted when some progress has been made on the request, causing either a change of status or an update of results, or both. It identifies which request the signal originated from by including a pointer to self, and contains an appendOnly flag which signifies whether or not the total ordering of the results have been maintained since the last progress signal was emitted.

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

void QContactRelationshipFetchRequest::setFirst ( const QContactId & contactId )

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

See also first().

void QContactRelationshipFetchRequest::setParticipant ( const QContactId & participantUri, QContactRelationshipFilter::Role role = QContactRelationshipFilter::Either )

Sets the participant criterion of the fetch request to participantUri. If the participantUri references a contact in the manager from which the relationships are being fetched and the role is QContactRelationshipFilter::Either, a relationship will match the criterion if the contact appears in the relationship as either the source or a destination contact. If the participantUri references a contact in a different manager to the one from which the relationships are being fetched and the role is QContactRelationshipFilter::Either, a relationship will match the criterion only if the contact appears in the relationship as a destination contact. If the participantUri references a contact in a different manager to the one from which the relationships are being fetched and the role is QContactRelationshipFilter::Source, no relationships will be fetched.

If the participantUri consists of an empty manager URI and the zero contact id, or if the participant criterion is not set, the request will fetch relationships involving any participant.

See also participant().

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().


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0 (Technical Preview)