AuthDelegate::OAuth2Token Class Reference

A class containing access token info provided by an application. More...

#include <src/api/mip/common_types.h>

Collaboration diagram for AuthDelegate::OAuth2Token:

Public Member Functions
const std::string &	GetAccessToken () const
	Get the access token string.
const std::string &	GetErrorMessage () const
	Get the error message, if any.
	OAuth2Token ()
	Construct a new OAuth2Token object.
	OAuth2Token (const std::string &accessToken)
	Construct a new OAuth2Token object from JWT access token.
void	SetAccessToken (const std::string &accessToken)
	Set the access token string.
void	SetErrorMessage (const std::string &errorMessage)
	Set the error message.

Private Attributes
std::string	mAccessToken
std::string	mErrorMessage

Detailed Description

A class containing access token info provided by an application.

Definition at line 381 of file common_types.h.

Constructor & Destructor Documentation

OAuth2Token() [1/2]

AuthDelegate::OAuth2Token::OAuth2Token ( )

inline

Construct a new OAuth2Token object.

Definition at line 386 of file common_types.h.

{}

OAuth2Token() [2/2]

AuthDelegate::OAuth2Token::OAuth2Token ( const std::string & accessToken )

inline

Construct a new OAuth2Token object from JWT access token.

Parameters

accessToken

JWT access token.

Definition at line 393 of file common_types.h.

: mAccessToken(accessToken) {}

Member Function Documentation

GetAccessToken()

const std::string & AuthDelegate::OAuth2Token::GetAccessToken ( ) const

inline

Get the access token string.

Returns

Access token string.

Definition at line 400 of file common_types.h.

{ return mAccessToken; }

References mAccessToken.

GetErrorMessage()

const std::string & AuthDelegate::OAuth2Token::GetErrorMessage ( ) const

inline

Get the error message, if any.

Returns

Error message.

Definition at line 414 of file common_types.h.

{ return mErrorMessage; }

References mErrorMessage.

SetAccessToken()

void AuthDelegate::OAuth2Token::SetAccessToken ( const std::string & accessToken )

inline

Set the access token string.

Parameters

accessToken

Access token string.

Definition at line 407 of file common_types.h.

{ mAccessToken = accessToken; }

References mAccessToken.

SetErrorMessage()

void AuthDelegate::OAuth2Token::SetErrorMessage ( const std::string & errorMessage )

inline

Set the error message.

Parameters

errorMessage

Error message.

Definition at line 421 of file common_types.h.

{ mErrorMessage = errorMessage; }

References mErrorMessage.

Member Data Documentation

mAccessToken

std::string AuthDelegate::OAuth2Token::mAccessToken

private

Definition at line 424 of file common_types.h.

Referenced by GetAccessToken(), and SetAccessToken().

mErrorMessage

std::string AuthDelegate::OAuth2Token::mErrorMessage

private

Definition at line 425 of file common_types.h.

Referenced by GetErrorMessage(), and SetErrorMessage().

---

The documentation for this class was generated from the following file:

• src/api/mip/common_types.h