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

#include <mip/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 , FileNotFound = 9 , ClientUnauthorized = 10 , InvalidToken = 11 }
	Category of no permissions error. More...

Public Member Functions
	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")

std::shared_ptr< Error >	Clone () const override
	Clone the error.

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
const std::string &	GetCategoryString (Category category) const

Private Attributes
Category	mCategory

std::string	mReferrer

std::string	mOwner

Additional Inherited Members
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. 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
FileNotFound	Content was saved with dynamic protection and rights information was not found in online location. Content may have been deleted.
ClientUnauthorized	Content was saved with dynamic protection and user is not authorized to access it.
InvalidToken	Content was saved with dynamic protection and requires user authentication to access it. Application authentication may have been used.

Constructor & Destructor Documentation

◆ NoPermissionsError() [1/4]

NoPermissionsError::NoPermissionsError	(	Category	category,
		const std::string &	message,
		const std::string &	referrer = "",
		const std::string &	owner = "",
		const std::string &	name = "NoPermissionsError" )

inlineexplicit

◆ NoPermissionsError() [2/4]

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" )

inlineexplicit

◆ NoPermissionsError() [3/4]

NoPermissionsError::NoPermissionsError	(	const std::string &	message,
		const std::string &	referrer,
		const std::string &	owner,
		const std::string &	name = "NoPermissionsError" )

inlineexplicit

◆ NoPermissionsError() [4/4]

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" )

inlineexplicit

Member Function Documentation

◆ Clone()

std::shared_ptr< Error > NoPermissionsError::Clone ( ) const

inlineoverridevirtual

Clone the error.

Returns: a clone of the error.

Reimplemented from AccessDeniedError.

Reimplemented in NoPermissionsExtendedError.

◆ 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

◆ GetErrorType()

ErrorType NoPermissionsError::GetErrorType ( ) const

inlineoverridevirtual

Get the error type.

Returns: the error type.

Reimplemented from Error.

◆ 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:

src/api/mip/error.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Category

Constructor & Destructor Documentation

◆ NoPermissionsError() [1/4]

◆ NoPermissionsError() [2/4]

◆ NoPermissionsError() [3/4]

◆ NoPermissionsError() [4/4]

Member Function Documentation

◆ Clone()

◆ GetCategory()

◆ GetCategoryString()

◆ GetErrorType()

◆ GetOwner()

◆ GetReferrer()

Member Data Documentation

◆ mCategory

◆ mOwner

◆ mReferrer