Sophie

Sophie

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

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" />
<!-- enginioclient.cpp -->
  <title>Enginio Namespace | 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 >Enginio Namespace</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="#types">Types</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">Enginio Namespace</h1>
<!-- $$$Enginio-brief -->
<p>The Enginio namespace provides enums used throughout Enginio. <a href="#details">More...</a></p>
<!-- @@@Enginio -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;Enginio&gt;</span>
</td></tr></table></div><ul>
</ul>
<a name="types"></a>
<h2 id="types">Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="enginio.html#AuthenticationState-enum">AuthenticationState</a></b> { NotAuthenticated, Authenticating, Authenticated, AuthenticationFailure }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="enginio.html#ErrorType-enum">ErrorType</a></b> { NoError, NetworkError, BackendError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="enginio.html#Operation-enum">Operation</a></b> { ObjectOperation, AccessControlOperation, FileOperation, UserOperation, UsergroupOperation, UsergroupMembersOperation }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="enginio.html#Role-enum">Role</a></b> { CreatedAtRole, UpdatedAtRole, IdRole, ObjectTypeRole, ..., JsonObjectRole }</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$Enginio-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The Enginio namespace provides enums used throughout Enginio.</p>
</div>
<!-- @@@Enginio -->
<div class="types">
<h2>Type Documentation</h2>
<!-- $$$AuthenticationState$$$NotAuthenticated$$$Authenticating$$$Authenticated$$$AuthenticationFailure -->
<h3 class="fn" id="AuthenticationState-enum"><a name="AuthenticationState-enum"></a>enum Enginio::<span class="name">AuthenticationState</span></h3>
<p>This enum describes the state of the user authentication.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Enginio::NotAuthenticated</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No attempt to authenticate was made</td></tr>
<tr><td class="topAlign"><code>Enginio::Authenticating</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Authentication request has been sent to the server</td></tr>
<tr><td class="topAlign"><code>Enginio::Authenticated</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Authentication was successful</td></tr>
<tr><td class="topAlign"><code>Enginio::AuthenticationFailure</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Authentication failed</td></tr>
</table></div>
<p><b>See also </b><a href="enginioclientconnection.html#authenticationState-prop">EnginioClient::authenticationState</a>.</p>
<!-- @@@AuthenticationState -->
<!-- $$$ErrorType$$$NoError$$$NetworkError$$$BackendError -->
<h3 class="fn" id="ErrorType-enum"><a name="ErrorType-enum"></a>enum Enginio::<span class="name">ErrorType</span></h3>
<p>Describes the type of error that occured when making a request to the Enginio backend.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Enginio::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The reply returned without errors</td></tr>
<tr><td class="topAlign"><code>Enginio::NetworkError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The error was a networking problem</td></tr>
<tr><td class="topAlign"><code>Enginio::BackendError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The backend did not accept the query</td></tr>
</table></div>
<!-- @@@ErrorType -->
<!-- $$$Operation$$$ObjectOperation$$$AccessControlOperation$$$UserOperation$$$UsergroupOperation$$$UsergroupMembersOperation$$$FileOperation$$$SessionOperation$$$SearchOperation$$$FileChunkUploadOperation$$$FileGetDownloadUrlOperation -->
<h3 class="fn" id="Operation-enum"><a name="Operation-enum"></a>enum Enginio::<span class="name">Operation</span></h3>
<p>Enginio has a unified API for several <code>operations</code>. For example when using query(), the default is <code>ObjectOperation</code>, which means that the query will return objects from the database. When passing in UserOperation instead, the query will return users.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Enginio::ObjectOperation</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Operate on objects</td></tr>
<tr><td class="topAlign"><code>Enginio::AccessControlOperation</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Operate on the ACL</td></tr>
<tr><td class="topAlign"><code>Enginio::FileOperation</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">Operate with files</td></tr>
<tr><td class="topAlign"><code>Enginio::UserOperation</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Operate on users</td></tr>
<tr><td class="topAlign"><code>Enginio::UsergroupOperation</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Operate on groups</td></tr>
<tr><td class="topAlign"><code>Enginio::UsergroupMembersOperation</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">Operate on group members</td></tr>
</table></div>
<!-- @@@Operation -->
<!-- $$$Role$$$InvalidRole$$$SyncedRole$$$CreatedAtRole$$$UpdatedAtRole$$$IdRole$$$ObjectTypeRole$$$JsonObjectRole$$$CustomPropertyRole -->
<h3 class="fn" id="Role-enum"><a name="Role-enum"></a>enum Enginio::<span class="name">Role</span></h3>
<p><a href="enginiomodel.html">EnginioModel</a> defines roles which represent data used by every object stored in the Enginio backend</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Enginio::CreatedAtRole</code></td><td class="topAlign tblval"><code>258</code></td><td class="topAlign"><code>When</code> an item was created</td></tr>
<tr><td class="topAlign"><code>Enginio::UpdatedAtRole</code></td><td class="topAlign tblval"><code>259</code></td><td class="topAlign"><code>When</code> an item was updated last time</td></tr>
<tr><td class="topAlign"><code>Enginio::IdRole</code></td><td class="topAlign tblval"><code>260</code></td><td class="topAlign"><code>What</code> is the id of an item</td></tr>
<tr><td class="topAlign"><code>Enginio::ObjectTypeRole</code></td><td class="topAlign tblval"><code>261</code></td><td class="topAlign"><code>What</code> is item type</td></tr>
<tr><td class="topAlign"><code>Enginio::SyncedRole</code></td><td class="topAlign tblval"><code>Qt::UserRole + 1</code></td><td class="topAlign"><code>Mark</code> if an item is in sync with the backend</td></tr>
<tr><td class="topAlign"><code>Enginio::CustomPropertyRole</code></td><td class="topAlign tblval"><code>Qt::UserRole + 10</code></td><td class="topAlign"><code>The</code> first role id that may be used for dynamically created roles.</td></tr>
<tr><td class="topAlign"><code>Enginio::JsonObjectRole</code></td><td class="topAlign tblval"><code>262</code></td><td class="topAlign"><code>Object</code> like representation of an item</td></tr>
</table></div>
<p>Additionally <a href="enginiomodel.html">EnginioModel</a> supports dynamic roles which are mapped directly from received data. <a href="enginiomodel.html">EnginioModel</a> is mapping an item's properties to role names.</p>
<p><b>Note: </b>Some objects may not contain value for a static role, it may happen for example when an item is not in sync with the backend.</p><p><b>See also </b>QAbstractItemModel::roleNames().</p>
<!-- @@@Role -->
</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