/usr/share/doc/libsignon-qt/html/classSignOn_1_1AuthService.html is in libsignon-qt-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 | <!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>SignOn::AuthService 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('classSignOn_1_1AuthService.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSignOn_1_1AuthService-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SignOn::AuthService Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents signon for client application.
<a href="classSignOn_1_1AuthService.html#details">More...</a></p>
<p><code>#include <<a class="el" href="authservice_8h_source.html">SignOn/AuthService</a>></code></p>
<div class="dynheader">
Inheritance diagram for SignOn::AuthService:</div>
<div class="dyncontent">
<div class="center"><img src="classSignOn_1_1AuthService__inherit__graph.png" border="0" usemap="#SignOn_1_1AuthService_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The class represents a regular expression. <a href="classSignOn_1_1AuthService_1_1IdentityRegExp.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a95926b7896f59c4b95dd0d761283e674"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674">ServiceError</a> { <br />
  <a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a061c94a1bda6a9dc52f3db06416f8ea4">UnknownError</a> = 1,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674ad9b74db38dcc0d46704ac1744ab5d376">InternalServerError</a> = 2,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a8ee12cca21786aef26458a5d97fa6443">InternalCommunicationError</a> = 3,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a7706acb68a8a28407081be4f95fb0fa7">PermissionDeniedError</a> = 4,
<br />
  <b>AuthServiceErr</b> = 100,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478">MethodNotKnownError</a>,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c">NotAvailableError</a>,
<a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a52d38ac87577622827a731c9df88b957">InvalidQueryError</a>
<br />
}<tr class="memdesc:a95926b7896f59c4b95dd0d761283e674"><td class="mdescLeft"> </td><td class="mdescRight">Codes for errors that may be reported by <a class="el" href="classSignOn_1_1AuthService.html" title="Represents signon for client application. ">AuthService</a> objects. <a href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a95926b7896f59c4b95dd0d761283e674"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9ac832e70cb6251375e9947d558d2b5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">IdentityFilterCriteria</a> { <b>AuthMethod</b> = 0,
<b>Username</b>,
<b>Realm</b>,
<b>Caption</b>
}<tr class="memdesc:ad9ac832e70cb6251375e9947d558d2b5"><td class="mdescLeft"> </td><td class="mdescRight">Criterias for idetity query filtering. <a href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ad9ac832e70cb6251375e9947d558d2b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3acba53f72b72ef9b08ea8a4d49dd344"><td class="memItemLeft" align="right" valign="top"><a id="a3acba53f72b72ef9b08ea8a4d49dd344"></a>
typedef QMap< <a class="el" href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">IdentityFilterCriteria</a>, <a class="el" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a></td></tr>
<tr class="memdesc:a3acba53f72b72ef9b08ea8a4d49dd344"><td class="mdescLeft"> </td><td class="mdescRight">Map to hold different filtering options. <br /></td></tr>
<tr class="separator:a3acba53f72b72ef9b08ea8a4d49dd344"><td class="memSeparator" colspan="2"> </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:aac62087bd1ba2f14a110c5e6198b72c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6">error</a> (const <a class="el" href="classSignOn_1_1Error.html">SignOn::Error</a> &err)</td></tr>
<tr class="memdesc:aac62087bd1ba2f14a110c5e6198b72c6"><td class="mdescLeft"> </td><td class="mdescRight">Emitted when an error occurs while using the <a class="el" href="classSignOn_1_1AuthService.html" title="Represents signon for client application. ">AuthService</a>. <a href="#aac62087bd1ba2f14a110c5e6198b72c6">More...</a><br /></td></tr>
<tr class="separator:aac62087bd1ba2f14a110c5e6198b72c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6c9693273b4548b7cc0c47a438c0c5c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#ac6c9693273b4548b7cc0c47a438c0c5c">methodsAvailable</a> (const QStringList &methods)</td></tr>
<tr class="memdesc:ac6c9693273b4548b7cc0c47a438c0c5c"><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the list of available authentication methods have been obtained from the service. <a href="#ac6c9693273b4548b7cc0c47a438c0c5c">More...</a><br /></td></tr>
<tr class="separator:ac6c9693273b4548b7cc0c47a438c0c5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a8d832cfa6556d5bfbb9ffb91b5745b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a9a8d832cfa6556d5bfbb9ffb91b5745b">mechanismsAvailable</a> (const QString &method, const QStringList &mechanisms)</td></tr>
<tr class="memdesc:a9a8d832cfa6556d5bfbb9ffb91b5745b"><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the list of available mechanisms have been obtained from the service. <a href="#a9a8d832cfa6556d5bfbb9ffb91b5745b">More...</a><br /></td></tr>
<tr class="separator:a9a8d832cfa6556d5bfbb9ffb91b5745b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5ea718192b2b64ae101d6786c36754f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#aa5ea718192b2b64ae101d6786c36754f">identities</a> (const QList< <a class="el" href="classSignOn_1_1IdentityInfo.html">SignOn::IdentityInfo</a> > &identityList)</td></tr>
<tr class="memdesc:aa5ea718192b2b64ae101d6786c36754f"><td class="mdescLeft"> </td><td class="mdescRight">Lists identities available on the server matching query parameters. <a href="#aa5ea718192b2b64ae101d6786c36754f">More...</a><br /></td></tr>
<tr class="separator:aa5ea718192b2b64ae101d6786c36754f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d8546a22f703cfd6cfa78f38fe5ffd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a8d8546a22f703cfd6cfa78f38fe5ffd0">cleared</a> ()</td></tr>
<tr class="memdesc:a8d8546a22f703cfd6cfa78f38fe5ffd0"><td class="mdescLeft"> </td><td class="mdescRight">Database is cleared and reset to initial state. <a href="#a8d8546a22f703cfd6cfa78f38fe5ffd0">More...</a><br /></td></tr>
<tr class="separator:a8d8546a22f703cfd6cfa78f38fe5ffd0"><td class="memSeparator" colspan="2"> </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:a748d77ab6c54eebc10fdc2b8eaea9d09"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a748d77ab6c54eebc10fdc2b8eaea9d09">AuthService</a> (QObject *parent=0)</td></tr>
<tr class="memdesc:a748d77ab6c54eebc10fdc2b8eaea9d09"><td class="mdescLeft"> </td><td class="mdescRight">Basic constructor. <a href="#a748d77ab6c54eebc10fdc2b8eaea9d09">More...</a><br /></td></tr>
<tr class="separator:a748d77ab6c54eebc10fdc2b8eaea9d09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ec8f4adfee773d7c87d3df313bdd8e2"><td class="memItemLeft" align="right" valign="top"><a id="a6ec8f4adfee773d7c87d3df313bdd8e2"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a6ec8f4adfee773d7c87d3df313bdd8e2">~AuthService</a> ()</td></tr>
<tr class="memdesc:a6ec8f4adfee773d7c87d3df313bdd8e2"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a6ec8f4adfee773d7c87d3df313bdd8e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42fc5513999da38613815e801b3e1565"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a42fc5513999da38613815e801b3e1565">queryMethods</a> ()</td></tr>
<tr class="memdesc:a42fc5513999da38613815e801b3e1565"><td class="mdescLeft"> </td><td class="mdescRight">Requests the information on available authentication methods. <a href="#a42fc5513999da38613815e801b3e1565">More...</a><br /></td></tr>
<tr class="separator:a42fc5513999da38613815e801b3e1565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8b2fc67f4309f88582e22116825b38a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#ac8b2fc67f4309f88582e22116825b38a">queryMechanisms</a> (const QString &method)</td></tr>
<tr class="memdesc:ac8b2fc67f4309f88582e22116825b38a"><td class="mdescLeft"> </td><td class="mdescRight">Requests the information on mechanisms which are available for certain authentication type. <a href="#ac8b2fc67f4309f88582e22116825b38a">More...</a><br /></td></tr>
<tr class="separator:ac8b2fc67f4309f88582e22116825b38a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7925066f708d4db50e0bbf8cdc527ba0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a7925066f708d4db50e0bbf8cdc527ba0">queryIdentities</a> (const <a class="el" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a> &filter=<a class="el" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a>())</td></tr>
<tr class="memdesc:a7925066f708d4db50e0bbf8cdc527ba0"><td class="mdescLeft"> </td><td class="mdescRight">Requests information on identities which are stored. <a href="#a7925066f708d4db50e0bbf8cdc527ba0">More...</a><br /></td></tr>
<tr class="separator:a7925066f708d4db50e0bbf8cdc527ba0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e4ae4f8b9ae3dadb188de6a8b618593"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSignOn_1_1AuthService.html#a6e4ae4f8b9ae3dadb188de6a8b618593">clear</a> ()</td></tr>
<tr class="memdesc:a6e4ae4f8b9ae3dadb188de6a8b618593"><td class="mdescLeft"> </td><td class="mdescRight">Clears credentials database. <a href="#a6e4ae4f8b9ae3dadb188de6a8b618593">More...</a><br /></td></tr>
<tr class="separator:a6e4ae4f8b9ae3dadb188de6a8b618593"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents signon for client application. </p>
<p>The class is for managing identities. Most applications can use this by using widgets from libSignOnUI. </p>
<p>Definition at line <a class="el" href="authservice_8h_source.html#l00049">49</a> of file <a class="el" href="authservice_8h_source.html">authservice.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ad9ac832e70cb6251375e9947d558d2b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9ac832e70cb6251375e9947d558d2b5">§ </a></span>IdentityFilterCriteria</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">SignOn::AuthService::IdentityFilterCriteria</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Criterias for idetity query filtering. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1AuthService.html#a7925066f708d4db50e0bbf8cdc527ba0" title="Requests information on identities which are stored. ">AuthService::queryIdentities()</a> </dd></dl>
<p>Definition at line <a class="el" href="authservice_8h_source.html#l00078">78</a> of file <a class="el" href="authservice_8h_source.html">authservice.h</a>.</p>
</div>
</div>
<a id="a95926b7896f59c4b95dd0d761283e674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95926b7896f59c4b95dd0d761283e674">§ </a></span>ServiceError</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674">SignOn::AuthService::ServiceError</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Codes for errors that may be reported by <a class="el" href="classSignOn_1_1AuthService.html" title="Represents signon for client application. ">AuthService</a> objects. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>This enum is deprecated. Replaced by <a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6d" title="Error codes for all the Signon by default supported errors. ">Error::ErrorType</a>. </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a061c94a1bda6a9dc52f3db06416f8ea4"></a>UnknownError </td><td class="fielddoc"><p>Catch-all for errors not distinguished by another code. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674ad9b74db38dcc0d46704ac1744ab5d376"></a>InternalServerError </td><td class="fielddoc"><p>Signon Daemon internal error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a8ee12cca21786aef26458a5d97fa6443"></a>InternalCommunicationError </td><td class="fielddoc"><p>Communication with Signon Daemon error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a7706acb68a8a28407081be4f95fb0fa7"></a>PermissionDeniedError </td><td class="fielddoc"><p>The operation cannot be performed due to insufficient client permissions. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478"></a>MethodNotKnownError </td><td class="fielddoc"><p>The method with this name is not found. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c"></a>NotAvailableError </td><td class="fielddoc"><p>The service is temporarily unavailable. </p>
</td></tr>
<tr><td class="fieldname"><a id="a95926b7896f59c4b95dd0d761283e674a52d38ac87577622827a731c9df88b957"></a>InvalidQueryError </td><td class="fielddoc"><p>Parameters for the query are invalid. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="authservice_8h_source.html#l00062">62</a> of file <a class="el" href="authservice_8h_source.html">authservice.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a748d77ab6c54eebc10fdc2b8eaea9d09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748d77ab6c54eebc10fdc2b8eaea9d09">§ </a></span>AuthService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SignOn::AuthService::AuthService </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>Parent object </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="authservice_8cpp_source.html#l00029">29</a> of file <a class="el" href="authservice_8cpp_source.html">authservice.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e4ae4f8b9ae3dadb188de6a8b618593"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e4ae4f8b9ae3dadb188de6a8b618593">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears credentials database. </p>
<p>All identity entries are removed from database. Signal <a class="el" href="classSignOn_1_1AuthService.html#a8d8546a22f703cfd6cfa78f38fe5ffd0" title="Database is cleared and reset to initial state. ">cleared()</a> is emitted when operation is completed. <a class="el" href="classSignOn_1_1Error.html" title="definition for Signon error handling. ">Error</a> is reported by emitting signal <a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">error()</a>. If the application does not have keychain-access credential, <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> is <a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6da6defaa800863c2454bd408117d821262">Error::PermissionDenied</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1AuthService.html#a8d8546a22f703cfd6cfa78f38fe5ffd0" title="Database is cleared and reset to initial state. ">AuthService::cleared()</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">AuthService::error()</a> keychain-access key-chain application can <a class="el" href="classSignOn_1_1AuthService.html#a6e4ae4f8b9ae3dadb188de6a8b618593" title="Clears credentials database. ">clear</a> database. </dd></dl>
<p>Definition at line <a class="el" href="authservice_8cpp_source.html#l00061">61</a> of file <a class="el" href="authservice_8cpp_source.html">authservice.cpp</a>.</p>
</div>
</div>
<a id="a8d8546a22f703cfd6cfa78f38fe5ffd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d8546a22f703cfd6cfa78f38fe5ffd0">§ </a></span>cleared</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::cleared </td>
<td>(</td>
<td class="paramname"></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>Database is cleared and reset to initial state. </p>
<p>This signal is emitted in response to <a class="el" href="classSignOn_1_1AuthService.html#a6e4ae4f8b9ae3dadb188de6a8b618593" title="Clears credentials database. ">clear()</a>. </p>
</div>
</div>
<a id="aac62087bd1ba2f14a110c5e6198b72c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac62087bd1ba2f14a110c5e6198b72c6">§ </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 SignOn::AuthService::error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSignOn_1_1Error.html">SignOn::Error</a> & </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 an error occurs while using the <a class="el" href="classSignOn_1_1AuthService.html" title="Represents signon for client application. ">AuthService</a>. </p>
<p>Typical error types are generic errors, where <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> < Error::AuthServiceErr and <a class="el" href="classSignOn_1_1AuthService.html" title="Represents signon for client application. ">AuthService</a> specific, where Error::AuthServiceErr < <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> < Error::IdentityErr </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1Error.html" title="definition for Signon error handling. ">SignOn::Error</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6d" title="Error codes for all the Signon by default supported errors. ">SignOn::Error::ErrorType</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>The error object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa5ea718192b2b64ae101d6786c36754f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5ea718192b2b64ae101d6786c36754f">§ </a></span>identities</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::identities </td>
<td>(</td>
<td class="paramtype">const QList< <a class="el" href="classSignOn_1_1IdentityInfo.html">SignOn::IdentityInfo</a> > & </td>
<td class="paramname"><em>identityList</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>Lists identities available on the server matching query parameters. </p>
<p>This signal is emitted in response to <a class="el" href="classSignOn_1_1AuthService.html#a7925066f708d4db50e0bbf8cdc527ba0" title="Requests information on identities which are stored. ">queryIdentities()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">identityList</td><td>list of identities information </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9a8d832cfa6556d5bfbb9ffb91b5745b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a8d832cfa6556d5bfbb9ffb91b5745b">§ </a></span>mechanismsAvailable</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::mechanismsAvailable </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QStringList & </td>
<td class="paramname"><em>mechanisms</em> </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 when the list of available mechanisms have been obtained from the service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">method</td><td>Name of authentication method that was queried </td></tr>
<tr><td class="paramname">mechanisms</td><td>List of available mechanisms </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac6c9693273b4548b7cc0c47a438c0c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6c9693273b4548b7cc0c47a438c0c5c">§ </a></span>methodsAvailable</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::methodsAvailable </td>
<td>(</td>
<td class="paramtype">const QStringList & </td>
<td class="paramname"><em>methods</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 the list of available authentication methods have been obtained from the service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">methods</td><td>List of available authentication method names </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7925066f708d4db50e0bbf8cdc527ba0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7925066f708d4db50e0bbf8cdc527ba0">§ </a></span>queryIdentities()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::queryIdentities </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a> & </td>
<td class="paramname"><em>filter</em> = <code><a class="el" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a>()</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Requests information on identities which are stored. </p>
<p>The list of identities retrieved from the service is emitted with signal <a class="el" href="classSignOn_1_1AuthService.html#aa5ea718192b2b64ae101d6786c36754f" title="Lists identities available on the server matching query parameters. ">identities()</a>. <a class="el" href="classSignOn_1_1Error.html" title="definition for Signon error handling. ">Error</a> is reported by emitting signal <a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">error()</a>. If filter is not valid, <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> is <a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6da8c2877f690f170ccbfa47e1eb7a66a33">Error::InvalidQuery</a>. If the application does not have keychain-access credential, <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> is <a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6da6defaa800863c2454bd408117d821262">Error::PermissionDenied</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1AuthService.html#aa5ea718192b2b64ae101d6786c36754f" title="Lists identities available on the server matching query parameters. ">AuthService::identities()</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">AuthService::error()</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>Shows only identities specified in filter - filtering not implemented for the moment. If default parameter is passed, all the identities are returned. keychain-access key-chain application can access list of identities. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="authservice_8cpp_source.html#l00056">56</a> of file <a class="el" href="authservice_8cpp_source.html">authservice.cpp</a>.</p>
</div>
</div>
<a id="ac8b2fc67f4309f88582e22116825b38a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8b2fc67f4309f88582e22116825b38a">§ </a></span>queryMechanisms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::queryMechanisms </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Requests the information on mechanisms which are available for certain authentication type. </p>
<p>The list of mechanisms retrieved from the service is emitted with signal <a class="el" href="classSignOn_1_1AuthService.html#a9a8d832cfa6556d5bfbb9ffb91b5745b" title="Emitted when the list of available mechanisms have been obtained from the service. ">mechanismsAvailable()</a>. <a class="el" href="classSignOn_1_1Error.html" title="definition for Signon error handling. ">Error</a> is reported by emitting signal <a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">error()</a>. If method is not a valid method, <a class="el" href="classSignOn_1_1Error.html#a8979c1f5c0fa258edff160b730b70f94">Error::type()</a> is <a class="el" href="classSignOn_1_1Error.html#a77c688c5b51f13d5f6126e159d72be6da1a0074dd67924f0ab82b34d8b8678d78">Error::MethodNotKnown</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1AuthService.html#a9a8d832cfa6556d5bfbb9ffb91b5745b" title="Emitted when the list of available mechanisms have been obtained from the service. ">AuthService::mechanismsAvailable()</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">AuthService::error()</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">method</td><td>authetication method name </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="authservice_8cpp_source.html#l00051">51</a> of file <a class="el" href="authservice_8cpp_source.html">authservice.cpp</a>.</p>
</div>
</div>
<a id="a42fc5513999da38613815e801b3e1565"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42fc5513999da38613815e801b3e1565">§ </a></span>queryMethods()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SignOn::AuthService::queryMethods </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Requests the information on available authentication methods. </p>
<p>The list of service types retrieved is emitted with signal <a class="el" href="classSignOn_1_1AuthService.html#ac6c9693273b4548b7cc0c47a438c0c5c" title="Emitted when the list of available authentication methods have been obtained from the service...">methodsAvailable()</a>. <a class="el" href="classSignOn_1_1Error.html" title="definition for Signon error handling. ">Error</a> is reported by emitting signal <a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">error()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSignOn_1_1AuthService.html#ac6c9693273b4548b7cc0c47a438c0c5c" title="Emitted when the list of available authentication methods have been obtained from the service...">AuthService::methodsAvailable()</a> </dd>
<dd>
<a class="el" href="classSignOn_1_1AuthService.html#aac62087bd1ba2f14a110c5e6198b72c6" title="Emitted when an error occurs while using the AuthService. ">AuthService::error()</a> </dd></dl>
<p>Definition at line <a class="el" href="authservice_8cpp_source.html#l00046">46</a> of file <a class="el" href="authservice_8cpp_source.html">authservice.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="authservice_8h_source.html">authservice.h</a></li>
<li><a class="el" href="authservice_8cpp_source.html">authservice.cpp</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="namespaceSignOn.html">SignOn</a></li><li class="navelem"><a class="el" href="classSignOn_1_1AuthService.html">AuthService</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>
|