Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-updates > by-pkgid > 4ff6143ff2a088c33c83add3bab6e293 > files > 141

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" />
<!-- enginioplugin.cpp -->
  <title>EnginioOAuth2Authentication QML Type | 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-qml-types-and-examples.html">QML Types</a></td><td >EnginioOAuth2Authentication QML Type</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">EnginioOAuth2Authentication QML Type</h1>
<span class="subtitle"></span>
<!-- $$$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"> Import Statement:</td><td class="memItemRight bottomAlign"> import Enginio 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.3</td></tr></table></div><ul>
<li><a href="qml-enginio-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><b><a href="qml-enginio-enginiooauth2authentication.html#password-prop">password</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-enginio-enginiooauth2authentication.html#user-prop">user</a></b></b> : string</li>
</ul>
<!-- $$$EnginioOAuth2Authentication-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This component 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="qml-enginio-enginioclient.html">EnginioClient</a> called <i>client</i> such code may be used:</p>
<pre class="cpp">

  EnginioClient {
      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
      identity: oauth2
  }
  EnginioOAuth2Authentication {
      id: oauth2
      user: <span class="string">&quot;userName&quot;</span>
      password: <span class="string">&quot;userPassword&quot;</span>
  }

</pre>
<p>Setting the identity on the <a href="qml-enginio-enginioclient.html">EnginioClient</a> will trigger an asynchronous request, resulting in <a href="qml-enginio-enginioclient.html#authenticationState-prop">EnginioClient::authenticationState</a> changing.</p>
<p><b>See also </b><a href="qml-enginio-enginioclient.html#authenticationState-prop">EnginioClient::authenticationState</a>, <a href="qml-enginio-enginioclient.html#identity-prop">EnginioClient::identity</a>, <a href="qml-enginio-enginioclient.html#sessionAuthenticated-signal">EnginioClient::sessionAuthenticated</a>, <a href="qml-enginio-enginioclient.html#sessionAuthenticationError-signal">EnginioClient::sessionAuthenticationError()</a>, and <a href="qml-enginio-enginioclient.html#sessionTerminated-signal">EnginioClient::sessionTerminated()</a>.</p>
<!-- @@@EnginioOAuth2Authentication -->
<h2>Property Documentation</h2>
<!-- $$$password -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="password-prop">
<td class="tblQmlPropNode"><p>
<a name="password-prop"></a><span class="name">password</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property contains the password used for authentication.</p>
</div></div><!-- @@@password -->
<br/>
<!-- $$$user -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="user-prop">
<td class="tblQmlPropNode"><p>
<a name="user-prop"></a><span class="name">user</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property contains the user name used for authentication.</p>
</div></div><!-- @@@user -->
<br/>
        </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>