diff --git a/apis/AppManager/IAppManager.h b/apis/AppManager/IAppManager.h index fe8036bf..96ee63e0 100755 --- a/apis/AppManager/IAppManager.h +++ b/apis/AppManager/IAppManager.h @@ -49,6 +49,7 @@ struct RuntimeConfig std::string logLevels; //json array of strings bool mapi {false}; std::string fkpsFiles; //json array of strings + std::string ralfPkgPath; //Filesystem path holding metadata info of ralf packages std::string fireboltVersion; bool enableDebugger{false}; diff --git a/apis/LifecycleManager/ILifecycleManager.h b/apis/LifecycleManager/ILifecycleManager.h index 7e4fbdec..5b874b2c 100755 --- a/apis/LifecycleManager/ILifecycleManager.h +++ b/apis/LifecycleManager/ILifecycleManager.h @@ -48,6 +48,7 @@ struct RuntimeConfig { std::string logLevels; //json array of strings bool mapi; std::string fkpsFiles; //json array of strings + std::string ralfPkgPath; //Filesystem path holding metadata info of ralf packages std::string fireboltVersion; bool enableDebugger; diff --git a/apis/PackageManager/IAppPackageManager.h b/apis/PackageManager/IAppPackageManager.h index 707cfefc..b300f85e 100644 --- a/apis/PackageManager/IAppPackageManager.h +++ b/apis/PackageManager/IAppPackageManager.h @@ -31,6 +31,7 @@ namespace Exchange { std::string logLevels; //json array of strings bool mapi; std::string fkpsFiles; //json array of strings + std::string ralfPkgPath; //Filesystem path holding metadata info of ralf packages std::string fireboltVersion; bool enableDebugger; diff --git a/apis/RuntimeManager/IRuntimeManager.h b/apis/RuntimeManager/IRuntimeManager.h index f60f3dfc..58a1880c 100755 --- a/apis/RuntimeManager/IRuntimeManager.h +++ b/apis/RuntimeManager/IRuntimeManager.h @@ -50,6 +50,7 @@ struct RuntimeConfig { std::string logLevels; //json array of strings bool mapi; std::string fkpsFiles; //json array of strings + std::string ralfPkgPath; //Filesystem path holding metadata info of ralf packages std::string fireboltVersion; bool enableDebugger; diff --git a/docs/apis/LifecycleManager.md b/docs/apis/LifecycleManager.md index 7061b0d3..a771ac41 100644 --- a/docs/apis/LifecycleManager.md +++ b/docs/apis/LifecycleManager.md @@ -2,7 +2,7 @@ # LifecycleManager Plugin -**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/LifecycleManager/ILifecycleManager.h)** +**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/LifecycleManager/ILifecycleManagerState.h)** A LifecycleManager plugin for Thunder framework. @@ -62,7 +62,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.appId | string | App identifier for the application. | +| params.appId | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -113,7 +113,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.appId | string | App identifier for the application. | +| params.appId | string | | | params.closeReason | string | closed reason for application | ### Results | Name | Type | Description | @@ -166,7 +166,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.appId | string | App identifier for the application. | +| params.appId | string | | | params.stateChangedId | integer | state changed identifier | | params.success | bool | | ### Results @@ -234,8 +234,8 @@ Notifies the new state | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.appId | string | App identifier for the application. | -| params.appInstanceId | string | A numerical identifier for a specific instance of the application. | +| params.appId | string | | +| params.appInstanceId | string | | | params.oldLifecycleState | LifecycleState | The previous state of the application instance before the update. | | params.newLifecycleState | LifecycleState | The new state to transition the application. | | params.navigationIntent | string | navigation intent during active state | diff --git a/docs/apis/PackageManager.md b/docs/apis/PackageManager.md index d42ac0a8..49cf5bb2 100644 --- a/docs/apis/PackageManager.md +++ b/docs/apis/PackageManager.md @@ -2,7 +2,7 @@ # PackageManager Plugin -**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PackageManager/IAppPackageManager.h)** +**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PackageManager/IPackageManager.h)** A PackageManager plugin for Thunder framework. @@ -47,35 +47,35 @@ PackageManager interface methods: | Method | Description | | :-------- | :-------- | -| [cancel](#cancel) | Cancels a previously issued asynchronous request. | -| [config](#config) | Config | -| [delete](#delete) | Delete | -| [download](#download) | Downloads a resource file for an application. | -| [getConfigForPackage](#getConfigForPackage) | getConfigForPackage | -| [getStorageInformation](#getStorageInformation) | GetStorageInformation | -| [install](#install) | Downloads and installs an application bundle. | -| [listPackages](#listPackages) | ListPackages | -| [packageState](#packageState) | PackageState | -| [pause](#pause) | Pause | -| [progress](#progress) | Progress | -| [rateLimit](#rateLimit) | RateLimit | -| [resume](#resume) | Resume | -| [uninstall](#uninstall) | Uninstalls an application. | +| [cancel](#cancel) | Cancel | | [clearAuxMetadata](#clearAuxMetadata) | Clears the specified metadata key. | +| [download](#download) | Download | | [getList](#getList) | Retrieves list of installed apps matching given filters. | | [getLockInfo](#getLockInfo) | Provides lock reason and owner for an app. | | [getMetadata](#getMetadata) | Retrieves metadata and auxiliary resource list for an application. | | [getProgress](#getProgress) | Provides the current progress of an ongoing operation. | | [getStorageDetails](#getStorageDetails) | Retrieves details about app and persistent storage usage. | +| [install](#install) | Install | | [lock](#lock) | Locks an application to prevent uninstallation. | | [reset](#reset) | Deletes all persistent local data of the application. | | [setAuxMetadata](#setAuxMetadata) | Sets a key-value pair of metadata for the application. | +| [uninstall](#uninstall) | Uninstall | | [unlock](#unlock) | Unlocks a previously locked application. | +| [config](#config) | Config | +| [delete](#delete) | Delete | +| [getConfigForPackage](#getConfigForPackage) | getConfigForPackage | +| [getStorageInformation](#getStorageInformation) | GetStorageInformation | +| [listPackages](#listPackages) | ListPackages | +| [packageState](#packageState) | PackageState | +| [pause](#pause) | Pause | +| [progress](#progress) | Progress | +| [rateLimit](#rateLimit) | RateLimit | +| [resume](#resume) | Resume | ## *cancel* -Cancels a previously issued asynchronous request. +Cancel ### Events Event details will be updated soon. @@ -83,7 +83,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.handle | string | | +| params.downloadId | string | Download ID | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -100,7 +100,7 @@ Event details will be updated soon. "id": 0, "method": "org.rdk.PackageManager.cancel", "params": { - "handle": "" + "downloadId": "" } } ``` @@ -109,7 +109,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.PackageManager.cancel", "params": {"handle": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.PackageManager.cancel", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -123,10 +123,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "met } ``` - -## *config* + +## *clearAuxMetadata* -Config +Clears the specified metadata key. ### Events Event details will be updated soon. @@ -134,35 +134,14 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.packageId | string | Package Id | -| params.version | string | | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | +| params.key | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | object | | -| result.configMetadata | RuntimeConfig | Config Metadata | -| result.configMetadata.dial | bool | | -| result.configMetadata.wanLanAccess | bool | | -| result.configMetadata.thunder | bool | | -| result.configMetadata.systemMemoryLimit | integer | | -| result.configMetadata.gpuMemoryLimit | integer | | -| result.configMetadata.envVariables | std::string | | -| result.configMetadata.userId | integer | | -| result.configMetadata.groupId | integer | | -| result.configMetadata.dataImageSize | integer | | -| result.configMetadata.resourceManagerClientEnabled | bool | | -| result.configMetadata.dialId | std::string | | -| result.configMetadata.command | std::string | | -| result.configMetadata.appType | std::string | | -| result.configMetadata.appPath | std::string | | -| result.configMetadata.runtimePath | std::string | | -| result.configMetadata.logFilePath | std::string | | -| result.configMetadata.logFileMaxSize | integer | | -| result.configMetadata.logLevels | std::string | json array of strings | -| result.configMetadata.mapi | bool | | -| result.configMetadata.fkpsFiles | std::string | json array of strings | -| result.configMetadata.fireboltVersion | std::string | | -| result.configMetadata.enableDebugger | bool | | +| result | null | On success null will be returned. | ### Examples @@ -173,10 +152,12 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 1, - "method": "org.rdk.PackageManager.config", + "method": "org.rdk.PackageManager.clearAuxMetadata", "params": { - "packageId": "", - "version": "" + "type": "", + "id": "", + "version": "", + "key": "" } } ``` @@ -185,7 +166,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PackageManager.config", "params": {"packageId": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PackageManager.clearAuxMetadata", "params": {"type": "", "id": "", "version": "", "key": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -195,37 +176,14 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "met { "jsonrpc": 2.0, "id": 1, - "result": { - "dial": true, - "wanLanAccess": true, - "thunder": true, - "systemMemoryLimit": 0, - "gpuMemoryLimit": 0, - "envVariables": "", - "userId": 0, - "groupId": 0, - "dataImageSize": 0, - "resourceManagerClientEnabled": true, - "dialId": "", - "command": "", - "appType": "", - "appPath": "", - "runtimePath": "", - "logFilePath": "", - "logFileMaxSize": 0, - "logLevels": "", - "mapi": true, - "fkpsFiles": "", - "fireboltVersion": "", - "enableDebugger": true - } + "result": null } ``` - -## *delete* + +## *download* -Delete +Download ### Events Event details will be updated soon. @@ -233,11 +191,16 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.fileLocator | string | File Locator | +| params.url | string | Download url | +| params.options | Options | Download options | +| params.options.priority | bool | | +| params.options.retries | integer | | +| params.options.rateLimit | integer | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | +| result | object | | +| result.downloadId | string | Download ID | ### Examples @@ -247,10 +210,15 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 2, - "method": "org.rdk.PackageManager.delete", + "id": 3, + "method": "org.rdk.PackageManager.download", "params": { - "fileLocator": "" + "url": "", + "options": { + "priority": true, + "retries": 0, + "rateLimit": 0 + } } } ``` @@ -259,7 +227,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PackageManager.delete", "params": {"fileLocator": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PackageManager.download", "params": {"url": "", "options": {"priority": true, "retries": 0, "rateLimit": 0}}}' http://127.0.0.1:9998/jsonrpc ``` @@ -268,15 +236,17 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "met ```json { "jsonrpc": 2.0, - "id": 2, - "result": null + "id": 3, + "result": { + "downloadId": "" + } } ``` - -## *download* + +## *getList* -Downloads a resource file for an application. +Retrieves list of installed apps matching given filters. ### Events Event details will be updated soon. @@ -285,15 +255,17 @@ Event details will be updated soon. | :-------- | :-------- | :-------- | | params | object | | | params.type | string | | -| params.id | string | | -| params.version | string | | -| params.resKey | string | | -| params.url | string | | +| params.id | string | package id | +| params.version | string | Version | +| params.appName | string | | +| params.category | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.handle | string | | +| result.installedIds | IPackageKeyIterator | | +| result.installedIds[#].id | string | | +| result.installedIds[#].version | string | | ### Examples @@ -303,14 +275,14 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 2, - "method": "org.rdk.PackageManager.download", + "id": 3, + "method": "org.rdk.PackageManager.getList", "params": { "type": "", "id": "", "version": "", - "resKey": "", - "url": "" + "appName": "", + "category": "" } } ``` @@ -319,7 +291,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PackageManager.download", "params": {"type": "", "id": "", "version": "", "resKey": "", "url": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PackageManager.getList", "params": {"type": "", "id": "", "version": "", "appName": "", "category": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -328,17 +300,20 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "met ```json { "jsonrpc": 2.0, - "id": 2, - "result": { - "handle": "" - } + "id": 3, + "result": [ + { + "id": "", + "version": "" + } + ] } ``` - -## *getConfigForPackage* + +## *getLockInfo* -getConfigForPackage +Provides lock reason and owner for an app. ### Events Event details will be updated soon. @@ -346,36 +321,16 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.fileLocator | string | File Locator | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.id | string | | -| result.version | string | | -| result.config | RuntimeConfig | metadata of package | -| result.config.dial | bool | | -| result.config.wanLanAccess | bool | | -| result.config.thunder | bool | | -| result.config.systemMemoryLimit | integer | | -| result.config.gpuMemoryLimit | integer | | -| result.config.envVariables | std::string | | -| result.config.userId | integer | | -| result.config.groupId | integer | | -| result.config.dataImageSize | integer | | -| result.config.resourceManagerClientEnabled | bool | | -| result.config.dialId | std::string | | -| result.config.command | std::string | | -| result.config.appType | std::string | | -| result.config.appPath | std::string | | -| result.config.runtimePath | std::string | | -| result.config.logFilePath | std::string | | -| result.config.logFileMaxSize | integer | | -| result.config.logLevels | std::string | json array of strings | -| result.config.mapi | bool | | -| result.config.fkpsFiles | std::string | json array of strings | -| result.config.fireboltVersion | std::string | | -| result.config.enableDebugger | bool | | +| result.result | LockInfo | | +| result.result.reason | string | | +| result.result.owner | string | | ### Examples @@ -386,9 +341,11 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 4, - "method": "org.rdk.PackageManager.getConfigForPackage", + "method": "org.rdk.PackageManager.getLockInfo", "params": { - "fileLocator": "" + "type": "", + "id": "", + "version": "" } } ``` @@ -397,7 +354,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PackageManager.getConfigForPackage", "params": {"fileLocator": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PackageManager.getLockInfo", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -408,51 +365,41 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met "jsonrpc": 2.0, "id": 4, "result": { - "id": "", - "version": "", - "config": { - "dial": true, - "wanLanAccess": true, - "thunder": true, - "systemMemoryLimit": 0, - "gpuMemoryLimit": 0, - "envVariables": "", - "userId": 0, - "groupId": 0, - "dataImageSize": 0, - "resourceManagerClientEnabled": true, - "dialId": "", - "command": "", - "appType": "", - "appPath": "", - "runtimePath": "", - "logFilePath": "", - "logFileMaxSize": 0, - "logLevels": "", - "mapi": true, - "fkpsFiles": "", - "fireboltVersion": "", - "enableDebugger": true - } + "reason": "", + "owner": "" } } ``` - -## *getStorageInformation* + +## *getMetadata* -GetStorageInformation +Retrieves metadata and auxiliary resource list for an application. ### Events Event details will be updated soon. ### Parameters -This method takes no parameters. +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.quotaKb | integer | Storage quota in kilobytes | -| result.usedKb | integer | Used storage in kilobytes | +| result.metadata | MetadataPayload | | +| result.metadata.appName | string | | +| result.metadata.type | string | | +| result.metadata.category | string | | +| result.metadata.url | string | | +| result.resources | IKeyValueIterator | | +| result.resources[#].key | string | | +| result.resources[#].value | string | | +| result.auxMetadata | IKeyValueIterator | | +| result.auxMetadata[#].key | string | | +| result.auxMetadata[#].value | string | | ### Examples @@ -463,7 +410,12 @@ This method takes no parameters. { "jsonrpc": 2.0, "id": 5, - "method": "org.rdk.PackageManager.getStorageInformation" + "method": "org.rdk.PackageManager.getMetadata", + "params": { + "type": "", + "id": "", + "version": "" + } } ``` @@ -471,7 +423,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.PackageManager.getStorageInformation"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.PackageManager.getMetadata", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -482,16 +434,32 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met "jsonrpc": 2.0, "id": 5, "result": { - "quotaKb": 0, - "usedKb": 0 + "metadata": { + "appName": "", + "type": "", + "category": "", + "url": "" + }, + "resources": [ + { + "key": "", + "value": "" + } + ], + "auxMetadata": [ + { + "key": "", + "value": "" + } + ] } } ``` - -## *install* + +## *getProgress* -Downloads and installs an application bundle. +Provides the current progress of an ongoing operation. ### Events Event details will be updated soon. @@ -499,17 +467,12 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.url | string | | -| params.appName | string | | -| params.category | string | | +| params.handle | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.handle | string | | +| result.progress | integer | | ### Examples @@ -519,15 +482,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 8, - "method": "org.rdk.PackageManager.install", + "id": 6, + "method": "org.rdk.PackageManager.getProgress", "params": { - "type": "", - "id": "", - "version": "", - "url": "", - "appName": "", - "category": "" + "handle": "" } } ``` @@ -536,7 +494,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "method": "org.rdk.PackageManager.install", "params": {"type": "", "id": "", "version": "", "url": "", "appName": "", "category": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.PackageManager.getProgress", "params": {"handle": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -545,32 +503,36 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "met ```json { "jsonrpc": 2.0, - "id": 8, + "id": 6, "result": { - "handle": "" + "progress": 0 } } ``` - -## *listPackages* + +## *getStorageDetails* -ListPackages +Retrieves details about app and persistent storage usage. ### Events Event details will be updated soon. ### Parameters -This method takes no parameters. +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.packages | IPackageIterator | | -| result.packages[#].packageId | string | | -| result.packages[#].version | string | | -| result.packages[#].state | string | | -| result.packages[#].digest | string | | -| result.packages[#].sizeKb | integer | | +| result.storageinfo | StorageInfo | | +| result.storageinfo.EXTERNAL | struct | | +| result.storageinfo.path | string | | +| result.storageinfo.quotaKB | string | | +| result.storageinfo.usedKB | string | | ### Examples @@ -581,7 +543,12 @@ This method takes no parameters. { "jsonrpc": 2.0, "id": 7, - "method": "org.rdk.PackageManager.listPackages" + "method": "org.rdk.PackageManager.getStorageDetails", + "params": { + "type": "", + "id": "", + "version": "" + } } ``` @@ -589,7 +556,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.PackageManager.listPackages"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.PackageManager.getStorageDetails", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -599,22 +566,19 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "met { "jsonrpc": 2.0, "id": 7, - "result": [ - { - "packageId": "", - "version": "", - "state": "INSTALLING", - "digest": "", - "sizeKb": 0 - } - ] + "result": { + "EXTERNAL": "", + "path": "", + "quotaKB": "", + "usedKB": "" + } } ``` - -## *packageState* + +## *install* -PackageState +Install ### Events Event details will be updated soon. @@ -623,12 +587,16 @@ Event details will be updated soon. | :-------- | :-------- | :-------- | | params | object | | | params.packageId | string | Package Id | -| params.version | string | | +| params.version | string | Version | +| params.additionalMetadata | IKeyValueIterator | Additional Metadata | +| params.additionalMetadata[#].name | string | | +| params.additionalMetadata[#].value | string | | +| params.fileLocator | string | File Locator | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.state | string | | +| result.failReason | string | | ### Examples @@ -638,11 +606,18 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 8, - "method": "org.rdk.PackageManager.packageState", + "id": 6, + "method": "org.rdk.PackageManager.install", "params": { "packageId": "", - "version": "" + "version": "", + "additionalMetadata": [ + { + "name": "", + "value": "" + } + ], + "fileLocator": "" } } ``` @@ -651,7 +626,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "method": "org.rdk.PackageManager.packageState", "params": {"packageId": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.PackageManager.install", "params": {"packageId": "", "version": "", "additionalMetadata": [{"name": "", "value": ""}], "fileLocator": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -660,17 +635,17 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "met ```json { "jsonrpc": 2.0, - "id": 8, + "id": 6, "result": { - "state": "INSTALLING" + "failReason": "NONE" } } ``` - -## *pause* + +## *lock* -Pause +Locks an application to prevent uninstallation. ### Events Event details will be updated soon. @@ -678,11 +653,16 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.downloadId | string | Download ID | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | +| params.reason | string | | +| params.owner | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | +| result | object | | +| result.handle | string | | ### Examples @@ -693,9 +673,13 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 9, - "method": "org.rdk.PackageManager.pause", + "method": "org.rdk.PackageManager.lock", "params": { - "downloadId": "" + "type": "", + "id": "", + "version": "", + "reason": "", + "owner": "" } } ``` @@ -704,7 +688,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.PackageManager.pause", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.PackageManager.lock", "params": {"type": "", "id": "", "version": "", "reason": "", "owner": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -714,14 +698,16 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "met { "jsonrpc": 2.0, "id": 9, - "result": null + "result": { + "handle": "" + } } ``` - -## *progress* + +## *reset* -Progress +Deletes all persistent local data of the application. ### Events Event details will be updated soon. @@ -729,12 +715,14 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.downloadId | string | Download ID | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | +| params.resetType | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | object | | -| result.progress | integer | | +| result | null | On success null will be returned. | ### Examples @@ -745,9 +733,12 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 10, - "method": "org.rdk.PackageManager.progress", + "method": "org.rdk.PackageManager.reset", "params": { - "downloadId": "" + "type": "", + "id": "", + "version": "", + "resetType": "" } } ``` @@ -756,7 +747,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.PackageManager.progress", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.PackageManager.reset", "params": {"type": "", "id": "", "version": "", "resetType": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -766,16 +757,14 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "me { "jsonrpc": 2.0, "id": 10, - "result": { - "progress": 0 - } + "result": null } ``` - -## *rateLimit* + +## *setAuxMetadata* -RateLimit +Sets a key-value pair of metadata for the application. ### Events Event details will be updated soon. @@ -783,8 +772,11 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.downloadId | string | Download ID | -| params.limit | integer | Limit | +| params.type | string | | +| params.id | string | package id | +| params.version | string | Version | +| params.key | string | | +| params.value | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -799,10 +791,13 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 11, - "method": "org.rdk.PackageManager.rateLimit", + "method": "org.rdk.PackageManager.setAuxMetadata", "params": { - "downloadId": "", - "limit": 0 + "type": "", + "id": "", + "version": "", + "key": "", + "value": "" } } ``` @@ -811,7 +806,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.PackageManager.rateLimit", "params": {"downloadId": "", "limit": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.PackageManager.setAuxMetadata", "params": {"type": "", "id": "", "version": "", "key": "", "value": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -825,10 +820,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me } ``` - -## *resume* + +## *uninstall* -Resume +Uninstall ### Events Event details will be updated soon. @@ -836,11 +831,12 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.downloadId | string | Download ID | +| params.packageId | string | Package Id | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | +| result | object | | +| result.errorReason | string | | ### Examples @@ -850,10 +846,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 12, - "method": "org.rdk.PackageManager.resume", + "id": 13, + "method": "org.rdk.PackageManager.uninstall", "params": { - "downloadId": "" + "packageId": "" } } ``` @@ -862,7 +858,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.PackageManager.resume", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.PackageManager.uninstall", "params": {"packageId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -871,15 +867,17 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, - "result": null + "id": 13, + "result": { + "errorReason": "" + } } ``` - -## *uninstall* + +## *unlock* -Uninstalls an application. +Unlocks a previously locked application. ### Events Event details will be updated soon. @@ -887,15 +885,11 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.uninstallType | string | | +| params.handle | string | | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | object | | -| result.handle | string | | +| result | null | On success null will be returned. | ### Examples @@ -905,13 +899,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 12, - "method": "org.rdk.PackageManager.uninstall", + "id": 13, + "method": "org.rdk.PackageManager.unlock", "params": { - "type": "", - "id": "", - "version": "", - "uninstallType": "" + "handle": "" } } ``` @@ -920,7 +911,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.PackageManager.uninstall", "params": {"type": "", "id": "", "version": "", "uninstallType": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.PackageManager.unlock", "params": {"handle": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -929,17 +920,15 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, - "result": { - "handle": "" - } + "id": 13, + "result": null } ``` - -## *clearAuxMetadata* + +## *config* -Clears the specified metadata key. +Config ### Events Event details will be updated soon. @@ -947,14 +936,36 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.key | string | | +| params.packageId | string | Package Id | +| params.version | string | Version | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | +| result | object | | +| result.configMetadata | RuntimeConfig | Config Metadata | +| result.configMetadata.dial | bool | | +| result.configMetadata.wanLanAccess | bool | | +| result.configMetadata.thunder | bool | | +| result.configMetadata.systemMemoryLimit | integer | | +| result.configMetadata.gpuMemoryLimit | integer | | +| result.configMetadata.envVariables | std::string | | +| result.configMetadata.userId | integer | | +| result.configMetadata.groupId | integer | | +| result.configMetadata.dataImageSize | integer | | +| result.configMetadata.resourceManagerClientEnabled | bool | | +| result.configMetadata.dialId | std::string | | +| result.configMetadata.command | std::string | | +| result.configMetadata.appType | std::string | | +| result.configMetadata.appPath | std::string | | +| result.configMetadata.runtimePath | std::string | | +| result.configMetadata.logFilePath | std::string | | +| result.configMetadata.logFileMaxSize | integer | | +| result.configMetadata.logLevels | std::string | json array of strings | +| result.configMetadata.mapi | bool | | +| result.configMetadata.fkpsFiles | std::string | json array of strings | +| result.configMetadata.ralfPkgPath | std::string | Filesystem path holding metadata info of ralf packages | +| result.configMetadata.fireboltVersion | std::string | | +| result.configMetadata.enableDebugger | bool | | ### Examples @@ -965,12 +976,10 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 1, - "method": "org.rdk.PackageManager.clearAuxMetadata", + "method": "org.rdk.PackageManager.config", "params": { - "type": "", - "id": "", - "version": "", - "key": "" + "packageId": "", + "version": "" } } ``` @@ -979,7 +988,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PackageManager.clearAuxMetadata", "params": {"type": "", "id": "", "version": "", "key": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PackageManager.config", "params": {"packageId": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -989,14 +998,38 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "met { "jsonrpc": 2.0, "id": 1, - "result": null + "result": { + "dial": true, + "wanLanAccess": true, + "thunder": true, + "systemMemoryLimit": 0, + "gpuMemoryLimit": 0, + "envVariables": "", + "userId": 0, + "groupId": 0, + "dataImageSize": 0, + "resourceManagerClientEnabled": true, + "dialId": "", + "command": "", + "appType": "", + "appPath": "", + "runtimePath": "", + "logFilePath": "", + "logFileMaxSize": 0, + "logLevels": "", + "mapi": true, + "fkpsFiles": "", + "ralfPkgPath": "", + "fireboltVersion": "", + "enableDebugger": true + } } ``` - -## *getList* + +## *delete* -Retrieves list of installed apps matching given filters. +Delete ### Events Event details will be updated soon. @@ -1004,18 +1037,11 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.appName | string | | -| params.category | string | | +| params.fileLocator | string | File Locator | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | object | | -| result.installedIds | IPackageKeyIterator | | -| result.installedIds[#].id | string | | -| result.installedIds[#].version | string | | +| result | null | On success null will be returned. | ### Examples @@ -1025,14 +1051,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 3, - "method": "org.rdk.PackageManager.getList", + "id": 2, + "method": "org.rdk.PackageManager.delete", "params": { - "type": "", - "id": "", - "version": "", - "appName": "", - "category": "" + "fileLocator": "" } } ``` @@ -1041,7 +1063,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PackageManager.getList", "params": {"type": "", "id": "", "version": "", "appName": "", "category": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PackageManager.delete", "params": {"fileLocator": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1050,20 +1072,15 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "met ```json { "jsonrpc": 2.0, - "id": 3, - "result": [ - { - "id": "", - "version": "" - } - ] + "id": 2, + "result": null } ``` - -## *getLockInfo* + +## *getConfigForPackage* -Provides lock reason and owner for an app. +getConfigForPackage ### Events Event details will be updated soon. @@ -1071,16 +1088,37 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | +| params.fileLocator | string | File Locator | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.result | LockInfo | | -| result.result.reason | string | | -| result.result.owner | string | | +| result.id | string | package id | +| result.version | string | Version | +| result.config | RuntimeConfig | metadata of package | +| result.config.dial | bool | | +| result.config.wanLanAccess | bool | | +| result.config.thunder | bool | | +| result.config.systemMemoryLimit | integer | | +| result.config.gpuMemoryLimit | integer | | +| result.config.envVariables | std::string | | +| result.config.userId | integer | | +| result.config.groupId | integer | | +| result.config.dataImageSize | integer | | +| result.config.resourceManagerClientEnabled | bool | | +| result.config.dialId | std::string | | +| result.config.command | std::string | | +| result.config.appType | std::string | | +| result.config.appPath | std::string | | +| result.config.runtimePath | std::string | | +| result.config.logFilePath | std::string | | +| result.config.logFileMaxSize | integer | | +| result.config.logLevels | std::string | json array of strings | +| result.config.mapi | bool | | +| result.config.fkpsFiles | std::string | json array of strings | +| result.config.ralfPkgPath | std::string | Filesystem path holding metadata info of ralf packages | +| result.config.fireboltVersion | std::string | | +| result.config.enableDebugger | bool | | ### Examples @@ -1091,11 +1129,9 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 4, - "method": "org.rdk.PackageManager.getLockInfo", + "method": "org.rdk.PackageManager.getConfigForPackage", "params": { - "type": "", - "id": "", - "version": "" + "fileLocator": "" } } ``` @@ -1104,7 +1140,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PackageManager.getLockInfo", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PackageManager.getConfigForPackage", "params": {"fileLocator": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1115,41 +1151,52 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met "jsonrpc": 2.0, "id": 4, "result": { - "reason": "", - "owner": "" + "id": "", + "version": "", + "config": { + "dial": true, + "wanLanAccess": true, + "thunder": true, + "systemMemoryLimit": 0, + "gpuMemoryLimit": 0, + "envVariables": "", + "userId": 0, + "groupId": 0, + "dataImageSize": 0, + "resourceManagerClientEnabled": true, + "dialId": "", + "command": "", + "appType": "", + "appPath": "", + "runtimePath": "", + "logFilePath": "", + "logFileMaxSize": 0, + "logLevels": "", + "mapi": true, + "fkpsFiles": "", + "ralfPkgPath": "", + "fireboltVersion": "", + "enableDebugger": true + } } } ``` - -## *getMetadata* + +## *getStorageInformation* -Retrieves metadata and auxiliary resource list for an application. +GetStorageInformation ### Events Event details will be updated soon. ### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | +This method takes no parameters. ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.metadata | MetadataPayload | | -| result.metadata.appName | string | | -| result.metadata.type | string | | -| result.metadata.category | string | | -| result.metadata.url | string | | -| result.resources | IKeyValueIterator | | -| result.resources[#].key | string | | -| result.resources[#].value | string | | -| result.auxMetadata | IKeyValueIterator | | -| result.auxMetadata[#].key | string | | -| result.auxMetadata[#].value | string | | +| result.quotaKb | integer | Storage quota in kilobytes | +| result.usedKb | integer | Used storage in kilobytes | ### Examples @@ -1160,12 +1207,7 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 5, - "method": "org.rdk.PackageManager.getMetadata", - "params": { - "type": "", - "id": "", - "version": "" - } + "method": "org.rdk.PackageManager.getStorageInformation" } ``` @@ -1173,7 +1215,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.PackageManager.getMetadata", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.PackageManager.getStorageInformation"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1184,45 +1226,31 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met "jsonrpc": 2.0, "id": 5, "result": { - "metadata": { - "appName": "", - "type": "", - "category": "", - "url": "" - }, - "resources": [ - { - "key": "", - "value": "" - } - ], - "auxMetadata": [ - { - "key": "", - "value": "" - } - ] + "quotaKb": 0, + "usedKb": 0 } } ``` - -## *getProgress* + +## *listPackages* -Provides the current progress of an ongoing operation. +ListPackages ### Events Event details will be updated soon. ### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.handle | string | | +This method takes no parameters. ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.progress | integer | | +| result.packages | IPackageIterator | | +| result.packages[#].packageId | string | | +| result.packages[#].version | string | | +| result.packages[#].state | string | | +| result.packages[#].digest | string | | +| result.packages[#].sizeKb | integer | | ### Examples @@ -1232,11 +1260,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 6, - "method": "org.rdk.PackageManager.getProgress", - "params": { - "handle": "" - } + "id": 7, + "method": "org.rdk.PackageManager.listPackages" } ``` @@ -1244,7 +1269,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.PackageManager.getProgress", "params": {"handle": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.PackageManager.listPackages"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1253,17 +1278,23 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, - "result": { - "progress": 0 - } + "id": 7, + "result": [ + { + "packageId": "", + "version": "", + "state": "INSTALLING", + "digest": "", + "sizeKb": 0 + } + ] } ``` - -## *getStorageDetails* + +## *packageState* -Retrieves details about app and persistent storage usage. +PackageState ### Events Event details will be updated soon. @@ -1271,18 +1302,13 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | +| params.packageId | string | Package Id | +| params.version | string | Version | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.storageinfo | StorageInfo | | -| result.storageinfo.EXTERNAL | struct | | -| result.storageinfo.path | string | | -| result.storageinfo.quotaKB | string | | -| result.storageinfo.usedKB | string | | +| result.state | string | | ### Examples @@ -1292,11 +1318,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 7, - "method": "org.rdk.PackageManager.getStorageDetails", + "id": 8, + "method": "org.rdk.PackageManager.packageState", "params": { - "type": "", - "id": "", + "packageId": "", "version": "" } } @@ -1306,7 +1331,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.PackageManager.getStorageDetails", "params": {"type": "", "id": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "method": "org.rdk.PackageManager.packageState", "params": {"packageId": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1315,20 +1340,17 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "met ```json { "jsonrpc": 2.0, - "id": 7, + "id": 8, "result": { - "EXTERNAL": "", - "path": "", - "quotaKB": "", - "usedKB": "" + "state": "INSTALLING" } } ``` - -## *lock* + +## *pause* -Locks an application to prevent uninstallation. +Pause ### Events Event details will be updated soon. @@ -1336,16 +1358,11 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.reason | string | | -| params.owner | string | | +| params.downloadId | string | Download ID | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | object | | -| result.handle | string | | +| result | null | On success null will be returned. | ### Examples @@ -1356,13 +1373,9 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 9, - "method": "org.rdk.PackageManager.lock", + "method": "org.rdk.PackageManager.pause", "params": { - "type": "", - "id": "", - "version": "", - "reason": "", - "owner": "" + "downloadId": "" } } ``` @@ -1371,7 +1384,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.PackageManager.lock", "params": {"type": "", "id": "", "version": "", "reason": "", "owner": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.PackageManager.pause", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1381,16 +1394,14 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "met { "jsonrpc": 2.0, "id": 9, - "result": { - "handle": "" - } + "result": null } ``` - -## *reset* + +## *progress* -Deletes all persistent local data of the application. +Progress ### Events Event details will be updated soon. @@ -1398,14 +1409,12 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.resetType | string | | +| params.downloadId | string | Download ID | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | +| result | object | | +| result.progress | integer | | ### Examples @@ -1416,12 +1425,9 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 10, - "method": "org.rdk.PackageManager.reset", + "method": "org.rdk.PackageManager.progress", "params": { - "type": "", - "id": "", - "version": "", - "resetType": "" + "downloadId": "" } } ``` @@ -1430,7 +1436,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.PackageManager.reset", "params": {"type": "", "id": "", "version": "", "resetType": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.PackageManager.progress", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1440,14 +1446,16 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "me { "jsonrpc": 2.0, "id": 10, - "result": null + "result": { + "progress": 0 + } } ``` - -## *setAuxMetadata* + +## *rateLimit* -Sets a key-value pair of metadata for the application. +RateLimit ### Events Event details will be updated soon. @@ -1455,11 +1463,8 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.key | string | | -| params.value | string | | +| params.downloadId | string | Download ID | +| params.limit | integer | Limit | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -1474,13 +1479,10 @@ Event details will be updated soon. { "jsonrpc": 2.0, "id": 11, - "method": "org.rdk.PackageManager.setAuxMetadata", + "method": "org.rdk.PackageManager.rateLimit", "params": { - "type": "", - "id": "", - "version": "", - "key": "", - "value": "" + "downloadId": "", + "limit": 0 } } ``` @@ -1489,7 +1491,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.PackageManager.setAuxMetadata", "params": {"type": "", "id": "", "version": "", "key": "", "value": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.PackageManager.rateLimit", "params": {"downloadId": "", "limit": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1503,10 +1505,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me } ``` - -## *unlock* + +## *resume* -Unlocks a previously locked application. +Resume ### Events Event details will be updated soon. @@ -1514,7 +1516,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.handle | string | | +| params.downloadId | string | Download ID | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -1528,10 +1530,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 13, - "method": "org.rdk.PackageManager.unlock", + "id": 12, + "method": "org.rdk.PackageManager.resume", "params": { - "handle": "" + "downloadId": "" } } ``` @@ -1540,7 +1542,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.PackageManager.unlock", "params": {"handle": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.PackageManager.resume", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1549,7 +1551,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "me ```json { "jsonrpc": 2.0, - "id": 13, + "id": 12, "result": null } ``` @@ -1581,8 +1583,8 @@ Notifies completion of an asynchronous operation. | params.handle | string | | | params.operation | string | | | params.type | string | | -| params.id | string | | -| params.version | string | | +| params.id | string | package id | +| params.version | string | Version | | params.status | string | | | params.details | string | |