Error information about an ArcGIS Maps SDK or server error. More...
Header: | #include <Error.h> |
Since: | Esri::ArcGISRuntime 100.0 |
Public Functions
Error() | |
Error(QString message, QString additionalMessage, Esri::ArcGISRuntime::ExtendedErrorType extendedErrorType = ExtendedErrorType::None) | |
Error(const Esri::ArcGISRuntime::Error &other) | |
Error(Esri::ArcGISRuntime::Error &&other) | |
~Error() | |
QVariantMap | additionalInformation() const |
QString | additionalMessage() const |
Esri::ArcGISRuntime::ErrorDomainType | domain() const |
Esri::ArcGISRuntime::ErrorType | errorType() const |
Esri::ArcGISRuntime::ExtendedErrorType | extendedErrorType() const |
bool | isEmpty() const |
QString | message() const |
Esri::ArcGISRuntime::Error | underlyingError() const |
Esri::ArcGISRuntime::Error & | operator=(const Esri::ArcGISRuntime::Error &other) |
Esri::ArcGISRuntime::Error & | operator=(Esri::ArcGISRuntime::Error &&other) |
Detailed Description
A user-defined error can also be created using custom message strings.
Member Function Documentation
Error::Error()
Constructor.
[since Esri::ArcGISRuntime 100.3]
Error::Error(QString message, QString additionalMessage , Esri::ArcGISRuntime::ExtendedErrorType extendedErrorType = ExtendedErrorType::None)
Constructor accepting user defined messages.
- message. The error message.
- additionalMessage. The additional, detailed error message.
- extendedErrorType. The extended error type, if not set this is,
ExtendedErrorType::None
.
This function was introduced in Esri::ArcGISRuntime 100.3.
Error::Error(const Esri::ArcGISRuntime::Error &other)
Copy constructor from other Error.
Error::Error(Esri::ArcGISRuntime::Error &&other)
Move constructor from other Error.
Error::~Error()
Destructor.
[since Esri::ArcGISRuntime 200.0]
QVariantMap Error::additionalInformation () const
Additional information about the error.
Refer to ErrorInformationKeys for well-known keys that can be used with this map.
This function was introduced in Esri::ArcGISRuntime 200.0.
See also ErrorInformationKeys.
QString Error::additionalMessage () const
Gets the detailed error message.
Esri::ArcGISRuntime::ErrorDomainType Error::domain() const
Gets the error domain.
[since Esri::ArcGISRuntime 100.11]
Esri::ArcGISRuntime::ErrorType Error::errorType () const
Gets the type of the error.
If the domain of the error is not ArcGISRuntime
, then this method may convert the code to an enum value that is not the actual error.
This function was introduced in Esri::ArcGISRuntime 100.11.
Esri::ArcGISRuntime::ExtendedErrorType Error::extendedErrorType () const
Gets the extended error type.
bool Error::isEmpty () const
Gets whether the object is empty.
Returns true
if empty.
QString Error::message() const
Gets the error message.
[since Esri::ArcGISRuntime 200.2]
Esri::ArcGISRuntime::Error Error::underlyingError () const
Gets the error's underlying error.
This function was introduced in Esri::ArcGISRuntime 200.2.
Esri::ArcGISRuntime::Error &Error::operator=(const Esri::ArcGISRuntime::Error &other)
Assignment operator from other Error.
Esri::ArcGISRuntime::Error &Error::operator=(Esri::ArcGISRuntime::Error &&other)
Move operator from other Error.