<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- enginioreply.cpp --> <title>EnginioReply 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 >EnginioReply</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 1.6.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="#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">EnginioReply Class</h1> <!-- $$$EnginioReply-brief --> <p>The <a href="enginioreply.html">EnginioReply</a> class contains the data from a request to the Enginio database. <a href="#details">More...</a></p> <!-- @@@EnginioReply --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <EnginioReply></span> </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="enginioreply-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <div class="table"><table class="propsummary"> <tr><td class="topAlign"><ul> <li class="fn"><b><a href="enginioreply.html#backendStatus-prop">backendStatus</a></b> : const int</li> <li class="fn"><b><a href="enginioreply.html#data-prop">data</a></b> : const QJsonObject</li> <li class="fn"><b><a href="enginioreply.html#errorString-prop">errorString</a></b> : const QString</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="enginioreply.html#errorType-prop">errorType</a></b> : const ErrorType</li> <li class="fn"><b><a href="enginioreply.html#networkError-prop">networkError</a></b> : const QNetworkReply::NetworkError</li> </ul> </td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#dtor.EnginioReply">~EnginioReply</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#backendStatus-prop">backendStatus</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QJsonObject </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#data-prop">data</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#errorString-prop">errorString</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#errorType-prop">errorType</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#isError">isError</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#isFinished">isFinished</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QNetworkReply::NetworkError </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#networkError-prop">networkError</a></b>() const</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="enginioreply.html#dataChanged">dataChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#finished">finished</a></b>(EnginioReply *<i>reply</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginioreply.html#progress">progress</a></b>(qint64 <i>bytesSent</i>, qint64 <i>bytesTotal</i>)</td></tr> </table></div> <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="enginioreply.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$EnginioReply-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="enginioreply.html">EnginioReply</a> class contains the data from a request to the Enginio database.</p> <p>The reply, when finished, contains information received from the server:</p> <ul> <li>Data - object, which is a result from an earlier request, see the <a href="enginioreply.html#data-prop">data</a> function</li> <li>Network status - in case of a network problem, additional information can be accessed through: <a href="enginioreply.html#errorType-prop">errorType</a>, <a href="enginioreply.html#errorString-prop">errorString</a>, <a href="enginioreply.html#networkError-prop">networkError</a></li> <li>Backend status - a finished request is always associated with a backend status code, which is just an HTTP code, and it can be queried through <a href="enginioreply.html#backendStatus-prop">backendStatus</a></li> </ul> <p>The finished signal is emitted when the query is done.</p> </div> <p><b>See also </b><a href="enginioclient.html">EnginioClient</a>.</p> <!-- @@@EnginioReply --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$backendStatus-prop$$$backendStatus$$$dataChanged --> <h3 class="fn" id="backendStatus-prop"><a name="backendStatus-prop"></a><span class="name">backendStatus</span> : const <span class="type">int</span></h3> <p>Returns the backend return status for this reply.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>backendStatus</b></span>() const</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><a href="enginioreply.html#dataChanged">dataChanged</a></b></span>()</td></tr> </table></div> <p><b>See also </b><a href="enginio.html#ErrorType-enum">Enginio::ErrorType</a>.</p> <!-- @@@backendStatus --> <!-- $$$data-prop$$$data$$$dataChanged --> <h3 class="fn" id="data-prop"><a name="data-prop"></a><span class="name">data</span> : const <span class="type">QJsonObject</span></h3> <p>This property holds the data returned from the backend This property holds the JSON data returned by the server after a successful request.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QJsonObject </td><td class="memItemRight bottomAlign"><span class="name"><b>data</b></span>() const</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><a href="enginioreply.html#dataChanged">dataChanged</a></b></span>()</td></tr> </table></div> <!-- @@@data --> <!-- $$$errorString-prop$$$errorString$$$dataChanged --> <h3 class="fn" id="errorString-prop"><a name="errorString-prop"></a><span class="name">errorString</span> : const <span class="type">QString</span></h3> <p>This property holds the error for the request as human readable string. Check <a href="enginioreply.html#isError">isError()</a> first to check if the reply is an error.</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>errorString</b></span>() const</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><a href="enginioreply.html#dataChanged">dataChanged</a></b></span>()</td></tr> </table></div> <!-- @@@errorString --> <!-- $$$errorType-prop$$$errorType$$$dataChanged --> <h3 class="fn" id="errorType-prop"><a name="errorType-prop"></a><span class="name">errorType</span> : const <span class="type">ErrorType</span></h3> <p>Returns the type of the error</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>errorType</b></span>() const</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><a href="enginioreply.html#dataChanged">dataChanged</a></b></span>()</td></tr> </table></div> <p><b>See also </b><a href="enginio.html#ErrorType-enum">Enginio::ErrorType</a>.</p> <!-- @@@errorType --> <!-- $$$networkError-prop$$$networkError$$$dataChanged --> <h3 class="fn" id="networkError-prop"><a name="networkError-prop"></a><span class="name">networkError</span> : const <span class="type">QNetworkReply::NetworkError</span></h3> <p>This property holds the network error for the request.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QNetworkReply::NetworkError </td><td class="memItemRight bottomAlign"><span class="name"><b>networkError</b></span>() const</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><a href="enginioreply.html#dataChanged">dataChanged</a></b></span>()</td></tr> </table></div> <!-- @@@networkError --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$~EnginioReply[overload1]$$$~EnginioReply --> <h3 class="fn" id="dtor.EnginioReply"><a name="dtor.EnginioReply"></a><code>[virtual] </code>EnginioReply::<span class="name">~EnginioReply</span>()</h3> <p>Destroys the <a href="enginioreply.html">EnginioReply</a>.</p> <p>The reply needs to be deleted after the finished signal is emitted.</p> <!-- @@@~EnginioReply --> <!-- $$$finished[overload1]$$$finishedEnginioReply* --> <h3 class="fn" id="finished"><a name="finished"></a><code>[signal] </code><span class="type">void</span> EnginioReply::<span class="name">finished</span>(<span class="type">EnginioReply</span> *<i>reply</i>)</h3> <!-- @@@finished --> <!-- $$$isError[overload1]$$$isError --> <h3 class="fn" id="isError"><a name="isError"></a><span class="type">bool</span> EnginioReply::<span class="name">isError</span>() const</h3> <!-- @@@isError --> <!-- $$$isFinished[overload1]$$$isFinished --> <h3 class="fn" id="isFinished"><a name="isFinished"></a><span class="type">bool</span> EnginioReply::<span class="name">isFinished</span>() const</h3> <!-- @@@isFinished --> <!-- $$$progress[overload1]$$$progressqint64qint64 --> <h3 class="fn" id="progress"><a name="progress"></a><code>[signal] </code><span class="type">void</span> EnginioReply::<span class="name">progress</span>(<span class="type">qint64</span> <i>bytesSent</i>, <span class="type">qint64</span> <i>bytesTotal</i>)</h3> <!-- @@@progress --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>