Wt  4.0.2
Public Types | Public Member Functions | List of all members
Wt::Auth::EmailTokenResult Class Reference

The result of processing an email-sent token. More...

#include <Wt/Auth/AuthService.h>

Public Types

typedef EmailTokenState State
 Typedef for enum Wt::Auth::EmailTokenState.
 

Public Member Functions

 EmailTokenResult (EmailTokenState state, const User &user=User())
 Constructor. More...
 
EmailTokenState state () const
 Returns the result.
 
const Useruser () const
 Returns the user, if any. More...
 

Detailed Description

The result of processing an email-sent token.

An email token can be used for two purposes:

See also
AuthService::processEmailToken()
AuthService::verifyEmailAddress(), AuthService::lostPassword()

Constructor & Destructor Documentation

Wt::Auth::EmailTokenResult::EmailTokenResult ( EmailTokenState  state,
const User user = User() 
)

Constructor.

Creates an email token result.

Member Function Documentation

const User & Wt::Auth::EmailTokenResult::user ( ) const

Returns the user, if any.

The identified user is only valid when the token state 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.


Generated on Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11