KNewStuff

errorcode.h
1 /*
2  knewstuff3/errorcode.h.
3  SPDX-FileCopyrightText: 2018 Dan Leinir Turthra Jensen <[email protected]>
4 
5  SPDX-License-Identifier: LGPL-2.1-or-later
6 */
7 
8 #ifndef KNSCORE_ERRORCODE_H
9 #define KNSCORE_ERRORCODE_H
10 
11 #include "knewstuffcore_export.h"
12 #include <qobjectdefs.h>
13 
14 namespace KNSCore
15 {
16 KNEWSTUFFCORE_EXPORT Q_NAMESPACE
17  /**
18  * An enumeration of specific error conditions which might occur and which
19  * users of KNewStuff would want to react to. It is used by both the Engine and
20  * Provider classes.
21  * @since 5.53
22  * TODO: KF6 do not repeat entry properties in the QVariantList
23  */
24  enum ErrorCode {
25  UnknownError, ///< An unknown error (this should not be used, an error report of this nature should be considered a bug)
26  NetworkError, ///< A network error. In signalErrorCode, this will be accompanied by the QtNetwork error code in the metadata
27  OcsError, ///< An error reported by the OCS API server. In signalErrorCode, this will be accompanied by the OCS error code in the metadata
28  ConfigFileError, ///< The configuration file is missing or somehow incorrect. The configuration file filename will be held in the metadata
29  ProviderError, ///< A provider has failed to load or initialize. The provider file URL or provider URL will be held in the metadata
30  InstallationError, ///< Installation of a content item has failed. If known, the entry's unique ID will be the metadata
31  ImageError, ///< Loading an image has failed. The entry name and preview type which failed will be held in the metadata as a QVariantList
32  AdoptionError, ///< Adopting one entry has failed. The adoption command will be in the metadata as a QVariantList.
33  TryAgainLaterError, ///< Specific error condition for failed network calls which explicitly request an amount of time to wait before retrying (generally
34  ///< interpreted as maintenance). The retry will be scheduled automatically, and this code can be used to show the user how long
35  ///< they have to wait. The time after which the user can try again can be read as a QDateTime in the metadata. @since 5.84
36  };
37 Q_ENUM_NS(ErrorCode)
38 }
39 #endif // KNSCORE_ERRORCODE_H
The configuration file is missing or somehow incorrect. The configuration file filename will be held ...
Definition: errorcode.h:28
Installation of a content item has failed. If known, the entry&#39;s unique ID will be the metadata...
Definition: errorcode.h:30
Contains the core functionality for handling interaction with NewStuff providers. ...
ErrorCode
An enumeration of specific error conditions which might occur and which users of KNewStuff would want...
Definition: errorcode.h:24
Adopting one entry has failed. The adoption command will be in the metadata as a QVariantList.
Definition: errorcode.h:32
Loading an image has failed. The entry name and preview type which failed will be held in the metadat...
Definition: errorcode.h:31
An error reported by the OCS API server. In signalErrorCode, this will be accompanied by the OCS erro...
Definition: errorcode.h:27
Specific error condition for failed network calls which explicitly request an amount of time to wait ...
Definition: errorcode.h:33
A network error. In signalErrorCode, this will be accompanied by the QtNetwork error code in the meta...
Definition: errorcode.h:26
An unknown error (this should not be used, an error report of this nature should be considered a bug)...
Definition: errorcode.h:25
A provider has failed to load or initialize. The provider file URL or provider URL will be held in th...
Definition: errorcode.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Jun 18 2021 22:41:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.