libsignon-plugins-doc 8.59-1 / usr / share / doc / signon-plugins / html / classAuthPluginInterface.html

This file is indexed.

/usr/share/doc/signon-plugins/html/classAuthPluginInterface.html is in libsignon-plugins-doc 8.59-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AuthPluginInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classAuthPluginInterface.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#signals">Signals</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classAuthPluginInterface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AuthPluginInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for AuthPluginInterface:</div>
<div class="dyncontent">
<div class="center"><img src="classAuthPluginInterface__inherit__graph.png" border="0" usemap="#AuthPluginInterface_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface_1_1Interface.html">Interface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">authentication plugins  <a href="classAuthPluginInterface_1_1Interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:a38d52b25a1ddb49073a8323357d9254c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a38d52b25a1ddb49073a8323357d9254c">userActionFinished</a> (const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;data)</td></tr>
<tr class="memdesc:a38d52b25a1ddb49073a8323357d9254c"><td class="mdescLeft">&#160;</td><td class="mdescRight">User interaction completed.  <a href="#a38d52b25a1ddb49073a8323357d9254c">More...</a><br /></td></tr>
<tr class="separator:a38d52b25a1ddb49073a8323357d9254c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08d075a313ab6e42a2d0db9a94c50d8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#ad08d075a313ab6e42a2d0db9a94c50d8">refresh</a> (const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;data)</td></tr>
<tr class="memdesc:ad08d075a313ab6e42a2d0db9a94c50d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refreshes given session.  <a href="#ad08d075a313ab6e42a2d0db9a94c50d8">More...</a><br /></td></tr>
<tr class="separator:ad08d075a313ab6e42a2d0db9a94c50d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:aa0fa3f3e22aa8cb0ef9cff05c0631c4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#aa0fa3f3e22aa8cb0ef9cff05c0631c4d">result</a> (const SignOn::SessionData &amp;data)</td></tr>
<tr class="memdesc:aa0fa3f3e22aa8cb0ef9cff05c0631c4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted when authentication process has been completed for given data and there are no errors.  <a href="#aa0fa3f3e22aa8cb0ef9cff05c0631c4d">More...</a><br /></td></tr>
<tr class="separator:aa0fa3f3e22aa8cb0ef9cff05c0631c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af78aec5d9005e6c76bbcaabf8fdf053e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#af78aec5d9005e6c76bbcaabf8fdf053e">store</a> (const SignOn::SessionData &amp;data)</td></tr>
<tr class="memdesc:af78aec5d9005e6c76bbcaabf8fdf053e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted when authentication process want to store session data parameters for later use.  <a href="#af78aec5d9005e6c76bbcaabf8fdf053e">More...</a><br /></td></tr>
<tr class="separator:af78aec5d9005e6c76bbcaabf8fdf053e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d98544136d74f2f7ccdebde0db21804"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a4d98544136d74f2f7ccdebde0db21804">error</a> (const SignOn::Error &amp;err)</td></tr>
<tr class="memdesc:a4d98544136d74f2f7ccdebde0db21804"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted when authentication process has been completed for given data and resulting an error.  <a href="#a4d98544136d74f2f7ccdebde0db21804">More...</a><br /></td></tr>
<tr class="separator:a4d98544136d74f2f7ccdebde0db21804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0f651b66b203fbcda27cd7c2dde661c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#ad0f651b66b203fbcda27cd7c2dde661c">userActionRequired</a> (const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;data)</td></tr>
<tr class="memdesc:ad0f651b66b203fbcda27cd7c2dde661c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted when authentication process need to interact with user.  <a href="#ad0f651b66b203fbcda27cd7c2dde661c">More...</a><br /></td></tr>
<tr class="separator:ad0f651b66b203fbcda27cd7c2dde661c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cf8f6161e70145ba6faaa3ec0d1cceb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb">refreshed</a> (const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;data)</td></tr>
<tr class="memdesc:a2cf8f6161e70145ba6faaa3ec0d1cceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted when authentication process has completed refresh request.  <a href="#a2cf8f6161e70145ba6faaa3ec0d1cceb">More...</a><br /></td></tr>
<tr class="separator:a2cf8f6161e70145ba6faaa3ec0d1cceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eb3fe38383037c0bf23d935009cc2f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a2eb3fe38383037c0bf23d935009cc2f5">statusChanged</a> (const AuthPluginState state, const QString &amp;message=QString())</td></tr>
<tr class="memdesc:a2eb3fe38383037c0bf23d935009cc2f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitted to report status of authentication process to signond for informing client application.  <a href="#a2eb3fe38383037c0bf23d935009cc2f5">More...</a><br /></td></tr>
<tr class="separator:a2eb3fe38383037c0bf23d935009cc2f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a425f68f11ab1eabac0337771e31b26c1"><td class="memItemLeft" align="right" valign="top"><a id="a425f68f11ab1eabac0337771e31b26c1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>AuthPluginInterface</b> (QObject *parent=0)</td></tr>
<tr class="separator:a425f68f11ab1eabac0337771e31b26c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a559163c8ca8b04214faacc3553a922ba"><td class="memItemLeft" align="right" valign="top"><a id="a559163c8ca8b04214faacc3553a922ba"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a559163c8ca8b04214faacc3553a922ba">~AuthPluginInterface</a> ()</td></tr>
<tr class="memdesc:a559163c8ca8b04214faacc3553a922ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a559163c8ca8b04214faacc3553a922ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ed54cd7b060feeddf7f6fb65ec2e508"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a3ed54cd7b060feeddf7f6fb65ec2e508">type</a> () const =0</td></tr>
<tr class="memdesc:a3ed54cd7b060feeddf7f6fb65ec2e508"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the type of the plugin.  <a href="#a3ed54cd7b060feeddf7f6fb65ec2e508">More...</a><br /></td></tr>
<tr class="separator:a3ed54cd7b060feeddf7f6fb65ec2e508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ce5d0e525530d0bac81ad6d28a6d2ba"><td class="memItemLeft" align="right" valign="top">virtual QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a2ce5d0e525530d0bac81ad6d28a6d2ba">mechanisms</a> () const =0</td></tr>
<tr class="memdesc:a2ce5d0e525530d0bac81ad6d28a6d2ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the list of supported mechanisms.  <a href="#a2ce5d0e525530d0bac81ad6d28a6d2ba">More...</a><br /></td></tr>
<tr class="separator:a2ce5d0e525530d0bac81ad6d28a6d2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa47f7a2c7352955044d059ff89c1a6db"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#aa47f7a2c7352955044d059ff89c1a6db">cancel</a> ()</td></tr>
<tr class="memdesc:aa47f7a2c7352955044d059ff89c1a6db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests to cancel the process.  <a href="#aa47f7a2c7352955044d059ff89c1a6db">More...</a><br /></td></tr>
<tr class="separator:aa47f7a2c7352955044d059ff89c1a6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f64a141e8fefa7dca002365d14f1942"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a6f64a141e8fefa7dca002365d14f1942">abort</a> ()</td></tr>
<tr class="memdesc:a6f64a141e8fefa7dca002365d14f1942"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests to abort the process.  <a href="#a6f64a141e8fefa7dca002365d14f1942">More...</a><br /></td></tr>
<tr class="separator:a6f64a141e8fefa7dca002365d14f1942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e0a6d3ee26c3e169c439618a058c612"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAuthPluginInterface.html#a4e0a6d3ee26c3e169c439618a058c612">process</a> (const SignOn::SessionData &amp;inData, const QString &amp;mechanism=QString())=0</td></tr>
<tr class="memdesc:a4e0a6d3ee26c3e169c439618a058c612"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process authentication.  <a href="#a4e0a6d3ee26c3e169c439618a058c612">More...</a><br /></td></tr>
<tr class="separator:a4e0a6d3ee26c3e169c439618a058c612"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="authpluginif_8h_source.html#l00083">83</a> of file <a class="el" href="authpluginif_8h_source.html">authpluginif.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6f64a141e8fefa7dca002365d14f1942"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f64a141e8fefa7dca002365d14f1942">&sect;&nbsp;</a></span>abort()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AuthPluginInterface::abort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Requests to abort the process. </p>
<p>Process is terminated after this call. Reimplement this in order to execute specific instructions before process is killed. </p>

