1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*
* This file is part of TelepathyQt4
*
* Copyright (C) 2008 Collabora Ltd. <http://www.collabora.co.uk/>
* Copyright (C) 2008 Nokia Corporation
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <TelepathyQt4/PendingContactAttributes>
#include "TelepathyQt4/_gen/pending-contact-attributes.moc.hpp"
#include <TelepathyQt4/Connection>
#include <TelepathyQt4/ReferencedHandles>
#include "TelepathyQt4/debug-internal.h"
/**
* \addtogroup clientsideproxies Client-side proxies
*
* Proxy objects representing remote service objects accessed via D-Bus.
*
* In addition to providing direct access to methods, signals and properties
* exported by the remote objects, some of these proxies offer features like
* automatic inspection of remote object capabilities, property tracking,
* backwards compatibility helpers for older services and other utilities.
*/
/**
* \defgroup clientconn Connection proxies
* \ingroup clientsideproxies
*
* Proxy objects representing remote Telepathy Connections and their optional
* interfaces.
*/
namespace Tp
{
/**
* \class PendingContactAttributes
* \ingroup clientconn
* \headerfile <TelepathyQt4/pending-contact-attributes.h> <TelepathyQt4/PendingContactAttributes>
*
* Class containing the parameters of and the reply to an asynchronous request for raw contact
* attributes, as used in the Connection::contactAttributes() low-level convenience method
* wrapping the ConnectionInterfaceContactsInterface::GetContactAttributes() D-Bus method.
*/
struct TELEPATHY_QT4_NO_EXPORT PendingContactAttributes::Private
{
ConnectionPtr connection;
UIntList contactsRequested;
QStringList interfacesRequested;
bool shouldReference;
ReferencedHandles validHandles;
UIntList invalidHandles;
ContactAttributesMap attributes;
};
PendingContactAttributes::PendingContactAttributes(const ConnectionPtr &connection,
const UIntList &handles, const QStringList &interfaces, bool reference)
: PendingOperation(connection.data()),
mPriv(new Private)
{
debug() << "PendingContactAttributes()";
mPriv->connection = connection;
mPriv->contactsRequested = handles;
mPriv->interfacesRequested = interfaces;
mPriv->shouldReference = reference;
}
/**
* Class destructor.
*/
PendingContactAttributes::~PendingContactAttributes()
{
delete mPriv;
}
/**
* Returns the Connection object through which the request was made.
*
* \return Pointer to the Connection.
*/
ConnectionPtr PendingContactAttributes::connection() const
{
return mPriv->connection;
}
/**
* Returns the contacts for which attributes were requested.
*
* \return Reference to a list with the handles of the contacts.
*/
const UIntList &PendingContactAttributes::contactsRequested() const
{
return mPriv->contactsRequested;
}
/**
* Returns the interfaces the corresponding attributes of which were requested.
*
* \return Reference to a list of D-Bus interface names.
*/
const QStringList &PendingContactAttributes::interfacesRequested() const
{
return mPriv->interfacesRequested;
}
/**
* Returns whether it was requested that the contact handles should be referenced in addition to
* fetching their attributes. This corresponds to the <code>reference</code> argument to
* Connection::contactAttributes().
*
* \return Whether the handles should be referenced or not.
*/
bool PendingContactAttributes::shouldReference() const
{
return mPriv->shouldReference;
}
/**
* If referencing the handles was requested (as indicated by shouldReference()), returns the
* now-referenced handles resulting from the operation. If the operation has not (yet) finished
* successfully (isFinished() returns <code>false</code>), or referencing was not requested, the
* return value is undefined.
*
* Even if referencing was requested, the list will not always contain all of the handles in
* contactsRequested(), only the ones which were valid. The valid handles will be in the same order
* as in contactsRequested(), though.
*
* \return ReferencedHandles instance containing the handles.
*/
ReferencedHandles PendingContactAttributes::validHandles() const
{
if (!isFinished()) {
warning() << "PendingContactAttributes::validHandles() called before finished";
} else if (isError()) {
warning() << "PendingContactAttributes::validHandles() called when errored";
} else if (!shouldReference()) {
warning() << "PendingContactAttributes::validHandles() called but weren't asked to"
<< "reference handles";
}
return mPriv->validHandles;
}
/**
* Returns the handles which were found to be invalid while processing the operation. If the
* operation has not (yet) finished successfully (isFinished() returns <code>false</code>), the
* return value is undefined.
*
* \return A list with the invalid handles.
*/
UIntList PendingContactAttributes::invalidHandles() const
{
if (!isFinished()) {
warning() << "PendingContactAttributes::validHandles() called before finished";
} else if (isError()) {
warning() << "PendingContactAttributes::validHandles() called when errored";
}
return mPriv->invalidHandles;
}
/**
* Returns a dictionary mapping the valid contact handles in contactsRequested() (when also
* referencing, this means the contents of validHandles()) to contact attributes. If the operation
* has not (yet) finished successfully (isFinished() returns <code>false</code>), the return value
* is undefined.
*
* \return Mapping from handles to variant maps containing the attributes.
*/
ContactAttributesMap PendingContactAttributes::attributes() const
{
if (!isFinished()) {
warning() << "PendingContactAttributes::validHandles() called before finished";
} else if (isError()) {
warning() << "PendingContactAttributes::validHandles() called when errored";
}
return mPriv->attributes;
}
void PendingContactAttributes::onCallFinished(QDBusPendingCallWatcher* watcher)
{
QDBusPendingReply<ContactAttributesMap> reply = *watcher;
debug() << "Received reply to GetContactAttributes";
if (reply.isError()) {
debug().nospace() << " Failure: error " << reply.error().name() << ": " << reply.error().message();
setFinishedWithError(reply.error());
} else {
mPriv->attributes = reply.value();
UIntList validHandles;
foreach (uint contact, mPriv->contactsRequested) {
if (mPriv->attributes.contains(contact)) {
validHandles << contact;
} else {
mPriv->invalidHandles << contact;
}
}
if (shouldReference()) {
mPriv->validHandles = ReferencedHandles(mPriv->connection, HandleTypeContact,
validHandles);
}
debug() << " Success:" << validHandles.size() << "valid and" << mPriv->invalidHandles.size()
<< "invalid handles";
setFinished();
}
mPriv->connection->handleRequestLanded(HandleTypeContact);
watcher->deleteLater();
}
void PendingContactAttributes::failImmediately(const QString &error, const QString &errorMessage)
{
setFinishedWithError(error, errorMessage);
}
} // Tp
|
