MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
NoPermissionsExtendedError Class Reference

The user could not get access to the content due to extended Access checks like ABAC. More...

#include <mip/error.h>

Inheritance diagram for NoPermissionsExtendedError:
NoPermissionsError AccessDeniedError Error

Public Member Functions

 NoPermissionsExtendedError (Category category, const std::string &message, const std::string &referrer, const std::string &owner, const std::vector< ExtendedErrorInfo > &extendedErrorInfo, const std::string &name=GetNoPermissionsExtendedErrorName())
 
 NoPermissionsExtendedError (Category category, const std::string &message, const std::string &referrer, const std::string &owner, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::vector< ExtendedErrorInfo > &extendedErrorInfo, const std::string &name=GetNoPermissionsExtendedErrorName())
 
std::shared_ptr< ErrorClone () const override
 Clone the error.
 
std::vector< ExtendedErrorInfoGetExtendedErrorInfo () const
 
- Public Member Functions inherited from NoPermissionsError
 NoPermissionsError (Category category, const std::string &message, const std::string &referrer="", const std::string &owner="", const std::string &name="NoPermissionsError")
 
 NoPermissionsError (Category category, const std::string &message, const std::string &referrer, const std::string &owner, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="NoPermissionsError")
 
 NoPermissionsError (const std::string &message, const std::string &referrer, const std::string &owner, const std::string &name="NoPermissionsError")
 
 NoPermissionsError (const std::string &message, const std::string &referrer, const std::string &owner, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="NoPermissionsError")
 
ErrorType GetErrorType () const override
 Get the error type.
 
std::string GetReferrer () const
 Gets the contact in case of missing rights to the document.
 
std::string GetOwner () const
 Gets the owner of the document.
 
Category GetCategory () const
 Gets the category of no permissions failure.
 
- Public Member Functions inherited from AccessDeniedError
 AccessDeniedError (const std::string &message, const std::string &name="AccessDeniedError")
 
 AccessDeniedError (const std::string &message, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="AccessDeniedError")
 
- Public Member Functions inherited from Error
char const * what () const noexcept override
 Get the error message.
 
const std::string & GetErrorName () const
 Get the error name.
 
const std::string & GetMessage (bool maskPII=false) const
 Get the error message.
 
void SetMessage (const std::string &msg)
 Set the error message.
 
void AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
 Add debug info entry.
 
const std::map< std::string, std::string > & GetDebugInfo () const
 Get debug info.
 
virtual ~Error ()
 

Private Member Functions

void AddExtendedErrorInfoToDebugInfo (const std::vector< ExtendedErrorInfo > &extendedErrorInfo)
 

Private Attributes

std::vector< ExtendedErrorInfomExtendedErrorInfo
 

Additional Inherited Members

- Public Types inherited from NoPermissionsError
enum class  Category {
  Unknown = 0 , UserNotFound = 1 , AccessDenied = 2 , AccessExpired = 3 ,
  InvalidEmail = 4 , UnknownTenant = 5 , NotOwner = 6 , NotPremiumLicenseUser = 7 ,
  ClientVersionNotSupported = 8 , FileNotFound = 9 , ClientUnauthorized = 10 , InvalidToken = 11
}
 Category of no permissions error. More...
 
- Protected Member Functions inherited from Error
 Error (const std::string &message, const std::string &name, ErrorType type)
 
 Error (const std::string &message, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name, ErrorType type)
 
- Protected Attributes inherited from Error
std::string mMessage
 
std::map< std::string, std::string > mDebugInfo
 
std::string mName
 
ErrorType mType
 

Detailed Description

The user could not get access to the content due to extended Access checks like ABAC.

Constructor & Destructor Documentation

◆ NoPermissionsExtendedError() [1/2]

NoPermissionsExtendedError::NoPermissionsExtendedError ( Category category,
const std::string & message,
const std::string & referrer,
const std::string & owner,
const std::vector< ExtendedErrorInfo > & extendedErrorInfo,
const std::string & name = GetNoPermissionsExtendedErrorName() )
inlineexplicit

◆ NoPermissionsExtendedError() [2/2]

NoPermissionsExtendedError::NoPermissionsExtendedError ( Category category,
const std::string & message,
const std::string & referrer,
const std::string & owner,
const std::map< std::string, std::string > debugInfo,
const std::map< std::string, std::string > sensitiveDebugInfo,
const std::vector< ExtendedErrorInfo > & extendedErrorInfo,
const std::string & name = GetNoPermissionsExtendedErrorName() )
inlineexplicit

Member Function Documentation

◆ AddExtendedErrorInfoToDebugInfo()

void NoPermissionsExtendedError::AddExtendedErrorInfoToDebugInfo ( const std::vector< ExtendedErrorInfo > & extendedErrorInfo)
inlineprivate

◆ Clone()

std::shared_ptr< Error > NoPermissionsExtendedError::Clone ( ) const
inlineoverridevirtual

Clone the error.

Returns
a clone of the error.

Reimplemented from NoPermissionsError.

◆ GetExtendedErrorInfo()

std::vector< ExtendedErrorInfo > NoPermissionsExtendedError::GetExtendedErrorInfo ( ) const
inline

Member Data Documentation

◆ mExtendedErrorInfo

std::vector<ExtendedErrorInfo> NoPermissionsExtendedError::mExtendedErrorInfo
private

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