<p>Definition at line <a class="el" href="authpluginif_8h_source.html#l00124">124</a> of file <a class="el" href="authpluginif_8h_source.html">authpluginif.h</a>.</p>

<p>References <a class="el" href="classAuthPluginInterface.html#a4d98544136d74f2f7ccdebde0db21804">error()</a>, <a class="el" href="classAuthPluginInterface.html#a4e0a6d3ee26c3e169c439618a058c612">process()</a>, <a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb">refreshed()</a>, <a class="el" href="classAuthPluginInterface.html#aa0fa3f3e22aa8cb0ef9cff05c0631c4d">result()</a>, <a class="el" href="classAuthPluginInterface.html#a2eb3fe38383037c0bf23d935009cc2f5">statusChanged()</a>, <a class="el" href="classAuthPluginInterface.html#af78aec5d9005e6c76bbcaabf8fdf053e">store()</a>, and <a class="el" href="classAuthPluginInterface.html#ad0f651b66b203fbcda27cd7c2dde661c">userActionRequired()</a>.</p>

</div>
</div>
<a id="aa47f7a2c7352955044d059ff89c1a6db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa47f7a2c7352955044d059ff89c1a6db">&sect;&nbsp;</a></span>cancel()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AuthPluginInterface::cancel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Requests to cancel the process. </p>
<p>Process is terminated after this call. Reimplement this in order to execute specific instructions before the effective cancel occurres. </p>

