<!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::EmailTokenResult 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_1EmailTokenResult.html">EmailTokenResult</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::EmailTokenResult 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::EmailTokenResult" -->
<p>The result of processing an email-sent token.
<a href="classWt_1_1Auth_1_1EmailTokenResult.html#details">More...</a></p>
<p><code>#include <Wt/Auth/AuthService></code></p>
<p><a href="classWt_1_1Auth_1_1EmailTokenResult-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_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">Result</a> { <a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eafaf6c283592174f03bb4d8cf46dd9da62a">Invalid</a>,
<a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eafad07856f7ace97bf7422c58ecfd8d5b91">Expired</a>,
<a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eafa3923ca0fd4c0d28ce792c544d3888c5d">UpdatePassword</a>,
<a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eafa1a3e804bef16c7265a75b6401e10cf94">EmailConfirmed</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration that describes the result. <a href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">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_1EmailTokenResult.html#ad1df317d1e13fcfad36cf69add76ddd0">EmailTokenResult</a> (<a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">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>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ad1df317d1e13fcfad36cf69add76ddd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f3834ea76e8baebbb8f54ae2be900a8"></a><!-- doxytag: member="Wt::Auth::EmailTokenResult::result" ref="a3f3834ea76e8baebbb8f54ae2be900a8" args="() const " -->
<a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a3f3834ea76e8baebbb8f54ae2be900a8">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_1EmailTokenResult.html#aca17f0b9d711b3789da4f6d008425373">user</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user, if any. <a href="#aca17f0b9d711b3789da4f6d008425373"></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 email-sent token. </p>
<p>An email token can be used for two purposes:</p>
<ul>
<li>the user needs to verify his email address by returning a token sent to his supplied email address.</li>
<li>the user indicates that he lost his email and wants to prove his identity by acknowledging an email to a previously verified email account.</li>
</ul>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AuthService.html#a0c09fb5aa0e54aa1da0069ad7b116436" title="Processes an email token.">AuthService::processEmailToken()</a> </dd>
<dd>
<a class="el" href="classWt_1_1Auth_1_1AuthService.html#a4c34af5f36ba29b35cd457744fbd4bfe" title="Verifies an email address.">AuthService::verifyEmailAddress()</a>, <a class="el" href="classWt_1_1Auth_1_1AuthService.html#ae296f0f6cf5d481d3442724ca813b05d" title="Implements lost password functionality.">AuthService::lostPassword()</a> </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a02d298e2e759bf496a1648feec3d5eaf"></a><!-- doxytag: member="Wt::Auth::EmailTokenResult::Result" ref="a02d298e2e759bf496a1648feec3d5eaf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">Wt::Auth::EmailTokenResult::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="a02d298e2e759bf496a1648feec3d5eafaf6c283592174f03bb4d8cf46dd9da62a"></a><!-- doxytag: member="Invalid" ref="a02d298e2e759bf496a1648feec3d5eafaf6c283592174f03bb4d8cf46dd9da62a" args="" -->Invalid</em> </td><td>
<p>The token was invalid. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a02d298e2e759bf496a1648feec3d5eafad07856f7ace97bf7422c58ecfd8d5b91"></a><!-- doxytag: member="Expired" ref="a02d298e2e759bf496a1648feec3d5eafad07856f7ace97bf7422c58ecfd8d5b91" args="" -->Expired</em> </td><td>
<p>The token has expired. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a02d298e2e759bf496a1648feec3d5eafa3923ca0fd4c0d28ce792c544d3888c5d"></a><!-- doxytag: member="UpdatePassword" ref="a02d298e2e759bf496a1648feec3d5eafa3923ca0fd4c0d28ce792c544d3888c5d" args="" -->UpdatePassword</em> </td><td>
<p>A token was presented which requires the user to enter a new password. </p>
<p>The presented token was a token sent by the <a class="el" href="classWt_1_1Auth_1_1AuthService.html#ae296f0f6cf5d481d3442724ca813b05d" title="Implements lost password functionality.">AuthService::lostPassword()</a> function. When this is returned as result of <a class="el" href="classWt_1_1Auth_1_1AuthService.html#a0c09fb5aa0e54aa1da0069ad7b116436" title="Processes an email token.">AuthService::processEmailToken()</a>, you should present the user with a dialog where he can enter a new password. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a02d298e2e759bf496a1648feec3d5eafa1a3e804bef16c7265a75b6401e10cf94"></a><!-- doxytag: member="EmailConfirmed" ref="a02d298e2e759bf496a1648feec3d5eafa1a3e804bef16c7265a75b6401e10cf94" args="" -->EmailConfirmed</em> </td><td>
<p>A The token was presented which verifies the email address. </p>
<p>The presented token was a token sent by the <a class="el" href="classWt_1_1Auth_1_1AuthService.html#a4c34af5f36ba29b35cd457744fbd4bfe" title="Verifies an email address.">AuthService::verifyEmailAddress()</a> function. When this is returned as result of processEmailToken(), you can indicate to the user that his email address is now confirmed. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad1df317d1e13fcfad36cf69add76ddd0"></a><!-- doxytag: member="Wt::Auth::EmailTokenResult::EmailTokenResult" ref="ad1df317d1e13fcfad36cf69add76ddd0" args="(Result result, const User &user=User())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Auth::EmailTokenResult::EmailTokenResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Auth_1_1EmailTokenResult.html#a02d298e2e759bf496a1648feec3d5eaf">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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Creates an email token result. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aca17f0b9d711b3789da4f6d008425373"></a><!-- doxytag: member="Wt::Auth::EmailTokenResult::user" ref="aca17f0b9d711b3789da4f6d008425373" 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::EmailTokenResult::user </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the user, if any. </p>
<p>The identified user is only valid when the token result is UpdatePassword or EmailConfirmed. In that case, you may login the user as strongly authenticated since he presented a random token that was sent to his own email address. </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>
