|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qcontactremoverequest.h" |
|
43 #include "qcontactrequests_p.h" |
|
44 |
|
45 QTM_BEGIN_NAMESPACE |
|
46 |
|
47 /*! |
|
48 \class QContactRemoveRequest |
|
49 \brief The QContactRemoveRequest class allows a client to asynchronously |
|
50 request that certain contacts be removed from a contacts store. |
|
51 |
|
52 For a QContactRemoveRequest, the resultsUpdated() signal will be emitted when |
|
53 the individual item errors (which may be retrieved by calling errorMap()) are updated, or if the overall |
|
54 operation error (which may be retrieved by calling error()) is updated. |
|
55 |
|
56 \ingroup contacts-requests |
|
57 */ |
|
58 |
|
59 /*! Constructs a new contact remove request */ |
|
60 QContactRemoveRequest::QContactRemoveRequest() |
|
61 : QContactAbstractRequest(new QContactRemoveRequestPrivate) |
|
62 { |
|
63 } |
|
64 |
|
65 /*! Cleans up the memory in use by the contact remove request */ |
|
66 QContactRemoveRequest::~QContactRemoveRequest() |
|
67 { |
|
68 } |
|
69 |
|
70 /*! |
|
71 \internal |
|
72 Sets the filter which will be used to select the contacts to remove to \a filter. |
|
73 This function is obsolete; set the list of contacts that will be removed by calling setContactIds(). |
|
74 */ |
|
75 void QContactRemoveRequest::setFilter(const QContactFilter& filter) |
|
76 { |
|
77 Q_D(QContactRemoveRequest); |
|
78 d->m_filter = filter; |
|
79 } |
|
80 |
|
81 /*! |
|
82 \internal |
|
83 Returns the filter which will be used to select the contacts to remove. |
|
84 This function is obsolete; retrieve the list of contacts that will be removed by calling contactIds(). |
|
85 */ |
|
86 QContactFilter QContactRemoveRequest::filter() const |
|
87 { |
|
88 Q_D(const QContactRemoveRequest); |
|
89 return d->m_filter; |
|
90 } |
|
91 |
|
92 |
|
93 /*! Sets the list of ids of contacts which will be removed to \a contactIds */ |
|
94 void QContactRemoveRequest::setContactIds(const QList<QContactLocalId>& contactIds) |
|
95 { |
|
96 Q_D(QContactRemoveRequest); |
|
97 d->m_contactIds = contactIds; |
|
98 } |
|
99 |
|
100 /*! Returns the list of ids of contacts which will be removed */ |
|
101 QList<QContactLocalId> QContactRemoveRequest::contactIds() const |
|
102 { |
|
103 Q_D(const QContactRemoveRequest); |
|
104 return d->m_contactIds; |
|
105 } |
|
106 |
|
107 /*! Returns the map of input contact list indices to errors which occurred */ |
|
108 QMap<int, QContactManager::Error> QContactRemoveRequest::errorMap() const |
|
109 { |
|
110 Q_D(const QContactRemoveRequest); |
|
111 return d->m_errors; |
|
112 } |
|
113 |
|
114 #include "moc_qcontactremoverequest.cpp" |
|
115 |
|
116 QTM_END_NAMESPACE |