<p>Definition at line <a class="el" href="authpluginif_8h_source.html#l00116">116</a> of file <a class="el" href="authpluginif_8h_source.html">authpluginif.h</a>.</p>

</div>
</div>
<a id="a4d98544136d74f2f7ccdebde0db21804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d98544136d74f2f7ccdebde0db21804">&sect;&nbsp;</a></span>error</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::error </td>
          <td>(</td>
          <td class="paramtype">const SignOn::Error &amp;&#160;</td>
          <td class="paramname"><em>err</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted when authentication process has been completed for given data and resulting an error. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err</td><td>The error object </td></tr>
    <tr><td class="paramname">errorMessage</td><td>Resulting error message </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<a id="a2ce5d0e525530d0bac81ad6d28a6d2ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ce5d0e525530d0bac81ad6d28a6d2ba">&sect;&nbsp;</a></span>mechanisms()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual QStringList AuthPluginInterface::mechanisms </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the list of supported mechanisms. </p>
<dl class="section return"><dt>Returns</dt><dd>List of mechanisms </dd></dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00094">~AuthPluginInterface()</a>.</p>

</div>
</div>
<a id="a4e0a6d3ee26c3e169c439618a058c612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e0a6d3ee26c3e169c439618a058c612">&sect;&nbsp;</a></span>process()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AuthPluginInterface::process </td>
          <td>(</td>
          <td class="paramtype">const SignOn::SessionData &amp;&#160;</td>
          <td class="paramname"><em>inData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>mechanism</em> = <code>QString()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Process authentication. </p>
<p>Authentication can be logging to a server, obtain token(s) from a server, calculate response using given challenge, etc. Given session data is used to do authentication and return response. Signal <a class="el" href="classAuthPluginInterface.html#aa0fa3f3e22aa8cb0ef9cff05c0631c4d" title="Emitted when authentication process has been completed for given data and there are no errors...">result()</a> is emitted when authentication is completed, or signal <a class="el" href="classAuthPluginInterface.html#a4d98544136d74f2f7ccdebde0db21804" title="Emitted when authentication process has been completed for given data and resulting an error...">error()</a> if authentication failed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classAuthPluginInterface.html#aa0fa3f3e22aa8cb0ef9cff05c0631c4d" title="Emitted when authentication process has been completed for given data and there are no errors...">result</a> </dd>
<dd>
<a class="el" href="classAuthPluginInterface.html#a4d98544136d74f2f7ccdebde0db21804" title="Emitted when authentication process has been completed for given data and resulting an error...">error</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inData</td><td>Input data for authentication </td></tr>
    <tr><td class="paramname">mechanism</td><td>Mechanism to use to do authentication </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<a id="ad08d075a313ab6e42a2d0db9a94c50d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad08d075a313ab6e42a2d0db9a94c50d8">&sect;&nbsp;</a></span>refresh</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AuthPluginInterface::refresh </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">slot</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Refreshes given session. </p>
<p>Signond uses this slot to refresh data in given ui session. Mostly used to refresh a captcha images during the user interaction. Signal <a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb" title="Emitted when authentication process has completed refresh request. ">refreshed()</a> or <a class="el" href="classAuthPluginInterface.html#a4d98544136d74f2f7ccdebde0db21804" title="Emitted when authentication process has been completed for given data and resulting an error...">error()</a> must be emitted when refresh is completed. This must be reimplemented to refresh the captcha image. </p><dl class="section see"><dt>See also</dt><dd>UiSessionData </dd>
<dd>
<a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb" title="Emitted when authentication process has completed refresh request. ">refreshed</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>emitting signal <a class="el" href="classAuthPluginInterface.html#ad0f651b66b203fbcda27cd7c2dde661c" title="Emitted when authentication process need to interact with user. ">userActionRequired()</a> is not allowed to use before ui session is finished.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Ui session data to be refreshed </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="authpluginif_8h_source.html#l00232">232</a> of file <a class="el" href="authpluginif_8h_source.html">authpluginif.h</a>.</p>

<p>References <a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb">refreshed()</a>.</p>

</div>
</div>
<a id="a2cf8f6161e70145ba6faaa3ec0d1cceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cf8f6161e70145ba6faaa3ec0d1cceb">&sect;&nbsp;</a></span>refreshed</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::refreshed </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted when authentication process has completed refresh request. </p>
<p>Plugin must emit signal <a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb" title="Emitted when authentication process has completed refresh request. ">refreshed()</a> to response to <a class="el" href="classAuthPluginInterface.html#ad08d075a313ab6e42a2d0db9a94c50d8" title="Refreshes given session. ">refresh()</a> call. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classAuthPluginInterface.html#a2cf8f6161e70145ba6faaa3ec0d1cceb" title="Emitted when authentication process has completed refresh request. ">refreshed</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Refreshed ui session data </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>, and <a class="el" href="authpluginif_8h_source.html#l00232">refresh()</a>.</p>

</div>
</div>
<a id="aa0fa3f3e22aa8cb0ef9cff05c0631c4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0fa3f3e22aa8cb0ef9cff05c0631c4d">&sect;&nbsp;</a></span>result</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::result </td>
          <td>(</td>
          <td class="paramtype">const SignOn::SessionData &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted when authentication process has been completed for given data and there are no errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Resulting SessionData, need to be returned to client </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<a id="a2eb3fe38383037c0bf23d935009cc2f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eb3fe38383037c0bf23d935009cc2f5">&sect;&nbsp;</a></span>statusChanged</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::statusChanged </td>
          <td>(</td>
          <td class="paramtype">const AuthPluginState&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>message</em> = <code>QString()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted to report status of authentication process to signond for informing client application. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>Plugin process state </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>AuthPluginState </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">message</td><td>Optional message for client application </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<a id="af78aec5d9005e6c76bbcaabf8fdf053e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af78aec5d9005e6c76bbcaabf8fdf053e">&sect;&nbsp;</a></span>store</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::store </td>
          <td>(</td>
          <td class="paramtype">const SignOn::SessionData &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted when authentication process want to store session data parameters for later use. </p>
<p>Stored parameters are added into SessionData in following process calls. This is useful when authentication is using permanent tokens.</p>
<dl class="section note"><dt>Note</dt><dd>This is shared within same identity using same method only. </dd>
<dd>
There can be storage size limitation for data that can be stored.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Resulting SessionData, need to be returned to client </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<a id="a3ed54cd7b060feeddf7f6fb65ec2e508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ed54cd7b060feeddf7f6fb65ec2e508">&sect;&nbsp;</a></span>type()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual QString AuthPluginInterface::type </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the type of the plugin. </p>
<dl class="section return"><dt>Returns</dt><dd>Plugin type </dd></dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00094">~AuthPluginInterface()</a>.</p>

</div>
</div>
<a id="a38d52b25a1ddb49073a8323357d9254c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38d52b25a1ddb49073a8323357d9254c">&sect;&nbsp;</a></span>userActionFinished</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AuthPluginInterface::userActionFinished </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">slot</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>User interaction completed. </p>
<p>Signond uses this slot to notice the end of ui session. This is a response to <a class="el" href="classAuthPluginInterface.html#ad0f651b66b203fbcda27cd7c2dde661c" title="Emitted when authentication process need to interact with user. ">userActionRequired()</a> signal. This must be reimplemented to get the response from the user interaction. </p><dl class="section see"><dt>See also</dt><dd>UiSessionData </dd>
<dd>
<a class="el" href="classAuthPluginInterface.html#ad0f651b66b203fbcda27cd7c2dde661c" title="Emitted when authentication process need to interact with user. ">userActionRequired</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>User completed ui session data </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="authpluginif_8h_source.html#l00216">216</a> of file <a class="el" href="authpluginif_8h_source.html">authpluginif.h</a>.</p>

</div>
</div>
<a id="ad0f651b66b203fbcda27cd7c2dde661c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0f651b66b203fbcda27cd7c2dde661c">&sect;&nbsp;</a></span>userActionRequired</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void AuthPluginInterface::userActionRequired </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classSignOn_1_1UiSessionData.html">SignOn::UiSessionData</a> &amp;&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emitted when authentication process need to interact with user. </p>
<p>Basic use cases are: query password, verify captcha, show url. Can also be used to get username/password for proxy authentication etc. Slot <a class="el" href="classAuthPluginInterface.html#a38d52b25a1ddb49073a8323357d9254c" title="User interaction completed. ">userActionFinished()</a> is called when interaction is completed.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAuthPluginInterface.html#a38d52b25a1ddb49073a8323357d9254c" title="User interaction completed. ">userActionFinished</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1UiSessionData.html" title="Data container to hold values for authentication session. ">SignOn::UiSessionData</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>slot <a class="el" href="classAuthPluginInterface.html#a38d52b25a1ddb49073a8323357d9254c" title="User interaction completed. ">userActionFinished()</a> should be reimplemented to get result.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>Ui session data to be filled within user interaction </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="authpluginif_8h_source.html#l00124">abort()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>SignOn/<a class="el" href="authpluginif_8h_source.html">authpluginif.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classAuthPluginInterface.html">AuthPluginInterface</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
  </ul>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.