QEverCloud  6.1.0
Unofficial Evernote Cloud API for Qt
Public Member Functions | Public Attributes | List of all members
qevercloud::EDAMUserException Class Reference

#include <Types.h>

Inheritance diagram for qevercloud::EDAMUserException:
qevercloud::EvernoteException qevercloud::Printable qevercloud::EverCloudException

Public Member Functions

 EDAMUserException ()
 
virtual ~EDAMUserException () noexcept override
 
 EDAMUserException (const EDAMUserException &other)
 
const char * what () const noexcept override
 
virtual EverCloudExceptionDataPtr exceptionData () const override
 
virtual void print (QTextStream &strm) const override
 
bool operator== (const EDAMUserException &other) const
 
bool operator!= (const EDAMUserException &other) const
 
- Public Member Functions inherited from qevercloud::EvernoteException
 EvernoteException ()
 
 EvernoteException (QString error)
 
 EvernoteException (const std::string &error)
 
 EvernoteException (const char *error)
 
- Public Member Functions inherited from qevercloud::EverCloudException
 EverCloudException ()
 
 EverCloudException (QString error)
 
 EverCloudException (const std::string &error)
 
 EverCloudException (const char *error)
 
virtual ~EverCloudException () noexcept override
 
- Public Member Functions inherited from qevercloud::Printable
 Printable ()=default
 
virtual ~Printable ()=default
 
virtual QString toString () const
 

Public Attributes

EDAMErrorCode errorCode
 
Optional< QString > parameter
 

Additional Inherited Members

- Protected Attributes inherited from qevercloud::EverCloudException
QByteArray m_error
 

Detailed Description

This exception is thrown by EDAM procedures when a call fails as a result of a problem that a caller may be able to resolve. For example, if the user attempts to add a note to their account which would exceed their storage quota, this type of exception may be thrown to indicate the source of the error so that they can choose an alternate action.

This exception would not be used for internal system errors that do not reflect user actions, but rather reflect a problem within the service that the user cannot resolve.

errorCode: The numeric code indicating the type of error that occurred. must be one of the values of EDAMErrorCode.

parameter: If the error applied to a particular input parameter, this will indicate which parameter. For some errors (USER_NOT_ASSOCIATED, USER_NOT_REGISTERED, SSO_AUTHENTICATION_REQUIRED), this is the user's email.

Constructor & Destructor Documentation

◆ EDAMUserException() [1/2]

qevercloud::EDAMUserException::EDAMUserException ( )

◆ ~EDAMUserException()

virtual qevercloud::EDAMUserException::~EDAMUserException ( )
overridevirtualnoexcept

◆ EDAMUserException() [2/2]

qevercloud::EDAMUserException::EDAMUserException ( const EDAMUserException other)

Member Function Documentation

◆ exceptionData()

virtual EverCloudExceptionDataPtr qevercloud::EDAMUserException::exceptionData ( ) const
overridevirtual

Reimplemented from qevercloud::EvernoteException.

◆ operator!=()

bool qevercloud::EDAMUserException::operator!= ( const EDAMUserException other) const
inline

◆ operator==()

bool qevercloud::EDAMUserException::operator== ( const EDAMUserException other) const
inline

◆ print()

virtual void qevercloud::EDAMUserException::print ( QTextStream &  strm) const
overridevirtual

Implements qevercloud::Printable.

◆ what()

const char* qevercloud::EDAMUserException::what ( ) const
overridevirtualnoexcept

Reimplemented from qevercloud::EverCloudException.

Member Data Documentation

◆ errorCode

EDAMErrorCode qevercloud::EDAMUserException::errorCode

◆ parameter

Optional< QString > qevercloud::EDAMUserException::parameter