Wt  3.7.1
Public Types | Public Member Functions | List of all members
Wt::Auth::AuthTokenResult Class Reference

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(), int newTokenValidity=-1)
 Constructor. More...
Result result () const
 Returns the result.
const Useruser () const
 Returns the identified user. More...
std::string newToken () const
 Returns a new token for this user. More...
int newTokenValidity () const
 Returns the validity of the new token. More...

Detailed Description

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.

See also

Member Enumeration Documentation

◆ Result

Enumeration that describes the result.


The presented auth token could be used to identify a user.


The presented auth token was invalid.

Constructor & Destructor Documentation

◆ AuthTokenResult()

Wt::Auth::AuthTokenResult::AuthTokenResult ( Result  result,
const User user = User(),
const std::string &  newToken = std::string(),
int  newTokenValidity = -1 


Creates an authentication token result.

Member Function Documentation

◆ newToken()

std::string Wt::Auth::AuthTokenResult::newToken ( ) const

Returns a new token for this user.

Returns the empty string if there is no new token. See AuthService::authTokenUpdateEnabled().

The returned token is valid only if the result() == Valid.

◆ newTokenValidity()

int Wt::Auth::AuthTokenResult::newTokenValidity ( ) const

Returns the validity of the new token.

This returns the token validity in seconds.

Returns -1 if there is no new token, or result() != Valid.

See also

◆ user()

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

Returns the identified user.

The user is valid only if the the result() == Valid.

Generated on Tue Dec 15 2020 for the C++ Web Toolkit (Wt) by doxygen 1.8.13