<?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>EnginioClient 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 >EnginioClient</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="#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">EnginioClient Class</h1>
<!-- $$$EnginioClient-brief -->
<p><a href="enginioclient.html">EnginioClient</a> handles all communication with the Enginio server. <a href="#details">More...</a></p>
<!-- @@@EnginioClient -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <EnginioClient></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="enginioclientconnection.html">EnginioClientConnection</a></td></tr></table></div><ul>
<li><a href="enginioclient-members.html">List of all members, including inherited members</a></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="enginioclient.html#EnginioClient">EnginioClient</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="enginioclient.html#dtor.EnginioClient">~EnginioClient</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#create">create</a></b>(const QJsonObject &<i>object</i>, const Enginio::Operation <i>operation</i> = Enginio::ObjectOperation)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#downloadUrl">downloadUrl</a></b>(const QJsonObject &<i>object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#fullTextSearch">fullTextSearch</a></b>(const QJsonObject &<i>query</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#query">query</a></b>(const QJsonObject &<i>query</i>, const Enginio::Operation <i>operation</i> = Enginio::ObjectOperation)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#remove">remove</a></b>(const QJsonObject &<i>object</i>, const Enginio::Operation <i>operation</i> = Enginio::ObjectOperation)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#update">update</a></b>(const QJsonObject &<i>object</i>, const Enginio::Operation <i>operation</i> = Enginio::ObjectOperation)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> EnginioReply *</td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#uploadFile">uploadFile</a></b>(const QJsonObject &<i>object</i>, const QUrl &<i>file</i>)</td></tr>
</table></div>
<ul>
<li class="fn">8 public functions inherited from <a href="enginioclientconnection.html#public-functions">EnginioClientConnection</a></li>
</ul>
<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="enginioclient.html#error">error</a></b>(EnginioReply *<i>reply</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginioclient.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="enginioclient.html#sessionAuthenticated">sessionAuthenticated</a></b>(EnginioReply *<i>reply</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#sessionAuthenticationError">sessionAuthenticationError</a></b>(EnginioReply *<i>reply</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="enginioclient.html#sessionTerminated">sessionTerminated</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">4 signals inherited from <a href="enginioclientconnection.html#signals">EnginioClientConnection</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="enginioclient.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">4 properties inherited from <a href="enginioclientconnection.html#properties">EnginioClientConnection</a></li>
</ul>
<a name="details"></a>
<!-- $$$EnginioClient-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="enginioclient.html">EnginioClient</a> handles all communication with the Enginio server</p>
<p>The Enginio server supports several separate "backends" with each account. By setting the <a href="enginioclientconnection.html#backendId-prop">backendId</a> a backend is chosen. After setting the ID interaction with the server is possible. The information about the backend is available on the Enginio Dashboard after logging in to <a href="http://engin.io">Enginio</a>.</p>
<pre class="cpp">
EnginioClient <span class="operator">*</span>client <span class="operator">=</span> <span class="keyword">new</span> EnginioClient(parent);
client<span class="operator">-</span><span class="operator">></span>setBackendId(<span class="type">QByteArrayLiteral</span>(<span class="string">"YOUR_BACKEND_ID"</span>));
</pre>
<p>The basic functions used to interact with the backend are <a href="enginioclient.html#create">create</a>(), <a href="enginioclient.html#query">query</a>(), <a href="enginioclient.html#remove">remove</a>() and <a href="enginioclient.html#update">update</a>(). It is possible to do a fulltext search on the server using <a href="enginioclient.html#fullTextSearch">fullTextSearch</a>(). For file handling <a href="enginioclient.html#downloadUrl">downloadUrl</a>() and <a href="enginioclient.html#uploadFile">uploadFile</a>() are provided. The functions are asynchronous, which means that they are not blocking and the result of them will be delivered together with <a href="enginioreply.html#finished">EnginioReply::finished</a>() signal.</p>
<p><b>Note: </b>After the request has finished, it is the responsibility of the user to delete the <a href="enginioreply.html">EnginioReply</a> object at an appropriate time. Do not directly delete it inside the slot connected to <a href="enginioclient.html#finished">finished</a>(). You can use the deleteLater() function.</p><p>In order to make queries that return an array of data more convenient a model is provided by <a href="enginiomodel.html#enginiomodelcpp">EnginioModel</a>.</p>
</div>
<!-- @@@EnginioClient -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$EnginioClient[overload1]$$$EnginioClientQObject* -->
<h3 class="fn" id="EnginioClient"><a name="EnginioClient"></a>EnginioClient::<span class="name">EnginioClient</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Creates a new <a href="enginioclient.html">EnginioClient</a> with <i>parent</i> as QObject parent.</p>
<!-- @@@EnginioClient -->
<!-- $$$~EnginioClient[overload1]$$$~EnginioClient -->
<h3 class="fn" id="dtor.EnginioClient"><a name="dtor.EnginioClient"></a><code>[virtual] </code>EnginioClient::<span class="name">~EnginioClient</span>()</h3>
<p>Destroys the <a href="enginioclient.html">EnginioClient</a>.</p>
<p>This ends the Enginio session.</p>
<!-- @@@~EnginioClient -->
<!-- $$$create[overload1]$$$createconstQJsonObject&constEnginio::Operation -->
<h3 class="fn" id="create"><a name="create"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">create</span>(const <span class="type">QJsonObject</span> &<i>object</i>, const <span class="type"><a href="enginio.html#Operation-enum">Enginio::Operation</a></span> <i>operation</i> = Enginio::ObjectOperation)</h3>
<p>Insert a new <i>object</i> into the database.</p>
<p>The returned <a href="enginioreply.html">EnginioReply</a> indicates the success of the object creation. The object becomes available from the backend if it finishes without errors.</p>
<p><i>operation</i> determines the kind of object created. For example a regular object or a user or usergroup. By default, <a href="enginio.html#Operation-enum">Enginio::ObjectOperation</a> is used and regular objects created.</p>
<p><b>Note: </b>that the <code>objectType</code> is required for regular objects and has to begin with <code>"objects."</code>.</p><p>The JSON for the object that will be created must follow this structure:</p>
<pre class="cpp">
{
<span class="string">"objectType"</span>: <span class="string">"object.myType"</span><span class="operator">,</span>
<span class="string">"name"</span> : <span class="string">"A thing"</span><span class="operator">,</span>
<span class="string">"price"</span> : <span class="string">"5"</span><span class="operator">,</span>
}
</pre>
<p>Where only the <code>objectType</code> property is required and <code>name</code> and <code>price</code> are examples of custom properties.</p>
<p>Users and all kinds of other objects are created the same way but do not require any <code>objectType</code>.</p>
<pre class="cpp">
<span class="type">QJsonObject</span> query;
query<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"objects.todos"</span>);
query<span class="operator">[</span><span class="string">"title"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"A todo"</span>);
query<span class="operator">[</span><span class="string">"completed"</span><span class="operator">]</span> <span class="operator">=</span> <span class="keyword">true</span>;
<span class="keyword">const</span> EnginioReply<span class="operator">*</span> response <span class="operator">=</span> client<span class="operator">.</span>create(query);
</pre>
<p>To add a new member to a usergroup, the JSON needs to look like the example below.</p>
<pre class="cpp">
{
<span class="string">"id"</span>: <span class="string">"groupId"</span><span class="operator">,</span>
<span class="string">"member"</span>: { <span class="string">"id"</span>: <span class="string">"userId"</span><span class="operator">,</span> <span class="string">"objectType"</span>: <span class="string">"users"</span> }
}
</pre>
<p>It can be constructed like this:</p>
<pre class="cpp">
<span class="type">QJsonObject</span> query;
query<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> groupId;
<span class="type">QJsonObject</span> user;
user<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> userId;
user<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"users"</span>);
query<span class="operator">[</span><span class="string">"member"</span><span class="operator">]</span> <span class="operator">=</span> user;
EnginioReply <span class="operator">*</span>reply <span class="operator">=</span> client<span class="operator">.</span>create(query<span class="operator">,</span> Enginio<span class="operator">::</span>UsergroupMembersOperation);
</pre>
<p>Returns an <a href="enginioreply.html">EnginioReply</a> containing the status and data once it is finished.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioreply.html">EnginioReply</a>, <a href="enginioclient.html#query">query</a>(), <a href="enginioclient.html#update">update</a>(), <a href="enginioclient.html#remove">remove</a>(), and <a href="enginio.html#Operation-enum">Enginio::Operation</a>.</p>
<!-- @@@create -->
<!-- $$$downloadUrl[overload1]$$$downloadUrlconstQJsonObject& -->
<h3 class="fn" id="downloadUrl"><a name="downloadUrl"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">downloadUrl</span>(const <span class="type">QJsonObject</span> &<i>object</i>)</h3>
<p>Get a temporary URL for a file stored in Enginio</p>
<p>From this URL a file can be downloaded. The URL is valid for a certain amount of time as indicated in the reply.</p>
<pre class="cpp">
<span class="type">QJsonObject</span> object;
object<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> fileId; <span class="comment">// ID of an existing object with attached file</span>
<span class="keyword">const</span> EnginioReply <span class="operator">*</span>replyDownload <span class="operator">=</span> _client<span class="operator">.</span>downloadUrl(object);
</pre>
<p>The propertyName can be anything, but it must be the same as the one used to upload the file with. This way one object can have several files attached to itself (one per propertyName).</p>
<p>If a file provides several variants, it is possible to request a variant by including it in the <i>object</i>.</p>
<pre class="cpp">
{
<span class="string">"id"</span>: <span class="string">"abc123"</span><span class="operator">,</span>
<span class="string">"variant"</span>: <span class="string">"thumbnail"</span>
}
</pre>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@downloadUrl -->
<!-- $$$error[overload1]$$$errorEnginioReply* -->
<h3 class="fn" id="error"><a name="error"></a><code>[signal] </code><span class="type">void</span> EnginioClient::<span class="name">error</span>(<span class="type"><a href="enginioreply.html">EnginioReply</a></span> *<i>reply</i>)</h3>
<!-- @@@error -->
<!-- $$$finished[overload1]$$$finishedEnginioReply* -->
<h3 class="fn" id="finished"><a name="finished"></a><code>[signal] </code><span class="type">void</span> EnginioClient::<span class="name">finished</span>(<span class="type"><a href="enginioreply.html">EnginioReply</a></span> *<i>reply</i>)</h3>
<!-- @@@finished -->
<!-- $$$fullTextSearch[overload1]$$$fullTextSearchconstQJsonObject& -->
<h3 class="fn" id="fullTextSearch"><a name="fullTextSearch"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">fullTextSearch</span>(const <span class="type">QJsonObject</span> &<i>query</i>)</h3>
<p>Fulltext search on the Enginio backend</p>
<p>The <i>query</i> is JSON sent to the backend to perform a fulltext search. Note that the search requires the searched properties to be indexed (on the server, configureable in the backend).</p>
<p>Returns <a href="enginioreply.html">EnginioReply</a> containing the status and the result once it is finished.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioreply.html">EnginioReply</a>, <a href="enginioclient.html#create">create</a>(), <a href="enginioclient.html#query">query</a>(), <a href="enginioclient.html#update">update</a>(), <a href="enginioclient.html#remove">remove</a>(), <a href="enginio-qt-cloudaddressbook-example.html">Address book example</a>, and <a href="https://engin.io/documentation/rest/parameters/fulltext_query">JSON request structure</a>.</p>
<!-- @@@fullTextSearch -->
<!-- $$$query[overload1]$$$queryconstQJsonObject&constEnginio::Operation -->
<h3 class="fn" id="query"><a name="query"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">query</span>(const <span class="type">QJsonObject</span> &<i>query</i>, const <span class="type"><a href="enginio.html#Operation-enum">Enginio::Operation</a></span> <i>operation</i> = Enginio::ObjectOperation)</h3>
<p>Query the database</p>
<p>The <i>query</i> is an object containing the actual query to the backend. The query will be run on the <i>operation</i> part of the backend.</p>
<p>The <i>query</i> has to contain an "objectType" which has to point to a type defined in the backend. Optionally, it can also contain:</p>
<ul>
<li>query - describes how objects are queried, allows filtering of results. See {https://engin.io/documentation/rest/parameters/queries} {JSON query structure}</li>
<li>limit - limits how many objects the server should return (default value is <code>100</code>).</li>
<li>offset - how many objects the server should skip from the beginning of the returned results. Note that the server keeps the data in random order so that usage of offset implies using <code>sort</code> as well.</li>
<li>sort - describes how results are sorted. See <a href="https://engin.io/documentation/rest/parameters/sort">JSON sort request structure</a></li>
<li>count - if the <code>count</code> is set, the server will return only count of matching objects</li>
<li>include - describes which other objects are included in the response. See <a href="https://engin.io/documentation/rest/parameters/include">JSON include structure</a></li>
</ul>
<p>The JSON to list all objects of type "objects.image":</p>
<pre class="cpp">
{
<span class="string">"objectType"</span>: <span class="string">"objects.image"</span>
}
</pre>
<p>An example using <code>include</code> to get <code>file</code> references and with a query parameter that limits the results to only those objects where the reference is valid:</p>
<pre class="cpp">
{
<span class="string">"objectType"</span>: <span class="string">"objects.image"</span><span class="operator">,</span>
<span class="string">"include"</span>: {<span class="string">"file"</span>: {}}<span class="operator">,</span>
<span class="string">"query"</span> : { <span class="string">"file"</span>: { <span class="string">"$ne"</span>: null } }
}
</pre>
<p>To query the database for all objects of the type "objects.todo":</p>
<pre class="cpp">
<span class="type">QJsonObject</span> query;
query<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"objects.todos"</span>);
EnginioReply <span class="operator">*</span>reply <span class="operator">=</span> client<span class="operator">.</span>query(query);
</pre>
<p>Returns an <a href="enginioreply.html">EnginioReply</a> containing the status and the result once it is finished.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioreply.html">EnginioReply</a>, <a href="enginioclient.html#create">create</a>(), <a href="enginioclient.html#update">update</a>(), and <a href="enginioclient.html#remove">remove</a>().</p>
<!-- @@@query -->
<!-- $$$remove[overload1]$$$removeconstQJsonObject&constEnginio::Operation -->
<h3 class="fn" id="remove"><a name="remove"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">remove</span>(const <span class="type">QJsonObject</span> &<i>object</i>, const <span class="type"><a href="enginio.html#Operation-enum">Enginio::Operation</a></span> <i>operation</i> = Enginio::ObjectOperation)</h3>
<p>Remove an object from the database.</p>
<p>The <i>object</i> that is to be removed is identified by its object ID and if it is a regular object also <code>objectType</code>.</p>
<p>The JSON that identfies an object looks like this:</p>
<pre class="cpp">
{
<span class="string">"objectType"</span>: <span class="string">"objects.images"</span><span class="operator">,</span>
<span class="string">"id"</span>: <span class="string">"52b1a94b5a3d8b15b1037ff5"</span>
}
</pre>
<p>The <i>operation</i> is the area from which the object gets removed. It defaults to <a href="enginio.html#Operation-enum">Enginio::ObjectOperation</a> to remove regular objects by default.</p>
<p>To remove a todo object:</p>
<pre class="cpp">
<span class="type">QJsonObject</span> query;
query<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"objects.todos"</span>);
query<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> objectId;
<span class="keyword">const</span> EnginioReply <span class="operator">*</span>response <span class="operator">=</span> client<span class="operator">.</span>remove(query);
</pre>
<p>Returns an <a href="enginioreply.html">EnginioReply</a> containing the status and the data once it is finished.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioreply.html">EnginioReply</a>, <a href="enginioclient.html#create">create</a>(), <a href="enginioclient.html#query">query</a>(), and <a href="enginioclient.html#update">update</a>().</p>
<!-- @@@remove -->
<!-- $$$sessionAuthenticated[overload1]$$$sessionAuthenticatedEnginioReply* -->
<h3 class="fn" id="sessionAuthenticated"><a name="sessionAuthenticated"></a><code>[signal] </code><span class="type">void</span> EnginioClient::<span class="name">sessionAuthenticated</span>(<span class="type"><a href="enginioreply.html">EnginioReply</a></span> *<i>reply</i>) const</h3>
<!-- @@@sessionAuthenticated -->
<!-- $$$sessionAuthenticationError[overload1]$$$sessionAuthenticationErrorEnginioReply* -->
<h3 class="fn" id="sessionAuthenticationError"><a name="sessionAuthenticationError"></a><code>[signal] </code><span class="type">void</span> EnginioClient::<span class="name">sessionAuthenticationError</span>(<span class="type"><a href="enginioreply.html">EnginioReply</a></span> *<i>reply</i>) const</h3>
<!-- @@@sessionAuthenticationError -->
<!-- $$$sessionTerminated[overload1]$$$sessionTerminated -->
<h3 class="fn" id="sessionTerminated"><a name="sessionTerminated"></a><code>[signal] </code><span class="type">void</span> EnginioClient::<span class="name">sessionTerminated</span>() const</h3>
<!-- @@@sessionTerminated -->
<!-- $$$update[overload1]$$$updateconstQJsonObject&constEnginio::Operation -->
<h3 class="fn" id="update"><a name="update"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">update</span>(const <span class="type">QJsonObject</span> &<i>object</i>, const <span class="type"><a href="enginio.html#Operation-enum">Enginio::Operation</a></span> <i>operation</i> = Enginio::ObjectOperation)</h3>
<p>Update an object in the database.</p>
<p>The <i>operation</i> is the area in which the <i>object</i> gets updated. It defaults to <a href="enginio.html#Operation-enum">Enginio::ObjectOperation</a> to update regular objects by default.</p>
<p>To change the name property of an object to "New Name", use the following JSON:</p>
<pre class="cpp">
{
<span class="string">"id"</span>: <span class="string">"objectId"</span><span class="operator">,</span>
<span class="string">"objectType"</span>: <span class="string">"objects.objectType"</span><span class="operator">,</span>
<span class="string">"name"</span>: <span class="string">"New Name"</span>
}
</pre>
<p>All other existing properties of the object are not affected by the update.</p>
<p>To update the access control list of an object, use the following JSON:</p>
<pre class="cpp">
{
<span class="string">"id"</span>: <span class="string">"objectId"</span><span class="operator">,</span>
<span class="string">"objectType"</span>: <span class="string">"objects.objectType"</span><span class="operator">,</span>
<span class="string">"access"</span>: { <span class="string">"read"</span>: <span class="operator">[</span><span class="string">"id"</span>: <span class="string">"userId"</span><span class="operator">,</span> <span class="string">"objectTypes"</span>: <span class="string">"users"</span><span class="operator">]</span><span class="operator">,</span>
<span class="string">"update"</span>: <span class="operator">[</span><span class="string">"id"</span>: <span class="string">"userId"</span><span class="operator">,</span> <span class="string">"objectTypes"</span>: <span class="string">"users"</span><span class="operator">]</span><span class="operator">,</span>
<span class="string">"admin"</span>: <span class="operator">[</span><span class="string">"id"</span>: <span class="string">"userId"</span><span class="operator">,</span> <span class="string">"objectTypes"</span>: <span class="string">"users"</span><span class="operator">]</span> }
}
</pre>
<p>In C++, the updating of the ACL could be done like this:</p>
<pre class="cpp">
<span class="type">QJsonObject</span> aclUpdate;
aclUpdate<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> obj<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span>;
aclUpdate<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> obj<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span>;
<span class="type">QString</span> json <span class="operator">=</span> <span class="string">"{ \"read\": [ { \"id\": \"%3\", \"objectType\": \"users\" } ],"</span>
<span class="string">"\"update\": [ { \"id\": \"%2\", \"objectType\": \"users\" } ],"</span>
<span class="string">"\"admin\": [ { \"id\": \"%1\", \"objectType\": \"users\" } ] }"</span>;
json <span class="operator">=</span> json<span class="operator">.</span>arg(id1<span class="operator">,</span> id2<span class="operator">,</span> id3);
aclUpdate<span class="operator">[</span><span class="string">"access"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QJsonDocument</span><span class="operator">::</span>fromJson(json<span class="operator">.</span>toUtf8())<span class="operator">.</span>object();
reqId <span class="operator">=</span> client<span class="operator">.</span>update(aclUpdate<span class="operator">,</span> Enginio<span class="operator">::</span>AccessControlOperation);
</pre>
<p>Returns an <a href="enginioreply.html">EnginioReply</a> containing the status of the query and the data once it is finished.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioreply.html">EnginioReply</a>, <a href="enginioclient.html#create">create</a>(), <a href="enginioclient.html#query">query</a>(), and <a href="enginioclient.html#remove">remove</a>().</p>
<!-- @@@update -->
<!-- $$$uploadFile[overload1]$$$uploadFileconstQJsonObject&constQUrl& -->
<h3 class="fn" id="uploadFile"><a name="uploadFile"></a><span class="type"><a href="enginioreply.html">EnginioReply</a></span> *EnginioClient::<span class="name">uploadFile</span>(const <span class="type">QJsonObject</span> &<i>object</i>, const <span class="type">QUrl</span> &<i>file</i>)</h3>
<p>Stores a <i>file</i> attached to an <i>object</i> in Enginio</p>
<p>Each uploaded file needs to be associated with an object in the database.</p>
<p><b>Note: </b>The upload will only work with the propper server setup: in the dashboard create a property of the type that you will use. Set this property to be a reference to files.</p><p>Each uploaded file needs to be associated with an object in the database.</p>
<p>In order to upload a file, first create an object:</p>
<pre class="cpp">
<span class="type">QJsonObject</span> obj;
obj<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"objects.FilesFileUploadDownload"</span>);
<span class="keyword">const</span> EnginioReply<span class="operator">*</span> createReply <span class="operator">=</span> _client<span class="operator">.</span>create(obj);
</pre>
<p>Then do the actual upload:</p>
<pre class="cpp">
<span class="type">QJsonObject</span> object;
object<span class="operator">[</span><span class="string">"id"</span><span class="operator">]</span> <span class="operator">=</span> _id;
object<span class="operator">[</span><span class="string">"objectType"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QString</span><span class="operator">::</span>fromUtf8(<span class="string">"objects.FilesFileUploadDownload"</span>);
object<span class="operator">[</span><span class="string">"propertyName"</span><span class="operator">]</span> <span class="operator">=</span> <span class="type">QStringLiteral</span>(<span class="string">"fileAttachment"</span>);
<span class="type">QJsonObject</span> fileObject;
fileObject<span class="operator">[</span><span class="type">QStringLiteral</span>(<span class="string">"fileName"</span>)<span class="operator">]</span> <span class="operator">=</span> fileName;
<span class="type">QJsonObject</span> uploadJson;
uploadJson<span class="operator">[</span><span class="type">QStringLiteral</span>(<span class="string">"targetFileProperty"</span>)<span class="operator">]</span> <span class="operator">=</span> object;
uploadJson<span class="operator">[</span><span class="type">QStringLiteral</span>(<span class="string">"file"</span>)<span class="operator">]</span> <span class="operator">=</span> fileObject;
<span class="keyword">const</span> EnginioReply <span class="operator">*</span>responseUpload <span class="operator">=</span> _client<span class="operator">.</span>uploadFile(uploadJson<span class="operator">,</span> <span class="type">QUrl</span>(filePath));
</pre>
<p>Note: There is no need to directly delete files. Instead when the object that contains the link to the file gets deleted, the file will automatically be deleted as well.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<p><b>See also </b><a href="enginioclient.html#downloadUrl">downloadUrl</a>().</p>
<!-- @@@uploadFile -->
</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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
4ff6143ff2a088c33c83add3bab6e293
>
files
>
10
