Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
AuthDelegate::OAuth2Token Class Reference

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

#include <common_types.h>

Public Member Functions

 OAuth2Token ()
 Construct a new OAuth2Token object.
 
 OAuth2Token (const std::string &accessToken)
 Construct a new OAuth2Token object from JWT access token.
 
const std::string & GetAccessToken () const
 Get the access token string.
 
void SetAccessToken (const std::string &accessToken)
 Set the access token string.
 
const std::string & GetErrorMessage () const
 Get the error message, if any.
 
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.

Constructor & Destructor Documentation

◆ OAuth2Token() [1/2]

AuthDelegate::OAuth2Token::OAuth2Token ( )
inline

Construct a new OAuth2Token object.

◆ OAuth2Token() [2/2]

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

Construct a new OAuth2Token object from JWT access token.

Parameters
accessTokenJWT access token.

Member Function Documentation

◆ GetAccessToken()

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

Get the access token string.

Returns
Access token string.

◆ GetErrorMessage()

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

Get the error message, if any.

Returns
Error message.

◆ SetAccessToken()

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

Set the access token string.

Parameters
accessTokenAccess token string.

◆ SetErrorMessage()

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

Set the error message.

Parameters
errorMessageError message.

Member Data Documentation

◆ mAccessToken

std::string AuthDelegate::OAuth2Token::mAccessToken
private

◆ mErrorMessage

std::string AuthDelegate::OAuth2Token::mErrorMessage
private

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