Wt
3.3.0
|
The result of processing an authentication token. More...
#include <Wt/Auth/AuthService>
Public Types | |
enum | Result { Invalid, Valid } |
Enumeration that describes the result. More... | |
Public Member Functions | |
AuthTokenResult (Result result, const User &user=User(), const std::string &newToken=std::string()) | |
Constructor. | |
Result | result () const |
Returns the result. | |
const User & | user () const |
Returns the identified user. | |
std::string | newToken () const |
Returns a new token for this user. |
The result of processing an authentication token.
An authentication token is usually taken from a browser cookie, and used to identify (and possibly authenticate) a user across sessions.
Wt::Auth::AuthTokenResult::AuthTokenResult | ( | Result | result, |
const User & | user = User() , |
||
const std::string & | newToken = std::string() |
||
) |
Constructor.
Creates an authentication token result.
std::string Wt::Auth::AuthTokenResult::newToken | ( | ) | const |
Returns a new token for this user.
An authentication token can be used only once, and needs to be replaced by a new token.
The returned token is valid only if the result() == Valid.