Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > 4ff6143ff2a088c33c83add3bab6e293 > files > 18

qtenginio5-doc-1.6.3-7.1.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- enginioidentity.cpp -->
  <title>EnginioOAuth2Authentication Class | Enginio Manual 1.6.3</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 1.6</td><td >Enginio Manual</td><td ><a href="enginio-cpp-classes-and-examples.html">C++ Classes</a></td><td >EnginioOAuth2Authentication</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 1.6&#x2e;3 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">EnginioOAuth2Authentication Class</h1>
<!-- $$$EnginioOAuth2Authentication-brief -->
<p>Represents a user that is authenticated directly by the backend using OAuth2 standard. <a href="#details">More...</a></p>
<!-- @@@EnginioOAuth2Authentication -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;EnginioOAuth2Authentication&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="enginioidentity.html">EnginioIdentity</a></td></tr></table></div><ul>
<li><a href="enginiooauth2authentication-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="enginiooauth2authentication.html#password-prop">password</a></b> : QString</li>
<li class="fn"><b><a href="enginiooauth2authentication.html#user-prop">user</a></b> : QString</li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#EnginioOAuth2Authentication">EnginioOAuth2Authentication</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#dtor.EnginioOAuth2Authentication">~EnginioOAuth2Authentication</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#password-prop">password</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#user-prop">user</a></b>() const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#password-prop">setPassword</a></b>(const QString &amp;<i>password</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#user-prop">setUser</a></b>(const QString &amp;<i>user</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#password-prop">passwordChanged</a></b>(const QString &amp;<i>password</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#user-prop">userChanged</a></b>(const QString &amp;<i>user</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="enginioidentity.html#signals">EnginioIdentity</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="enginiooauth2authentication.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="enginioidentity.html#protected-functions">EnginioIdentity</a></li>
</ul>
<a name="details"></a>
<!-- $$$EnginioOAuth2Authentication-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Represents a user that is authenticated directly by the backend using OAuth2 standard.</p>
<p>This class can authenticate a user by verifying the user's login and password. The user has to exist in the backend already.</p>
<p>To authenticate an instance of <a href="enginioclient.html">EnginioClient</a> called <i>client</i> such code may be used:</p>
<pre class="cpp">

  EnginioOAuth2Authentication <span class="operator">*</span>identity <span class="operator">=</span> <span class="keyword">new</span> EnginioOAuth2Authentication(client);
  identity<span class="operator">-</span><span class="operator">&gt;</span>setUser(_user);
  identity<span class="operator">-</span><span class="operator">&gt;</span>setPassword(_password);

  client<span class="operator">-</span><span class="operator">&gt;</span>setIdentity(identity);

</pre>
<p>Setting the identity will trigger an asynchronous request, resulting in <a href="enginioclientconnection.html#authenticationState-prop">EnginioClient::authenticationState</a>() changing.</p>
</div>
<p><b>See also </b><a href="enginioclientconnection.html#authenticationState-prop">EnginioClientConnection::authenticationState</a>(), <a href="enginioclientconnection.html#identity-prop">EnginioClientConnection::identity</a>(), <a href="enginioclient.html#sessionAuthenticated">EnginioClient::sessionAuthenticated</a>(), <a href="enginioclient.html#sessionAuthenticationError">EnginioClient::sessionAuthenticationError</a>(), and <a href="enginioclient.html#sessionTerminated">EnginioClient::sessionTerminated</a>().</p>
<!-- @@@EnginioOAuth2Authentication -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$password-prop$$$password$$$setPasswordconstQString&$$$passwordChangedconstQString& -->
<h3 class="fn" id="password-prop"><a name="password-prop"></a><span class="name">password</span> : <span class="type">QString</span></h3>
<p>This property contains the password used for authentication.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>password</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPassword</b></span>(const QString &amp;<i>password</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>passwordChanged</b></span>(const QString &amp;<i>password</i>)</td></tr>
</table></div>
<!-- @@@password -->
<!-- $$$user-prop$$$user$$$setUserconstQString&$$$userChangedconstQString& -->
<h3 class="fn" id="user-prop"><a name="user-prop"></a><span class="name">user</span> : <span class="type">QString</span></h3>
<p>This property contains the user name used for authentication.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>user</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setUser</b></span>(const QString &amp;<i>user</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>userChanged</b></span>(const QString &amp;<i>user</i>)</td></tr>
</table></div>
<!-- @@@user -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$EnginioOAuth2Authentication[overload1]$$$EnginioOAuth2AuthenticationQObject* -->
<h3 class="fn" id="EnginioOAuth2Authentication"><a name="EnginioOAuth2Authentication"></a>EnginioOAuth2Authentication::<span class="name">EnginioOAuth2Authentication</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a EnginioPasswordOAuth2 instance with <i>parent</i> as QObject parent.</p>
<!-- @@@EnginioOAuth2Authentication -->
<!-- $$$~EnginioOAuth2Authentication[overload1]$$$~EnginioOAuth2Authentication -->
<h3 class="fn" id="dtor.EnginioOAuth2Authentication"><a name="dtor.EnginioOAuth2Authentication"></a><code>[virtual] </code>EnginioOAuth2Authentication::<span class="name">~EnginioOAuth2Authentication</span>()</h3>
<p>Destructs this EnginioPasswordOAuth2 instance.</p>
<!-- @@@~EnginioOAuth2Authentication -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional