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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KAuth.ActionReply</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>ActionReply Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Namespace: <a href="../kdecore/KAuth.html">KAuth</a><br />
<h2>Detailed Description</h2>
<p>Class that encapsulates a reply coming from the helper after executing an action
</p>
<p>
An instance of ActionReply is returned every time you execute an action with the Action
class. You get the reply directly from the Action.execute() method or indirectly as
a parameter of the ActionWatcher.actionPerformed() signal.
</p>
<p>
ActionReply objects can contain both data from a successful action or an error indicator.
In case of success, the errorCode() is ActionReply.NoError (zero) and the type() is
ActionReply.Success. The data() method returns a QVariantMap object that may contain
custom data sent back by the helper.
</p>
<p>
In case of errors coming from the library, the type() is ActionReply.KAuthError. In this
case, errorCode() will always be one of the predefined errors from the ActionReply.Error enum.
An error reply of KAuthError type always contains an empty data() object. For some kind of errors
you could get a human-readable description with errorDescription().
</p>
<p>
If, instead, the helper itself has to report some errors occurred during the action execution,
the type() will be (and has to be) ActionReply.HelperError. In this case the data() object can
contain custom data from the helper, and the errorCode() and errorDescription() values are
application-dependent.
</p>
<p>
In the helper, to create an action reply object you have two choices: using the constructor, or
the predefined replies. For example, to create a successful reply you can use the default constructor
but to create a helper error reply, instead of writing <i>ActionReply(ActionReply.HelperError)</i>
you could use the more convenient <i>ActionReply.HelperErrorReply</i> constant.
</p>
<p>
You should not use the predefined error replies to create and return new errors. Replies with the
KAuthError type are intended to be returned by the library only. However, you can use them for
comparisons.
</p>
<p>
To quickly check for success or failure of an action, you can use succeeded() or failed().
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Error">Error</a> </td><td class="memItemRight" valign="bottom">{ NoError, NoResponder, NoSuchAction, InvalidAction, AuthorizationDenied, UserCancelled, HelperBusy, DBusError }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Type">Type</a> </td><td class="memItemRight" valign="bottom">{ KAuthError, HelperError, Success }</td></tr>
<tr><td colspan="2"><br><h2>Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varAuthorizationDeniedReply">AuthorizationDeniedReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varDBusErrorReply">DBusErrorReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varHelperBusyReply">HelperBusyReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varHelperErrorReply">HelperErrorReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varInvalidActionReply">InvalidActionReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varNoResponderReply">NoResponderReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varNoSuchActionReply">NoSuchActionReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varSuccessReply">SuccessReply</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varUserCancelledReply">UserCancelledReply</a></td></tr><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ActionReply">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ActionReply">__init__</a> (self, <a href="../kdecore/KAuth.ActionReply.html#Type">KAuth.ActionReply.Type</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ActionReply">__init__</a> (self, <a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> reply)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addData">addData</a> (self, QString key, QVariant value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">{QString:QVariant} </td><td class="memItemRight" valign="bottom"><a class="el" href="#data">data</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorCode">errorCode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorDescription">errorDescription</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#failed">failed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator !=">operator !=</a> (self, <a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> reply)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> reply)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="#serialized">serialized</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, {QString:QVariant} data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setErrorCode">setErrorCode</a> (self, int errorCode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setErrorDescription">setErrorDescription</a> (self, QString error)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#succeeded">succeeded</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html#Type">KAuth.ActionReply.Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deserialize">deserialize</a> (QByteArray data)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="ActionReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="ActionReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAuth.ActionReply.html#Type">KAuth.ActionReply.Type</a> </td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor to directly set the type.
</p>
<p>
This constructor directly sets the reply type. You shouldn't need to
directly call this constructor, because you can use the more convenient
predefined replies constants. You also shouldn't create a reply with
the KAuthError type because it's reserved for errors coming from the
library.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>type</em> </td><td> The type of the new reply
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="ActionReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td>
<td class="paramname"><em>reply</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="addData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant </td>
<td class="paramname"><em>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Convenience method to add some data to the reply.
</p>
<p>
This method adds the pair key/value to the QVariantMap used to
report back custom data to the application.
</p>
<p>
Use this method if you don't want to create a new QVariantMap only to
add a new entry.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>key</em> </td><td> The new entry's key
<tr><td></td><td valign="top"><em>value</em> </td><td> The value of the new entry
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="data"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">{QString:QVariant} data</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the custom data coming from the helper.
</p>
<p>
This method is used to get the object that contains the custom
data coming from the helper. In the helper's code, you can set it
using setData() or the convenience method addData().
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The data coming from (or that will be sent by) the helper
</dd></dl>
</p></div></div><a class="anchor" name="errorCode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int errorCode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the error code of an error reply
</p>
<p>
The error code returned is one of the values in the ActionReply.Error
enumeration if type() == KAuthError, or is totally application-dependent if
type() == HelperError. It also should be zero for successful replies.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The reply error code
</dd></dl>
</p></div></div><a class="anchor" name="errorDescription"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString errorDescription</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Gets a human-readble description of the error, if available
</p>
<p>
Currently, replies of type KAuthError rarely report an error description.
This situation could change in the future.
</p>
<p>
By now, you can use this method for custom errors of type HelperError.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The error human-readable description
</dd></dl>
</p></div></div><a class="anchor" name="failed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool failed</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="operator !="></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool operator !=</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td>
<td class="paramname"><em>reply</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Negated comparison operator
</p>
<p>
See the operator==() for an important notice.
</p></div></div><a class="anchor" name="operator =="></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool operator ==</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> </td>
<td class="paramname"><em>reply</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Comparison operator
</p>
<p>
This operator checks if the type and the error code of two replies are the same.
It <b>doesn't</b> compare the data or the error descriptions, so be careful.
</p>
<p>
The suggested use it to compare a reply agains one of the predefined error replies:
<pre class="fragment">
if(reply == ActionReply.HelperBusyReply) {
// Do something...
}
</pre>
</p>
<p>
Note that you can do it also by compare errorCode() with the relative enumeration value.
</p></div></div><a class="anchor" name="serialized"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QByteArray serialized</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Serialize the reply into a QByteArray.
</p>
<p>
This is a convenience method used internally to sent the reply to a remote peer.
To recreate the reply, use deserialize()
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A QByteArray representation of this reply
</dd></dl>
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">{QString:QVariant} </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the custom data to send back to the application
</p>
<p>
In the helper's code you can use this function to set an QVariantMap
with custom data that will be sent back to the application.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>data</em> </td><td> The new QVariantMap object.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setErrorCode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setErrorCode</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>errorCode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the error code of an error reply
</p>
<p>
If you're setting the error code in the helper because
you need to return an error to the application, please make sure
you already have set the type to HelperError, either by calling
setType() or by creating the reply in the right way.
</p>
<p>
If the type is Success when you call this method, it will become KAuthError
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>errorCode</em> </td><td> The new reply error code
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setErrorDescription"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setErrorDescription</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>error</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets a human-readble description of the error
</p>
<p>
Call this method from the helper if you want to send back a description for
a custom error. Note that this method doesn't affect the errorCode in any way
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>error</em> </td><td> The new error description
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="succeeded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool succeeded</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="type"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KAuth.ActionReply.html#Type">KAuth.ActionReply.Type</a> type</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="deserialize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> deserialize</td>
<td>(</td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Deserialize a reply from a QByteArray
</p>
<p>
This method returns a reply from a QByteArray obtained from
the serialized() method.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>data</em> </td><td> A QByteArray obtained with serialized()
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Attribute Documentation</h2><a class="anchor" name="varAuthorizationDeniedReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> AuthorizationDeniedReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varDBusErrorReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> DBusErrorReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varHelperBusyReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> HelperBusyReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varHelperErrorReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> HelperErrorReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varInvalidActionReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> InvalidActionReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varNoResponderReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> NoResponderReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varNoSuchActionReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> NoSuchActionReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varSuccessReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> SuccessReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><a class="anchor" name="varUserCancelledReply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname"><a href="../kdecore/KAuth.ActionReply.html">KAuth.ActionReply</a> UserCancelledReply</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Error"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Error</td>
</tr>
</table>
</div>
<div class="memdoc"><p>The enumeration of the possible values of errorCode() when type() is ActionReply.KAuthError
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UnknownError</em> = 0</td><td><tr><td valign="top"><em>ConnectionRefusedError</em> </td><td><tr><td valign="top"><em>RemoteHostClosedError</em> </td><td><tr><td valign="top"><em>HostNotFoundError</em> </td><td><tr><td valign="top"><em>SocketAccessError</em> </td><td><tr><td valign="top"><em>SocketResourceError</em> </td><td><tr><td valign="top"><em>SocketTimeoutError</em> </td><td><tr><td valign="top"><em>NetworkError</em> </td><td><tr><td valign="top"><em>UnsupportedSocketOperationError</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="Type"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Type</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Enumeration of the different kinds of replies.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>String</em> = QVariant::String</td><td><tr><td valign="top"><em>DateTime</em> = QVariant::DateTime</td><td><tr><td valign="top"><em>Invalid</em> = QVariant::Invalid</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
