<!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"/> <title>Wt: Wt::Auth::AuthTokenResult Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Wt  <span id="projectnumber">3.2.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.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="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li> <li class="navelem"><a class="el" href="namespaceWt_1_1Auth.html">Auth</a> </li> <li class="navelem"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html">AuthTokenResult</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::Auth::AuthTokenResult Class Reference<div class="ingroups"><a class="el" href="group__auth.html">Authentication module (Wt::Auth)</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::Auth::AuthTokenResult" --> <p>The result of processing an authentication token. <a href="classWt_1_1Auth_1_1AuthTokenResult.html#details">More...</a></p> <p><code>#include <Wt/Auth/AuthService></code></p> <p><a href="classWt_1_1Auth_1_1AuthTokenResult-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">Result</a> { <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdffa0bfa6d1f14a15175cd8042beb334d125">Invalid</a>, <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdffa21ab3cfa507f33322909c29b52859787">Valid</a> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration that describes the result. <a href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#aa610b7efec777ed995c374dc82253388">AuthTokenResult</a> (<a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">Result</a> result, const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user=<a class="el" href="classWt_1_1Auth_1_1User.html">User</a>(), const std::string &newToken=std::string())</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aa610b7efec777ed995c374dc82253388"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2601a90eb5ba52377db2bdaaf71da58"></a><!-- doxytag: member="Wt::Auth::AuthTokenResult::result" ref="aa2601a90eb5ba52377db2bdaaf71da58" args="() const " --> <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#aa2601a90eb5ba52377db2bdaaf71da58">result</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the result. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#acc1d3e2c673247921fab65645fb2b7c6">user</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the identified user. <a href="#acc1d3e2c673247921fab65645fb2b7c6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#ab6a73de35c99a6130e730ec95aacece8">newToken</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a new token for this user. <a href="#ab6a73de35c99a6130e730ec95aacece8"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>The result of processing an authentication token. </p> <p>An authentication token is usually taken from a browser cookie, and used to identify (and possibly authenticate) a user across sessions.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AuthService.html#af830912428ce28663ab6da56f74ff03e" title="Processes an authentication token.">AuthService::processAuthToken()</a> </dd> <dd> <a class="el" href="classWt_1_1Auth_1_1AuthService.html#a43560f963856a0d7f8849be343fad578" title="Creates and stores an authentication token for the user.">AuthService::createAuthToken()</a> </dd></dl> </div><hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="a4766f122c82974cfb531322d9d93bdff"></a><!-- doxytag: member="Wt::Auth::AuthTokenResult::Result" ref="a4766f122c82974cfb531322d9d93bdff" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">Wt::Auth::AuthTokenResult::Result</a></td> </tr> </table> </div> <div class="memdoc"> <p>Enumeration that describes the result. </p> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="a4766f122c82974cfb531322d9d93bdffa0bfa6d1f14a15175cd8042beb334d125"></a><!-- doxytag: member="Invalid" ref="a4766f122c82974cfb531322d9d93bdffa0bfa6d1f14a15175cd8042beb334d125" args="" -->Invalid</em> </td><td> <p>The presented auth token could be used to identify a user. </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a4766f122c82974cfb531322d9d93bdffa21ab3cfa507f33322909c29b52859787"></a><!-- doxytag: member="Valid" ref="a4766f122c82974cfb531322d9d93bdffa21ab3cfa507f33322909c29b52859787" args="" -->Valid</em> </td><td> <p>The presented auth token was invalid. </p> </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa610b7efec777ed995c374dc82253388"></a><!-- doxytag: member="Wt::Auth::AuthTokenResult::AuthTokenResult" ref="aa610b7efec777ed995c374dc82253388" args="(Result result, const User &user=User(), const std::string &newToken=std::string())" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Wt::Auth::AuthTokenResult::AuthTokenResult </td> <td>(</td> <td class="paramtype"><a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#a4766f122c82974cfb531322d9d93bdff">Result</a> </td> <td class="paramname"><em>result</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td> <td class="paramname"><em>user</em> = <code><a class="el" href="classWt_1_1Auth_1_1User.html">User</a>()</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>newToken</em> = <code>std::string()</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <p>Creates an authentication token result. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab6a73de35c99a6130e730ec95aacece8"></a><!-- doxytag: member="Wt::Auth::AuthTokenResult::newToken" ref="ab6a73de35c99a6130e730ec95aacece8" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Wt::Auth::AuthTokenResult::newToken </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns a new token for this user. </p> <p>An authentication token can be used only once, and needs to be replaced by a new token.</p> <p>The returned token is valid only if the <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#aa2601a90eb5ba52377db2bdaaf71da58" title="Returns the result.">result()</a> == Valid. </p> </div> </div> <a class="anchor" id="acc1d3e2c673247921fab65645fb2b7c6"></a><!-- doxytag: member="Wt::Auth::AuthTokenResult::user" ref="acc1d3e2c673247921fab65645fb2b7c6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & Wt::Auth::AuthTokenResult::user </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the identified user. </p> <p>The user is valid only if the the <a class="el" href="classWt_1_1Auth_1_1AuthTokenResult.html#aa2601a90eb5ba52377db2bdaaf71da58" title="Returns the result.">result()</a> == Valid. </p> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></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> <hr size="1"><address style="text-align: right; margin: 3px"><small> Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the C++ Web Toolkit (Wt)</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0" style="vertical-align: middle; display: inline-block; height: 2em"></a> 1.7.5.1</small></address> </body> </html>