NoPermissionsError Class Reference

The user could not get access to the content. For example, no permissions, content revoked. More...

#include <error.h>

Inheritance diagram for NoPermissionsError:

Public Types
enum class	Category {   Unknown = 0 , UserNotFound = 1 , AccessDenied = 2 , AccessExpired = 3 ,   InvalidEmail = 4 , UnknownTenant = 5 , NotOwner = 6 , NotPremiumLicenseUser = 7 ,   ClientVersionNotSupported = 8 }
	Category of no permissions error. More...

Public Member Functions
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 Error
char const *	what () const noexcept override
	Get the error message.
virtual std::shared_ptr< Error >	Clone () const =0
	Clone the error.
virtual ErrorType	GetErrorType () const
	Get the error type.
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.

Private Member Functions
const std::string &	GetCategoryString (Category category) const

Private Attributes
Category	mCategory
std::string	mReferrer
std::string	mOwner

Additional Inherited Members
Public 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. For example, no permissions, content revoked.

Member Enumeration Documentation

Category

enum class NoPermissionsError::Category

strong

Category of no permissions error.

Enumerator
Unknown	Unknown no permissions failure
UserNotFound	Requested user was not found failure
AccessDenied	Access to content or action was not permitted
AccessExpired	Access to content or action has expired
InvalidEmail
UnknownTenant
NotOwner	User needs to be owner to perform action
NotPremiumLicenseUser	User needs to be a premium license holder to perform action. Tracking and Revocation for example
ClientVersionNotSupported	User needs to update their client in order to support features used within this document >

Member Function Documentation

GetCategory()

Category NoPermissionsError::GetCategory ( ) const

inline

Gets the category of no permissions failure.

Returns

Category of no permissions failure

GetCategoryString()

const std::string & NoPermissionsError::GetCategoryString ( Category category ) const

inlineprivate

GetOwner()

std::string NoPermissionsError::GetOwner ( ) const

inline

Gets the owner of the document.

Returns

Document owner

GetReferrer()

std::string NoPermissionsError::GetReferrer ( ) const

inline

Gets the contact in case of missing rights to the document.

Returns

The contact in case of missing rights to the document.

Member Data Documentation

mCategory

Category NoPermissionsError::mCategory

private

mOwner

std::string NoPermissionsError::mOwner

private

mReferrer

std::string NoPermissionsError::mReferrer

private

---

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

• /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/error.h