<!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::Session Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><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="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</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"><b>hws</b></li><li class="navelem"><a class="el" href="classhws_1_1_session.html">Session</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classhws_1_1_session-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">hws::Session Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The HWS <a class="el" href="classhws_1_1_session.html" title="The HWS Session, that owns our security token. ">Session</a>, that owns our security token. <a href="classhws_1_1_session.html#details">More...</a></p> <p><code>#include <<a class="el" href="_session_8h_source.html">Session.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a03378976af7f8bff08210df29683c4f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03378976af7f8bff08210df29683c4f8"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a03378976af7f8bff08210df29683c4f8">Session</a> ()</td></tr> <tr class="memdesc:a03378976af7f8bff08210df29683c4f8"><td class="mdescLeft"> </td><td class="mdescRight">New empty session. <br /></td></tr> <tr class="separator:a03378976af7f8bff08210df29683c4f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a95fe3885484fcb3620683e1094345e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a95fe3885484fcb3620683e1094345e"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a7a95fe3885484fcb3620683e1094345e">Session</a> (const <a class="el" href="classhws_1_1_session.html">Session</a> &s)</td></tr> <tr class="memdesc:a7a95fe3885484fcb3620683e1094345e"><td class="mdescLeft"> </td><td class="mdescRight">Copy a session from an existing <a class="el" href="classhws_1_1_session.html" title="The HWS Session, that owns our security token. ">Session</a> state. <br /></td></tr> <tr class="separator:a7a95fe3885484fcb3620683e1094345e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a42c6d4ccbd2aec5f37890e666d7c4a18"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42c6d4ccbd2aec5f37890e666d7c4a18"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a42c6d4ccbd2aec5f37890e666d7c4a18">~Session</a> ()</td></tr> <tr class="memdesc:a42c6d4ccbd2aec5f37890e666d7c4a18"><td class="mdescLeft"> </td><td class="mdescRight">Typical destructor. <br /></td></tr> <tr class="separator:a42c6d4ccbd2aec5f37890e666d7c4a18"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a281479ea5038543fe1dcbc23483b6bdb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a281479ea5038543fe1dcbc23483b6bdb"></a> <a class="el" href="classhws_1_1_session.html">Session</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a281479ea5038543fe1dcbc23483b6bdb">operator=</a> (const <a class="el" href="classhws_1_1_session.html">Session</a> &s)</td></tr> <tr class="memdesc:a281479ea5038543fe1dcbc23483b6bdb"><td class="mdescLeft"> </td><td class="mdescRight">Copy session state from an existing session. <br /></td></tr> <tr class="separator:a281479ea5038543fe1dcbc23483b6bdb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a921cad1f5e8ffcafff080d69b3a95da0"><td class="memItemLeft" align="right" valign="top">const QUrl & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a921cad1f5e8ffcafff080d69b3a95da0">url</a> () const </td></tr> <tr class="separator:a921cad1f5e8ffcafff080d69b3a95da0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acf224543a66a23d1683047816cb73758"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf224543a66a23d1683047816cb73758"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#acf224543a66a23d1683047816cb73758">setUrl</a> (const QUrl &<a class="el" href="classhws_1_1_session.html#a921cad1f5e8ffcafff080d69b3a95da0">url</a>)</td></tr> <tr class="memdesc:acf224543a66a23d1683047816cb73758"><td class="mdescLeft"> </td><td class="mdescRight">Set the Helix Web Services URL. <br /></td></tr> <tr class="separator:acf224543a66a23d1683047816cb73758"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad9d445d6f576340b04469bee6633e78f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9d445d6f576340b04469bee6633e78f"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#ad9d445d6f576340b04469bee6633e78f">user</a> () const </td></tr> <tr class="memdesc:ad9d445d6f576340b04469bee6633e78f"><td class="mdescLeft"> </td><td class="mdescRight">The Perforce login associated with this session. <br /></td></tr> <tr class="separator:ad9d445d6f576340b04469bee6633e78f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af0b0bb618c362db186e30327cd2a6ca8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0b0bb618c362db186e30327cd2a6ca8"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#af0b0bb618c362db186e30327cd2a6ca8">setUser</a> (const QString &<a class="el" href="classhws_1_1_session.html#ad9d445d6f576340b04469bee6633e78f">user</a>)</td></tr> <tr class="memdesc:af0b0bb618c362db186e30327cd2a6ca8"><td class="mdescLeft"> </td><td class="mdescRight">Set the Perforce login name. <br /></td></tr> <tr class="separator:af0b0bb618c362db186e30327cd2a6ca8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9f35790a3ebabeb334019f861d75e2e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f35790a3ebabeb334019f861d75e2e1"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a9f35790a3ebabeb334019f861d75e2e1">token</a> () const </td></tr> <tr class="memdesc:a9f35790a3ebabeb334019f861d75e2e1"><td class="mdescLeft"> </td><td class="mdescRight">The Phoenix services security token that's used by all web calls. <br /></td></tr> <tr class="separator:a9f35790a3ebabeb334019f861d75e2e1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af41bdd9bc108e45a8f52fdb99e308ba2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af41bdd9bc108e45a8f52fdb99e308ba2"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#af41bdd9bc108e45a8f52fdb99e308ba2">setToken</a> (const QString &<a class="el" href="classhws_1_1_session.html#a9f35790a3ebabeb334019f861d75e2e1">token</a>)</td></tr> <tr class="memdesc:af41bdd9bc108e45a8f52fdb99e308ba2"><td class="mdescLeft"> </td><td class="mdescRight">Set the security token used for authenticating web calls. <br /></td></tr> <tr class="separator:af41bdd9bc108e45a8f52fdb99e308ba2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0f4e8a74610d6b59159bf6f7f952f031"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#a0f4e8a74610d6b59159bf6f7f952f031">p4Ticket</a> () const </td></tr> <tr class="separator:a0f4e8a74610d6b59159bf6f7f952f031"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad94c071f56054f877e45f7a76ad0f872"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad94c071f56054f877e45f7a76ad0f872"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#ad94c071f56054f877e45f7a76ad0f872">setP4Ticket</a> (const QString &ticket)</td></tr> <tr class="memdesc:ad94c071f56054f877e45f7a76ad0f872"><td class="mdescLeft"> </td><td class="mdescRight">Set the P4 ticket to be used by the client. <br /></td></tr> <tr class="separator:ad94c071f56054f877e45f7a76ad0f872"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc9af6a7b3ebc4e297c1eb5f0aa939ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc9af6a7b3ebc4e297c1eb5f0aa939ef"></a> QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_session.html#afc9af6a7b3ebc4e297c1eb5f0aa939ef">toString</a> ()</td></tr> <tr class="memdesc:afc9af6a7b3ebc4e297c1eb5f0aa939ef"><td class="mdescLeft"> </td><td class="mdescRight">Debugging representation of the <a class="el" href="classhws_1_1_session.html" title="The HWS Session, that owns our security token. ">Session</a>. <br /></td></tr> <tr class="separator:afc9af6a7b3ebc4e297c1eb5f0aa939ef"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The HWS <a class="el" href="classhws_1_1_session.html" title="The HWS Session, that owns our security token. ">Session</a>, that owns our security token. </p> <p>This is the data associated with a web session. This should be locally serializable. Each web session gets assigned a security token for making subsequent calls to the web API.</p> <p>Additionally, you <em>also</em> get a P4 Ticket for use on the local machine. This is an extension to our core authorization mechanism. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a0f4e8a74610d6b59159bf6f7f952f031"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const QString & hws::Session::p4Ticket </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>The p4 ticket that should be host-locked to the user's machine that created the session. </p> </div> </div> <a class="anchor" id="a921cad1f5e8ffcafff080d69b3a95da0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const QUrl & hws::Session::url </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>This is the Helix Web Services URL. You can't reuse a session from one server to another. </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>hws/<a class="el" href="_session_8h_source.html">Session.h</a></li> <li>hws/Session.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jun 19 2015 16:38:20 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 | |
---|---|---|---|---|---|
#9 | 15686 | tjuricek | Removed Qt SDK (will be maintained with Helix Sync), updated README | ||
#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. |