1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtContacts module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#include "qcontactfetchrequest.h"
35
36#include "qcontactrequests_p.h"
37
38QT_BEGIN_NAMESPACE_CONTACTS
39
40/*!
41 \class QContactFetchRequest
42 \brief The QContactFetchRequest class allows a client to asynchronously
43 request contacts from a contacts store manager.
44
45
46 For a QContactFetchRequest, the resultsAvailable() signal will be emitted when the resultant
47 contacts (which may be retrieved by calling contacts()), are updated, as well as if
48 the overall operation error (which may be retrieved by calling error()) is updated.
49
50 Please see the class documentation of QContactAbstractRequest for more information about
51 the usage of request classes and ownership semantics.
52
53
54 \inmodule QtContacts
55
56 \ingroup contacts-requests
57 */
58
59/*! Constructs a new contact fetch request whose parent is the specified \a parent */
60QContactFetchRequest::QContactFetchRequest(QObject* parent)
61 : QContactAbstractRequest(new QContactFetchRequestPrivate, parent)
62{
63}
64
65/*! Frees any memory used by this request */
66QContactFetchRequest::~QContactFetchRequest()
67{
68}
69
70/*!
71 Sets the contact filter used to determine which contacts will be retrieved to \a filter.
72*/
73void QContactFetchRequest::setFilter(const QContactFilter& filter)
74{
75 Q_D(QContactFetchRequest);
76 QMutexLocker ml(&d->m_mutex);
77 d->m_filter = filter;
78}
79
80/*! Sets the sort order of the result to \a sorting. Only has an effect if called prior to calling \c start()
81*/
82void QContactFetchRequest::setSorting(const QList<QContactSortOrder>& sorting)
83{
84 Q_D(QContactFetchRequest);
85 QMutexLocker ml(&d->m_mutex);
86 d->m_sorting = sorting;
87}
88
89/*!
90 Sets the fetch hint which may be used by the backend to optimize contact retrieval
91 to \a fetchHint. A client should not make changes to a contact which has been retrieved
92 using a fetch hint other than the default fetch hint. Doing so will result in information
93 loss when saving the contact back to the manager (as the "new" restricted contact will
94 replace the previously saved contact in the backend).
95 \sa QContactFetchHint
96 */
97void QContactFetchRequest::setFetchHint(const QContactFetchHint &fetchHint)
98{
99 Q_D(QContactFetchRequest);
100 QMutexLocker ml(&d->m_mutex);
101 d->m_fetchHint = fetchHint;
102}
103
104/*! Returns the filter that will be used to select contacts to be returned
105*/
106QContactFilter QContactFetchRequest::filter() const
107{
108 Q_D(const QContactFetchRequest);
109 QMutexLocker ml(&d->m_mutex);
110 return d->m_filter;
111}
112
113/*! Returns the sort ordering that will be used sort the results of this request
114*/
115QList<QContactSortOrder> QContactFetchRequest::sorting() const
116{
117 Q_D(const QContactFetchRequest);
118 QMutexLocker ml(&d->m_mutex);
119 return d->m_sorting;
120}
121
122/*!
123 Returns the fetch hint which may be used by the backend to optimize contact retrieval.
124 A client should not make changes to a contact which has been retrieved
125 using a fetch hint other than the default fetch hint. Doing so will result in information
126 loss when saving the contact back to the manager (as the "new" restricted contact will
127 replace the previously saved contact in the backend).
128 \sa QContactFetchHint
129 */
130QContactFetchHint QContactFetchRequest::fetchHint() const
131{
132 Q_D(const QContactFetchRequest);
133 QMutexLocker ml(&d->m_mutex);
134 return d->m_fetchHint;
135}
136
137/*! Returns the list of contacts retrieved by this request
138*/
139QList<QContact> QContactFetchRequest::contacts() const
140{
141 Q_D(const QContactFetchRequest);
142 QMutexLocker ml(&d->m_mutex);
143 return d->m_contacts;
144}
145
146#include "moc_qcontactfetchrequest.cpp"
147
148QT_END_NAMESPACE_CONTACTS
149

source code of qtpim/src/contacts/requests/qcontactfetchrequest.cpp