ILicense.h

#pragma once

#include "IObject.h"
#include <fsdk/FSDKError.h>

namespace fsdk {

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
        DECLARE_SMARTPTR(ILicense);
    #endif

    enum class LicenseFeature : uint32_t {
        Detection       = 1,
        BestShot        = 2,
        Attributes      = 3,
        Emotions        = 4,
        FaceFeatures    = 5,
        Liveness        = 6,
        Descriptor      = 7,
        DescriptorIndex = 8,
        LivenessEngine  = 9,
        TrackEngine     = 10,
        HumanDetection  = 11,
        PPEDetection    = 17,
        MobileLiveness  = 18,
        MedicalMaskDetection  = 19,
        ReIdDescriptor  = 20
    };

    struct ILicense : IRefCounted {

        /*
         * @brief Checks if the feature with featureId is available in this license.
         * @return ResultValue with error code and true if feature is available, false if there is not such feature in this
         * license or feature is expired or license was not activated.
         */
        virtual fsdk::ResultValue<fsdk::FSDKError, bool> checkFeatureId(LicenseFeature feature) const noexcept = 0;

        /*
         * @brief Checks if current license object is activated and could be used by FaceEngine.
         * @return ResultValue with error code and true if object is activated.
         * @note License object which was not activated could not be used because all features are disabled by default.
         */
        virtual fsdk::ResultValue<fsdk::FSDKError, bool> isActivated() const noexcept = 0;

        /*
         * @brief Loads license from file.
         * @param [in] path path to the file.
         * @return Error code @see FSDKError for details.
         */
        virtual fsdk::Result<fsdk::FSDKError>
        FSDK_DEPRECATED("loadFromFile is deprecated since v.5.5.0,"
        " Use loadFromFile(const char* path, const fsdk::ISettingsProvider* settings) instead")
        loadFromFile(const char* path) noexcept = 0;

        /*
         * @brief Loads license from file.
         * @param [in] path path to the file.
         * @param [in] settings License settings provider.
         * @return Error code @see FSDKError for details.
         */
        virtual fsdk::Result<fsdk::FSDKError> loadFromFile(const char* path, const fsdk::ISettingsProvider* settings) noexcept = 0;

        /*
         * @brief Saves license as raw format to the file. This file could be used in the next run of the application.
         * @param [in] path path to the file.
         * @return Error code @see FSDKError for details.
         */
        virtual fsdk::Result<fsdk::FSDKError> saveToFile(const char * path) const noexcept = 0;

        /*
         * @param [out] timeStamp the result value
         * @return ResultValue with error code and uint32_t Unix Timestamp.
         * @note License settings should be set before using this method!
         * @note License should be activated before calling this method!
        */
        virtual fsdk::ResultValue<fsdk::FSDKError, uint32_t> getExpirationDate(LicenseFeature feature) const noexcept = 0;
    };
}