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 "qcontactremoverequest.h"
35
36#include "qcontactrequests_p.h"
37
38QT_BEGIN_NAMESPACE_CONTACTS
39
40/*!
41 \class QContactRemoveRequest
42 \brief The QContactRemoveRequest class allows a client to asynchronously
43 request that certain contacts be removed from a contacts store.
44
45 For a QContactRemoveRequest, the resultsUpdated() signal will be emitted when
46 the individual item errors (which may be retrieved by calling errorMap()) are updated, or if the overall
47 operation error (which may be retrieved by calling error()) is updated.
48
49 Please see the class documentation of QContactAbstractRequest for more information about
50 the usage of request classes and ownership semantics.
51
52
53 \inmodule QtContacts
54
55 \ingroup contacts-requests
56 */
57
58/*! Constructs a new contact remove request whose parent is the specified \a parent */
59QContactRemoveRequest::QContactRemoveRequest(QObject* parent)
60 : QContactAbstractRequest(new QContactRemoveRequestPrivate, parent)
61{
62}
63
64/*! Frees any memory used by this request */
65QContactRemoveRequest::~QContactRemoveRequest()
66{
67}
68
69/*!
70 Sets the id of the contact which will be removed to \a contactId.
71 Equivalent to calling:
72 \code
73 setContactIds(QList<QContactId>() << contactIds);
74 \endcode
75 */
76void QContactRemoveRequest::setContactId(const QContactId& contactId)
77{
78 Q_D(QContactRemoveRequest);
79 QMutexLocker ml(&d->m_mutex);
80 d->m_contactIds.clear();
81 d->m_contactIds.append(t: contactId);
82}
83
84/*! Sets the list of ids of contacts which will be removed to \a contactIds
85*/
86void QContactRemoveRequest::setContactIds(const QList<QContactId>& contactIds)
87{
88 Q_D(QContactRemoveRequest);
89 QMutexLocker ml(&d->m_mutex);
90 d->m_contactIds = contactIds;
91}
92
93/*! Returns the list of ids of contacts which will be removed
94*/
95QList<QContactId> QContactRemoveRequest::contactIds() const
96{
97 Q_D(const QContactRemoveRequest);
98 QMutexLocker ml(&d->m_mutex);
99 return d->m_contactIds;
100}
101
102/*! Returns the map of input contact list indices to errors which occurred
103*/
104QMap<int, QContactManager::Error> QContactRemoveRequest::errorMap() const
105{
106 Q_D(const QContactRemoveRequest);
107 QMutexLocker ml(&d->m_mutex);
108 return d->m_errors;
109}
110
111#include "moc_qcontactremoverequest.cpp"
112
113QT_END_NAMESPACE_CONTACTS
114

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