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 "qcontactidfetchrequest.h"
35
36#include "qcontactrequests_p.h"
37
38QT_BEGIN_NAMESPACE_CONTACTS
39
40/*!
41 \class QContactIdFetchRequest
42 \brief The QContactIdFetchRequest class allows a client to asynchronously
43 request a list of contact ids from a contacts store manager.
44
45
46 For a QContactIdFetchRequest, the resultsAvailable() signal will be emitted when the resultant
47 contact ids (which may be retrieved by calling ids()), 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 id fetch request whose parent is the specified \a parent */
60QContactIdFetchRequest::QContactIdFetchRequest(QObject* parent)
61 : QContactAbstractRequest(new QContactIdFetchRequestPrivate, parent)
62{
63}
64
65/*! Frees any memory used by this request */
66QContactIdFetchRequest::~QContactIdFetchRequest()
67{
68}
69
70/*! Sets the filter which will be used to select the contacts whose ids will be returned to \a filter
71*/
72void QContactIdFetchRequest::setFilter(const QContactFilter& filter)
73{
74 Q_D(QContactIdFetchRequest);
75 QMutexLocker ml(&d->m_mutex);
76 d->m_filter = filter;
77}
78
79/*! Sets the future sort ordering of the result of the request to \a sorting. This function only has
80 effect on the result if called prior to calling \c start()
81*/
82void QContactIdFetchRequest::setSorting(const QList<QContactSortOrder>& sorting)
83{
84 Q_D(QContactIdFetchRequest);
85 QMutexLocker ml(&d->m_mutex);
86 d->m_sorting = sorting;
87}
88
89/*! Returns the filter which will be used to select the contacts whose ids will be returned
90*/
91QContactFilter QContactIdFetchRequest::filter() const
92{
93 Q_D(const QContactIdFetchRequest);
94 QMutexLocker ml(&d->m_mutex);
95 return d->m_filter;
96}
97
98/*! Returns the sort ordering which will be used to sort the result
99*/
100QList<QContactSortOrder> QContactIdFetchRequest::sorting() const
101{
102 Q_D(const QContactIdFetchRequest);
103 QMutexLocker ml(&d->m_mutex);
104 return d->m_sorting;
105}
106
107/*! Returns the list of ids of contacts which matched the request
108*/
109QList<QContactId> QContactIdFetchRequest::ids() const
110{
111 Q_D(const QContactIdFetchRequest);
112 QMutexLocker ml(&d->m_mutex);
113 return d->m_ids;
114}
115
116#include "moc_qcontactidfetchrequest.cpp"
117
118QT_END_NAMESPACE_CONTACTS
119

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