/*
    knewstuff3/errorcode.h.
    SPDX-FileCopyrightText: 2018 Dan Leinir Turthra Jensen <admin@leinir.dk>

    SPDX-License-Identifier: LGPL-2.1-or-later
*/

#ifndef KNSCORE_ERRORCODE_H
#define KNSCORE_ERRORCODE_H

#include "knewstuffcore_export.h"
#include <qobjectdefs.h>

/*!
 * \namespace KNSCore::ErrorCode
 * \inmodule KNewStuffCore
 */
namespace KNSCore::ErrorCode
{
Q_NAMESPACE_EXPORT(KNEWSTUFFCORE_EXPORT)
/**
 * \enum KNSCore::ErrorCode::ErrorCode
 *
 * \brief An enumeration of specific error conditions which might occur and which
 * users of KNewStuff would want to react to. It is used by both the Engine and
 * Provider classes.
 *
 * \since 5.53
 * TODO: KF6 do not repeat entry properties in the QVariantList

 * \value UnknownError
 * An unknown error (this should not be used, an error report of this nature should be considered a bug)
 *
 * \value NetworkError
 * A network error. In signalErrorCode, this will be accompanied by the
 * QtNetwork error code in the metadata
 *
 * \value OcsError
 * An error reported by the OCS API server. In signalErrorCode, this will be
 * accompanied by the OCS error code in the metadata
 *
 * \value ConfigFileError
 * The configuration file is missing or somehow incorrect. The configuration
 * file filename will be held in the metadata
 *
 * \value ProviderError
 * A provider has failed to load or initialize. The provider file URL or
 * provider URL will be held in the metadata
 *
 * \value InstallationError
 * Installation of a content item has failed. If known, the entry's unique ID
 * will be the metadata
 *
 * \value ImageError
 * Loading an image has failed. The entry name and preview type which failed
 * will be held in the metadata as a QVariantList
 *
 * \value AdoptionError
 * Adopting one entry has failed. The adoption command will be in the metadata
 * as a QVariantList.
 *
 * \value TryAgainLaterError
 * Specific error condition for failed network calls which explicitly request
 * an amount of time to wait before retrying (generally interpreted as
 * maintenance). The retry will be scheduled automatically, and this code can
 * be used to show the user how long 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
 */
enum ErrorCode {
    UnknownError,
    NetworkError,
    OcsError,
    ConfigFileError,
    ProviderError,
    InstallationError,
    ImageError,
    AdoptionError,
    TryAgainLaterError,
};
Q_ENUM_NS(ErrorCode)
}
#endif // KNSCORE_ERRORCODE_H