Merge pull request #249 from rdkcentral/develop

IProvisioning.h Interface header not following coding guidelines

Author: ramkumarpraba

CHANGELOG.md

@@ -4,9 +4,17 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [1.5.0](https://github.com/rdkcentral/entservices-apis/compare/1.4.2...1.5.0)
+
+- DELIA-67834 : Added privacyMode related calls. [`#133`](https://github.com/rdkcentral/entservices-apis/pull/133)
+- Merge tag '1.4.2' into develop [`4ebfb21`](https://github.com/rdkcentral/entservices-apis/commit/4ebfb219ea129bfe695290c85bcd5cecee5a0a7c)
+
 #### [1.4.2](https://github.com/rdkcentral/entservices-apis/compare/1.4.1...1.4.2)
 
+> 28 May 2025
+
 - RDKEMW-1016 Add COM-RPC support to LEDControl plugin [`#157`](https://github.com/rdkcentral/entservices-apis/pull/157)
+- RDKEMW-1016 - Changelog updates for 1.4.2 [`1449587`](https://github.com/rdkcentral/entservices-apis/commit/1449587865c3b124b89a6b7af3ba69fa677318e8)
 - Merge tag '1.4.1' into develop [`e2e96ce`](https://github.com/rdkcentral/entservices-apis/commit/e2e96ce04efecaa6f3259c22bcd52320a68e7e91)
 
 #### [1.4.1](https://github.com/rdkcentral/entservices-apis/compare/1.4.0...1.4.1)

apis/AppManager/IAppManager.h

@@ -23,29 +23,68 @@
 
 namespace WPEFramework {
 namespace Exchange {
+
+#ifndef RUNTIME_CONFIG
+struct RuntimeConfig
+{
+    bool dial;
+    bool wanLanAccess;
+    bool thunder;
+    int32_t systemMemoryLimit;
+    int32_t gpuMemoryLimit;
+    std::string envVariables;
+    uint32_t userId;
+    uint32_t groupId;
+    uint32_t dataImageSize;
+
+    bool resourceManagerClientEnabled;
+    std::string dialId;
+    std::string command;
+    std::string appType;
+    std::string appPath;
+    std::string runtimePath;
+
+    std::string logFilePath;
+    uint32_t logFileMaxSize;
+    std::string logLevels;          //json array of strings
+    bool mapi;
+    std::string fkpsFiles;          //json array of strings
+
+    std::string fireboltVersion;
+    bool enableDebugger;
+    string unpackedPath;
+};
+#define RUNTIME_CONFIG
+#endif
+
 // @json 1.0.0 @text:keep
 struct EXTERNAL IAppManager : virtual public Core::IUnknown {
   enum { ID = ID_APPMANAGER };
 
   enum AppLifecycleState : uint8_t {
-          APP_STATE_UNKNOWN     = 0   /* @text APP_STATE_UNKNOWN */,
-          APP_STATE_RUNNING     = 1   /* @text APP_STATE_RUNNING */,
-          APP_STATE_ACTIVE      = 2   /* @text APP_STATE_ACTIVE */,
-          APP_STATE_SUSPENDED   = 3   /* @text APP_STATE_SUSPENDED */,
-          APP_STATE_HIBERNATED  = 4   /* @text APP_STATE_HIBERNATED */,
-          APP_STATE_TERMINATED  = 5   /* @text APP_STATE_TERMINATED */
+          APP_STATE_UNKNOWN      = 0   /* @text APP_STATE_UNKNOWN */,
+          APP_STATE_UNLOADED     = 1   /* @text APP_STATE_UNLOADED */,
+          APP_STATE_LOADING      = 2   /* @text APP_STATE_LOADING */,
+          APP_STATE_INITIALIZING = 3   /* @text APP_STATE_INITIALIZING */,
+          APP_STATE_PAUSED       = 4   /* @text APP_STATE_PAUSED */,
+          APP_STATE_RUNNING      = 5   /* @text APP_STATE_RUNNING */,
+          APP_STATE_ACTIVE       = 6   /* @text APP_STATE_ACTIVE */,
+          APP_STATE_SUSPENDED    = 7   /* @text APP_STATE_SUSPENDED */,
+          APP_STATE_HIBERNATED   = 8   /* @text APP_STATE_HIBERNATED */,
+          APP_STATE_TERMINATED   = 9   /* @text APP_STATE_TERMINATED */
       };
 
   enum AppErrorReason : uint8_t {
-          APP_ERROR_UNKNOWN          = 0     /* @text APP_ERROR_UNKNOWN */,
-          APP_ERROR_STATE_TIMEOUT    = 1     /* @text APP_ERROR_STATE_TIMEOUT */,
-          APP_ERROR_ABORT            = 2     /* @text APP_ERROR_ABORT */
+          APP_ERROR_NONE             = 0     /* @text APP_ERROR_NONE */,
+          APP_ERROR_UNKNOWN          = 1     /* @text APP_ERROR_UNKNOWN */,
+          APP_ERROR_STATE_TIMEOUT    = 2     /* @text APP_ERROR_STATE_TIMEOUT */,
+          APP_ERROR_ABORT            = 3     /* @text APP_ERROR_ABORT */
       };
 
-  // @event 
+  // @event
   struct EXTERNAL INotification : virtual public Core::IUnknown {
     enum { ID = ID_APPMANAGER_NOTIFICATION };
- 
+
     // @text onAppInstalled
     // @brief Triggered whenever the App is installed.
     // @param appId:App identifier for the application.

apis/LifecycleManager/ILifecycleManager.h

@@ -23,38 +23,64 @@
 
 namespace WPEFramework {
 namespace Exchange {
+
+#ifndef RUNTIME_CONFIG
+struct RuntimeConfig {
+    bool dial;
+    bool wanLanAccess;
+    bool thunder;
+    int32_t systemMemoryLimit;
+    int32_t gpuMemoryLimit;
+    std::string envVariables;
+    uint32_t userId;
+    uint32_t groupId;
+    uint32_t dataImageSize;
+
+    bool resourceManagerClientEnabled;
+    std::string dialId;
+    std::string command;
+    std::string appType;
+    std::string appPath;
+    std::string runtimePath;
+
+    std::string logFilePath;
+    uint32_t logFileMaxSize;
+    std::string logLevels;          //json array of strings
+    bool mapi;
+    std::string fkpsFiles;          //json array of strings
+
+    std::string fireboltVersion;
+    bool enableDebugger;
+    string unpackedPath;
+};
+#define RUNTIME_CONFIG
+#endif
+
 // @text:keep
 struct EXTERNAL ILifecycleManager : virtual public Core::IUnknown {
 
     enum LifecycleState : uint8_t {
+        UNLOADED,
         LOADING,
         INITIALIZING,
-        RUNREQUESTED,
-        RUNNING,
-        ACTIVATEREQUESTED,
+        PAUSED,
         ACTIVE,
-        DEACTIVATEREQUESTED,
-        SUSPENDREQUESTED,
         SUSPENDED,
-        RESUMEREQUESTED,
-        HIBERNATEREQUESTED,
         HIBERNATED,
-        WAKEREQUESTED,
-        TERMINATEREQUESTED,
         TERMINATING
     };
 
     enum { ID = ID_LIFECYCLE_MANAGER };
 
-    // @event 
+    // @event
     struct EXTERNAL INotification : virtual public Core::IUnknown
     {
         enum { ID = ID_LIFECYCLE_MANAGER_NOTIFICATION };
- 
+
         // @brief Notifies the change of state of application
         // @text onnAppStateChanged
         // @json:omit
-        virtual void OnAppStateChanged(const string& appId, LifecycleState state, const string& errorReason) = 0;
+        virtual void OnAppStateChanged(const string& appId, LifecycleState state, const string& errorReason) {};
     };
 
     /** Register notification interface */
@@ -79,7 +105,7 @@ struct EXTERNAL ILifecycleManager : virtual public Core::IUnknown {
     // @json:omit
     // @text spawnApp
     // @brief Perform launching of application with window and runtime manager
-    virtual Core::hresult SpawnApp(const string& appId /* @in */, const string& appPath /* @in */, const string& appConfig /* @in */, const string& runtimeAppId /* @in */, const string& runtimePath /* @in */, const string& runtimeConfig /* @in */, const string& launchIntent /* @in */, const string& environmentVars /* @in */, const bool enableDebugger /* @in */, const LifecycleState targetLifecycleState /* @in */, const string& launchArgs /* @in */, string& appInstanceId /* @out */, string& errorReason /* @out */, bool& success /* @out */) = 0;
+    virtual Core::hresult SpawnApp(const string& appId /* @in */, const string& appPath /* @in */, const string& appConfig /* @in */, const string& runtimeAppId /* @in */, const string& runtimePath /* @in */, const string& runtimeConfig /* @in */, const string& launchIntent /* @in */, const string& environmentVars /* @in */, const bool enableDebugger /* @in */, const LifecycleState targetLifecycleState /* @in */, const RuntimeConfig& runtimeConfigObject /* @in */, const string& launchArgs /* @in */, string& appInstanceId /* @out */, string& errorReason /* @out */, bool& success /* @out */) = 0;
 
     /** Get the list of loaded applications */
     // @json:omit

apis/LifecycleManager/ILifecycleManagerState.h

@@ -25,6 +25,7 @@
 
 namespace WPEFramework {
 namespace Exchange {
+// @json 1.0.0 @text:keep
 struct EXTERNAL ILifecycleManagerState : virtual public Core::IUnknown {
 
     enum AppCloseReason : uint8_t {
@@ -41,8 +42,13 @@ struct EXTERNAL ILifecycleManagerState : virtual public Core::IUnknown {
         enum { ID = ID_LIFECYCLE_MANAGER_STATE_NOTIFICATION };
 
         /** Notifies the new state */
-        // @json:omit
+        // @text onAppLifecycleStateChanged
         // @brief Notifies the new state
+        // @param appId:App identifier for the application.
+        // @param appInstanceId:A numerical identifier for a specific instance of the application.
+        // @param newState:The new state to transition the application.
+        // @param oldState:The previous state of the application instance before the update.
+        // @param navigationIntent:navigation intent during active state
         virtual void OnAppLifecycleStateChanged(const string& appId,
                                                 const string& appInstanceId,
                                                 const ILifecycleManager::LifecycleState oldState,
@@ -57,18 +63,23 @@ struct EXTERNAL ILifecycleManagerState : virtual public Core::IUnknown {
     virtual Core::hresult Unregister(INotification *notification) = 0;
 
     /** Response api call to appInitializing API */
-    // @json:omit
+    // @text appReady
     // @brief Response api call to appInitializing API
+    // @param appId:App identifier for the application.
     virtual Core::hresult AppReady(const string& appId /* @in */) = 0;
 
     /** Response api call to appLifecycleStateChanged API */
-    // @json:omit
+    // @text stateChangeComplete
     // @brief Response api call to appLifecycleStateChanged API
+    // @param appId:App identifier for the application.
+    // @param stateChangedId: state changed identifier
     virtual Core::hresult StateChangeComplete(const string& appId /* @in */, const uint32_t stateChangedId /* @in */, const bool success /* @in */) = 0;
 
     /** close the app */
-    // @json:omit
+    // @text closeApp
     // @brief close the app
+    // @param appId:App identifier for the application.
+    // @param closeReason: closed reason for application
     virtual Core::hresult CloseApp(const string& appId /* @in */, const AppCloseReason closeReason /* @in */) = 0;
 
 };

apis/PackageManager/IAppPackageManager.h

@@ -6,25 +6,32 @@
 
 namespace WPEFramework {
 namespace Exchange {
+
 #ifndef RUNTIME_CONFIG
     struct RuntimeConfig {
         bool dial;
         bool wanLanAccess;
         bool thunder;
         int32_t systemMemoryLimit;
         int32_t gpuMemoryLimit;
-        std::string envVars;
+        std::string envVariables;
         uint32_t userId;
         uint32_t groupId;
         uint32_t dataImageSize;
 
         bool resourceManagerClientEnabled;
         std::string dialId;
         std::string command;
-        uint32_t appType;
+        std::string appType;
         std::string appPath;
         std::string runtimePath;
 
+        std::string logFilePath;
+        uint32_t logFileMaxSize;
+        std::string logLevels;          //json array of strings
+        bool mapi;
+        std::string fkpsFiles;          //json array of strings
+
         std::string fireboltVersion;
         bool enableDebugger;
     };
@@ -75,15 +82,27 @@ namespace Exchange {
         virtual Core::hresult  Deinitialize(PluginHost::IShell* service) = 0;
 
 
+        struct Options {
+            // @brief Priority
+            bool priority;
+            // @brief Retries
+            uint32_t retries;
+            // @brief RateLimit
+            uint64_t rateLimit;
+        };
+
+        struct DownloadId {
+            string downloadId;
+        };
+
 	    // @brief Download
         // @text download
         // @param url: Download url
+        // @param options: Download options
         virtual Core::hresult Download(
             const string &url,
-            const bool priority /* @optional */,
-            const uint32_t retries /* @optional */,
-            const uint64_t rateLimit /* @optional */,
-            string &downloadId /* @out */) = 0;
+            const Options &options,
+            DownloadId &downloadId /* @out */) = 0;
 
         // @brief Pause
         // @text pause
@@ -105,18 +124,22 @@ namespace Exchange {
         // @param fileLocator: FileLocator
         virtual Core::hresult Delete(const string &fileLocator) = 0;
 
+        struct Percent {
+            uint8_t percent;
+        };
+
         // @brief Delete
         // @text progress
         // @param downloadId: Download id
         virtual Core::hresult Progress(
             const string &downloadId,
-            uint8_t &percent /* @out */) = 0;
+            Percent &percent /* @out */) = 0;
 
         // @brief GetStorageDetails
         // @text getStorageDetails
         virtual Core::hresult GetStorageDetails(
-            uint32_t &quotaKB /* @out */,
-            uint32_t &usedKB  /* @out */) = 0;
+            uint32_t &quotaKb /* @out */,
+            uint32_t &usedKb  /* @out */) = 0;
 
         // @brief RateLimit
         // @text rateLimit
@@ -129,16 +152,18 @@ namespace Exchange {
     struct EXTERNAL IPackageInstaller : virtual public Core::IUnknown {
         enum { ID = ID_PACKAGE_INSTALLER };
 
-        enum PackageLifecycleState : uint8_t {
-            INSTALLING,
+        enum InstallState : uint8_t{
+            INSTALLING,                 // XXX: necessary ?!
             INSTALLATION_BLOCKED,
+            INSTALL_FAILURE,
             INSTALLED,
-            UNINSTALLING,
+            UNINSTALLING,               // XXX: necessary ?!
+            UNINSTALL_FAILURE,
             UNINSTALLED
         };
 
         enum FailReason : uint8_t {
-            NONE,
+            NONE,                       // XXX: Not in HLA
             SIGNATURE_VERIFICATION_FAILURE,
             PACKAGE_MISMATCH_FAILURE,
             INVALID_METADATA_FAILURE,
@@ -149,8 +174,8 @@ namespace Exchange {
             string packageId;
             // @brief Version
             string version;
-            // @brief PackageState
-            PackageLifecycleState packageState;
+            // @brief state
+            InstallState state;
             // @brief Digest
             string digest;
             // @brief SizeKb
@@ -194,7 +219,7 @@ namespace Exchange {
             const string &version,
             IPackageInstaller::IKeyValueIterator* const& additionalMetadata,
             const string &fileLocator,
-            FailReason &reason /* @out */) = 0;
+            FailReason &failReason /* @out */) = 0;
 
         // @brief Uninstall
         // @text uninstall
@@ -225,7 +250,7 @@ namespace Exchange {
         virtual Core::hresult PackageState(
             const string &packageId,
             const string &version,
-            PackageLifecycleState &state /* @out */
+            InstallState &state /* @out */
             ) = 0;
    };