Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
AuthDelegate::OAuth2Token Class Reference

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

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

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.
 

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.

386{}

◆ OAuth2Token() [2/2]

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

Construct a new OAuth2Token object from JWT access token.

Parameters
accessTokenJWT access token.

Definition at line 393 of file common_types.h.

393: 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.

400{ return 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.

414{ return mErrorMessage; }

◆ SetAccessToken()

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

Set the access token string.

Parameters
accessTokenAccess token string.

Definition at line 407 of file common_types.h.

407{ mAccessToken = accessToken; }

◆ SetErrorMessage()

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

Set the error message.

Parameters
errorMessageError message.

Definition at line 421 of file common_types.h.

421{ mErrorMessage = errorMessage; }

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