<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.9.1"/> <title>Helix Web Services Client: hws/Client.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Helix Web Services Client  <span id="projectnumber">1</span> </div> <div id="projectbrief">Helix Web Services Client SDK for Qt Applications</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_df4b35d643e8581cc301a008445d7803.html">hws</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">Client.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __HWS_CLIENT_H__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __HWS_CLIENT_H__</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <QObject></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <QSettings></span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <QSharedPointer></span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <QUrl></span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <QVariant></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "Session.h"</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "RequestError.h"</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="namespacehws.html">hws</a></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div> <div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classhws_1_1_client.html"> 16</a></span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_client.html">Client</a> : <span class="keyword">public</span> QObject</div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  {</div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  Q_OBJECT</div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// Most of our return results are returned as this consistent format.</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">typedef</span> QList<QVariantMap> QVariantMapList;</div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">// URL parameters must be converted to string values.</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Note that this API will handle the URI encoding.</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">typedef</span> QHash<QString, QString> QStringHash;</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// Initialize a client with a specific HWS url.</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classhws_1_1_client.html">Client</a>(QObject *parent, QUrl <a class="code" href="classhws_1_1_client.html#a25eb8861db7a617ec9e197105da32e59">url</a>);</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classhws_1_1_client.html">Client</a>(QObject *parent);</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classhws_1_1_client.html#a7e29becd0de1df4fb76c02c2b0ada0aa">~Client</a>();</div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">const</span> QUrl & <a class="code" href="classhws_1_1_client.html#a25eb8861db7a617ec9e197105da32e59">url</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a457086d9086e7ffe12e8250f40531725">setUrl</a>(<span class="keyword">const</span> QUrl & url);</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">bool</span> <a class="code" href="classhws_1_1_client.html#a5edcfa7a2672bd5fd7c1bd43d05ada11">hasSession</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> <a class="code" href="classhws_1_1_session.html">Session</a> & <a class="code" href="classhws_1_1_client.html#a7f71e48853bfa39f72c512a146265b78">session</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a6efcd5fd29ed6a73b94fb3f27bf75b84">setSession</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_session.html">Session</a> & session);</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_client.html#ad11b170cf905b0a73b8e55df14c3c923">hwsPrefixPath</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a6f108e176a3e656bbcc923e08cd19b59">setHWSPrefixPath</a>(<span class="keyword">const</span> QString & path);</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_client.html#abb504cddae9ae34ec3b51bd18fe570d2">settingsKey</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> QSharedPointer<QSettings> <a class="code" href="classhws_1_1_client.html#a3876d0cdb16e97c2a179c200b9057eb0">settings</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#ab3c5204b9cb7f42f81b80bc1e541e14e">setSettings</a>(QSharedPointer<QSettings> settings);</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a58046690b16052bc32345909dec44647">addRequestConfig</a>(QString key, QString value);</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a65a2fb65081217264a96daef101708eb">ignoreSslErrors</a>(<span class="keywordtype">bool</span> ignore);</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">public</span> slots:</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a948cd4e143d62034afd493c18099c4b7">validateSession</a>();</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#ac87a65bae065cbd0b1e1f6abc2c06242">logIn</a>(<span class="keyword">const</span> QString & user, <span class="keyword">const</span> QString & password);</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#aa08a1c9b59d6de53e38e22c22714402a">executeMethod</a>(<span class="keyword">const</span> QString & method, <span class="keyword">const</span> QString & path,</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> QSharedPointer<QStringHash> params = QSharedPointer<QStringHash>(),</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> QSharedPointer<QByteArray> body = QSharedPointer<QByteArray>());</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#aa08a1c9b59d6de53e38e22c22714402a">executeMethod</a>(<span class="keyword">const</span> QString & method, <span class="keyword">const</span> QString & path,</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">const</span> QSharedPointer<QStringHash> params,</div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> QVariantMap & body);</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#aa08a1c9b59d6de53e38e22c22714402a">executeMethod</a>(<span class="keyword">const</span> QString & method, <span class="keyword">const</span> QString & path,</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> QSharedPointer<QStringHash> params,</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">const</span> QVariantMapList & body);</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  signals:</div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a6a866b9ad11dedb70f2908da60a68a32">validateSessionDone</a>(RequestErrorPtr error);</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a8020be14b02290e325e2addb4cd205ad">logInDone</a>(RequestErrorPtr error, SessionPtr session);</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_client.html#a80c0f9f416a31e17fe3280016397e96b">executeMethodDone</a>(RequestErrorPtr error,</div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keyword">const</span> QString & method,</div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keyword">const</span> QString & path,</div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keyword">const</span> QSharedPointer<QVariantMapList> body);</div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="comment">// Implementation is hidden using PIMPL technique.</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="comment">// I'm hiding the direct include dependencies on Qt5Network and</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="comment">// Qt5WebSockets.</span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_client_1_1_impl.html">Impl</a>;</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_client_1_1_log_in_finished.html">LogInFinished</a>;</div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_client_1_1_execute_method_finished.html">ExecuteMethodFinished</a>;</div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <a class="code" href="classhws_1_1_client_1_1_impl.html">Impl</a> *mImpl;</div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="comment">// Disabled methods</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="classhws_1_1_client.html">Client</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_client.html">Client</a> &);</div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="classhws_1_1_client.html">Client</a> & operator=(<span class="keyword">const</span> <a class="code" href="classhws_1_1_client.html">Client</a> &);</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  };</div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">typedef</span> QSharedPointer<Client> ClientPtr;</div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> }</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="preprocessor">#endif </span><span class="comment">/* __HWS_CLIENT_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="classhws_1_1_client_html_a948cd4e143d62034afd493c18099c4b7"><div class="ttname"><a href="classhws_1_1_client.html#a948cd4e143d62034afd493c18099c4b7">hws::Client::validateSession</a></div><div class="ttdeci">void validateSession()</div><div class="ttdef"><b>Definition:</b> Client.cpp:571</div></div> <div class="ttc" id="classhws_1_1_client_html_ab3c5204b9cb7f42f81b80bc1e541e14e"><div class="ttname"><a href="classhws_1_1_client.html#ab3c5204b9cb7f42f81b80bc1e541e14e">hws::Client::setSettings</a></div><div class="ttdeci">void setSettings(QSharedPointer< QSettings > settings)</div><div class="ttdoc">The current settings handle for the client. </div></div> <div class="ttc" id="classhws_1_1_client_1_1_impl_html"><div class="ttname"><a href="classhws_1_1_client_1_1_impl.html">hws::Client::Impl</a></div><div class="ttdef"><b>Definition:</b> Client.cpp:25</div></div> <div class="ttc" id="classhws_1_1_client_html_ac87a65bae065cbd0b1e1f6abc2c06242"><div class="ttname"><a href="classhws_1_1_client.html#ac87a65bae065cbd0b1e1f6abc2c06242">hws::Client::logIn</a></div><div class="ttdeci">void logIn(const QString &user, const QString &password)</div><div class="ttdef"><b>Definition:</b> Client.cpp:592</div></div> <div class="ttc" id="namespacehws_html"><div class="ttname"><a href="namespacehws.html">hws</a></div><div class="ttdef"><b>Definition:</b> hws.h:63</div></div> <div class="ttc" id="classhws_1_1_client_html_a3876d0cdb16e97c2a179c200b9057eb0"><div class="ttname"><a href="classhws_1_1_client.html#a3876d0cdb16e97c2a179c200b9057eb0">hws::Client::settings</a></div><div class="ttdeci">const QSharedPointer< QSettings > settings() const </div></div> <div class="ttc" id="classhws_1_1_client_html_a80c0f9f416a31e17fe3280016397e96b"><div class="ttname"><a href="classhws_1_1_client.html#a80c0f9f416a31e17fe3280016397e96b">hws::Client::executeMethodDone</a></div><div class="ttdeci">void executeMethodDone(RequestErrorPtr error, const QString &method, const QString &path, const QSharedPointer< QVariantMapList > body)</div></div> <div class="ttc" id="classhws_1_1_client_html"><div class="ttname"><a href="classhws_1_1_client.html">hws::Client</a></div><div class="ttdoc">Front end to making requests against the Phoenix web services API. </div><div class="ttdef"><b>Definition:</b> Client.h:16</div></div> <div class="ttc" id="classhws_1_1_session_html"><div class="ttname"><a href="classhws_1_1_session.html">hws::Session</a></div><div class="ttdoc">The HWS Session, that owns our security token. </div><div class="ttdef"><b>Definition:</b> Session.h:22</div></div> <div class="ttc" id="classhws_1_1_client_html_ad11b170cf905b0a73b8e55df14c3c923"><div class="ttname"><a href="classhws_1_1_client.html#ad11b170cf905b0a73b8e55df14c3c923">hws::Client::hwsPrefixPath</a></div><div class="ttdeci">const QString & hwsPrefixPath() const </div><div class="ttdef"><b>Definition:</b> Client.cpp:550</div></div> <div class="ttc" id="classhws_1_1_client_html_a7e29becd0de1df4fb76c02c2b0ada0aa"><div class="ttname"><a href="classhws_1_1_client.html#a7e29becd0de1df4fb76c02c2b0ada0aa">hws::Client::~Client</a></div><div class="ttdeci">~Client()</div><div class="ttdef"><b>Definition:</b> Client.cpp:520</div></div> <div class="ttc" id="classhws_1_1_client_html_a58046690b16052bc32345909dec44647"><div class="ttname"><a href="classhws_1_1_client.html#a58046690b16052bc32345909dec44647">hws::Client::addRequestConfig</a></div><div class="ttdeci">void addRequestConfig(QString key, QString value)</div><div class="ttdef"><b>Definition:</b> Client.cpp:560</div></div> <div class="ttc" id="classhws_1_1_client_html_a8020be14b02290e325e2addb4cd205ad"><div class="ttname"><a href="classhws_1_1_client.html#a8020be14b02290e325e2addb4cd205ad">hws::Client::logInDone</a></div><div class="ttdeci">void logInDone(RequestErrorPtr error, SessionPtr session)</div></div> <div class="ttc" id="classhws_1_1_client_html_a6f108e176a3e656bbcc923e08cd19b59"><div class="ttname"><a href="classhws_1_1_client.html#a6f108e176a3e656bbcc923e08cd19b59">hws::Client::setHWSPrefixPath</a></div><div class="ttdeci">void setHWSPrefixPath(const QString &path)</div><div class="ttdef"><b>Definition:</b> Client.cpp:555</div></div> <div class="ttc" id="classhws_1_1_client_html_abb504cddae9ae34ec3b51bd18fe570d2"><div class="ttname"><a href="classhws_1_1_client.html#abb504cddae9ae34ec3b51bd18fe570d2">hws::Client::settingsKey</a></div><div class="ttdeci">const QString & settingsKey() const </div></div> <div class="ttc" id="classhws_1_1_client_html_a5edcfa7a2672bd5fd7c1bd43d05ada11"><div class="ttname"><a href="classhws_1_1_client.html#a5edcfa7a2672bd5fd7c1bd43d05ada11">hws::Client::hasSession</a></div><div class="ttdeci">bool hasSession() const </div><div class="ttdef"><b>Definition:</b> Client.cpp:535</div></div> <div class="ttc" id="classhws_1_1_client_1_1_execute_method_finished_html"><div class="ttname"><a href="classhws_1_1_client_1_1_execute_method_finished.html">hws::Client::ExecuteMethodFinished</a></div><div class="ttdef"><b>Definition:</b> Client.cpp:204</div></div> <div class="ttc" id="classhws_1_1_client_html_a457086d9086e7ffe12e8250f40531725"><div class="ttname"><a href="classhws_1_1_client.html#a457086d9086e7ffe12e8250f40531725">hws::Client::setUrl</a></div><div class="ttdeci">void setUrl(const QUrl &url)</div><div class="ttdoc">The Helix Web Services URL. </div><div class="ttdef"><b>Definition:</b> Client.cpp:525</div></div> <div class="ttc" id="classhws_1_1_client_html_a65a2fb65081217264a96daef101708eb"><div class="ttname"><a href="classhws_1_1_client.html#a65a2fb65081217264a96daef101708eb">hws::Client::ignoreSslErrors</a></div><div class="ttdeci">void ignoreSslErrors(bool ignore)</div><div class="ttdef"><b>Definition:</b> Client.cpp:565</div></div> <div class="ttc" id="classhws_1_1_client_html_aa08a1c9b59d6de53e38e22c22714402a"><div class="ttname"><a href="classhws_1_1_client.html#aa08a1c9b59d6de53e38e22c22714402a">hws::Client::executeMethod</a></div><div class="ttdeci">void executeMethod(const QString &method, const QString &path, const QSharedPointer< QStringHash > params=QSharedPointer< QStringHash >(), const QSharedPointer< QByteArray > body=QSharedPointer< QByteArray >())</div><div class="ttdef"><b>Definition:</b> Client.cpp:620</div></div> <div class="ttc" id="classhws_1_1_client_html_a25eb8861db7a617ec9e197105da32e59"><div class="ttname"><a href="classhws_1_1_client.html#a25eb8861db7a617ec9e197105da32e59">hws::Client::url</a></div><div class="ttdeci">const QUrl & url() const </div><div class="ttdoc">The Helix Web Services URL. </div><div class="ttdef"><b>Definition:</b> Client.cpp:530</div></div> <div class="ttc" id="classhws_1_1_client_html_a7f71e48853bfa39f72c512a146265b78"><div class="ttname"><a href="classhws_1_1_client.html#a7f71e48853bfa39f72c512a146265b78">hws::Client::session</a></div><div class="ttdeci">const Session & session() const </div><div class="ttdoc">The session instance is required before making any remote call. </div><div class="ttdef"><b>Definition:</b> Client.cpp:540</div></div> <div class="ttc" id="classhws_1_1_client_html_a6a866b9ad11dedb70f2908da60a68a32"><div class="ttname"><a href="classhws_1_1_client.html#a6a866b9ad11dedb70f2908da60a68a32">hws::Client::validateSessionDone</a></div><div class="ttdeci">void validateSessionDone(RequestErrorPtr error)</div></div> <div class="ttc" id="classhws_1_1_client_1_1_log_in_finished_html"><div class="ttname"><a href="classhws_1_1_client_1_1_log_in_finished.html">hws::Client::LogInFinished</a></div><div class="ttdef"><b>Definition:</b> Client.cpp:172</div></div> <div class="ttc" id="classhws_1_1_client_html_a6efcd5fd29ed6a73b94fb3f27bf75b84"><div class="ttname"><a href="classhws_1_1_client.html#a6efcd5fd29ed6a73b94fb3f27bf75b84">hws::Client::setSession</a></div><div class="ttdeci">void setSession(const Session &session)</div><div class="ttdef"><b>Definition:</b> Client.cpp:545</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Mon Aug 31 2015 09:11:40 for Helix Web Services Client by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.9.1 </small></address> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 15741 | ptomiak | Branch HWS for my use. | ||
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services_client_qt/html/_client_8h_source.html | |||||
#8 | 15578 | tjuricek |
Removing QSettings* usage from hws::Client. The way QSettings was being used only is relevant for one connection at a time, and, it didn't seem to work on windows nicely anyway. |
||
#7 | 15544 | tjuricek | Explain that the QSettings handle for hws::Client should only be used on connections you don't specify a P4PORT for. | ||
#6 | 15447 | tjuricek |
Add simple Example application to list "projects" in a HVE instance. Qt's a little weird to follow, so I may have to find a different kind of example to write. It does work, however. |
||
#5 | 15423 | tjuricek |
Revised HWS Qt API. This is a major revision of the API, which removes most of the "typed" data, replacing it with a more generic "executeMethodDone" callback. The main benefit here is to allow the API to interop with different versions of p4d, and not restrict the methods it can call. We may add more helpers in the future. |
||
#4 | 14054 | tjuricek |
Allowing the Qt client to select 'all' vs 'my' projects. Right now, it should default to using "my" projects as a rule. |
||
#3 | 14049 | tjuricek |
Add methods to generate client workspaces for a user. The Qt SDK was updated based on immediate need. Also, add Ruby client SDK documentation to the docs site. Everything is early, but there's *some* reference available at least. |
||
#2 | 14026 | tjuricek | Revise example code on main page of Qt SDK | ||
#1 | 14025 | tjuricek |
Revise Qt SDK to a single 'helix_web_services_client' project. Most references to "Phoenix" have now been removed. Additionally, this is more similar to the other platform client SDKs in Ruby and JavaScript. Documentation via Doxygen is now available, and will be how much of the SDK reference should occur. |