diff --git a/apis/PackageManager/IAppPackageManager.h b/apis/PackageManager/IAppPackageManager.h index 58d53354..707cfefc 100644 --- a/apis/PackageManager/IAppPackageManager.h +++ b/apis/PackageManager/IAppPackageManager.h @@ -272,7 +272,6 @@ namespace Exchange { }; - // @json 1.0.0 @text:keep struct EXTERNAL IPackageHandler : virtual public Core::IUnknown { enum { ID = ID_PACKAGE_HANDLER }; diff --git a/apis/RDKWindowManager/IRDKWindowManager.h b/apis/RDKWindowManager/IRDKWindowManager.h index ab2f166a..49da9b82 100755 --- a/apis/RDKWindowManager/IRDKWindowManager.h +++ b/apis/RDKWindowManager/IRDKWindowManager.h @@ -223,6 +223,34 @@ struct EXTERNAL IRDKWindowManager : virtual public Core::IUnknown { // @retval Core::ERROR_NONE: Successfully retrieved the last key press information. // @retval Core::ERROR_UNAVAILABLE: No key press information is available. virtual Core::hresult GetLastKeyInfo(uint32_t &keyCode /* @out */, uint32_t &modifiers /* @out */, uint64_t ×tampInSeconds /* @out */) const = 0; + + /** Sets the zOrder of the given client or appInstanceId */ + // @text setZOrder + // @brief Sets the zOrder of the given client or appInstanceId + // @param appInstanceId: client name or application instance ID + // @param zOrder: integer value indicating the zOrder + // @retval Core::ERROR_NONE on success + virtual Core::hresult SetZOrder(const string& appInstanceId, const int32_t zOrder) = 0; + + /** Gets the zOrder of the given client or appInstanceId */ + // @text getZOrder + // @brief Gets the zOrder of the given client or appInstanceId + // @param appInstanceId: client name or application instance ID + // @param zOrder: integer value indicating the zOrder of the client + // @retval Core::ERROR_NONE on success + virtual Core::hresult GetZOrder(const string& appInstanceId, int32_t &zOrder /* @out */) = 0; + + /** Starts the VNC server */ + // @text startVncServer + // @brief Starts the VNC server + // @retval Core::ERROR_NONE on success + virtual Core::hresult StartVncServer() = 0; + + /** Stops the VNC server */ + // @text stopVncServer + // @brief Stops the VNC server + // @retval Core::ERROR_NONE on success + virtual Core::hresult StopVncServer() = 0; }; } // namespace Exchange } // namespace WPEFramework diff --git a/docs/apis/PackageManager.md b/docs/apis/PackageManager.md index 87b39b02..d42ac0a8 100644 --- a/docs/apis/PackageManager.md +++ b/docs/apis/PackageManager.md @@ -52,26 +52,25 @@ PackageManager interface methods: | [delete](#delete) | Delete | | [download](#download) | Downloads a resource file for an application. | | [getConfigForPackage](#getConfigForPackage) | getConfigForPackage | -| [getLockedInfo](#getLockedInfo) | GetLockedInfo | | [getStorageInformation](#getStorageInformation) | GetStorageInformation | | [install](#install) | Downloads and installs an application bundle. | | [listPackages](#listPackages) | ListPackages | -| [lock](#lock) | Locks an application to prevent uninstallation. | | [packageState](#packageState) | PackageState | | [pause](#pause) | Pause | | [progress](#progress) | Progress | | [rateLimit](#rateLimit) | RateLimit | | [resume](#resume) | Resume | | [uninstall](#uninstall) | Uninstalls an application. | -| [unlock](#unlock) | Unlocks a previously locked application. | | [clearAuxMetadata](#clearAuxMetadata) | Clears the specified metadata key. | | [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. | +| [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. | +| [unlock](#unlock) | Unlocks a previously locked application. | ## *cancel* @@ -439,113 +438,6 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met } ``` - -## *getLockedInfo* - -GetLockedInfo - -### Events -Event details will be updated soon. -### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.packageId | string | Package Id | -| params.version | string | | -### Results -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.unpackedPath | string | Unpacked Path | -| 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.gatewayMetadataPath | string | | -| result.locked | bool | | - -### Examples - - -#### Request - -```json -{ - "jsonrpc": 2.0, - "id": 5, - "method": "org.rdk.PackageManager.getLockedInfo", - "params": { - "packageId": "", - "version": "" - } -} -``` - - -#### CURL Command - -```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.PackageManager.getLockedInfo", "params": {"packageId": "", "version": ""}}' http://127.0.0.1:9998/jsonrpc -``` - - -#### Response - -```json -{ - "jsonrpc": 2.0, - "id": 5, - "result": { - "unpackedPath": "", - "configMetadata": { - "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 - }, - "gatewayMetadataPath": "", - "locked": true - } -} -``` - ## *getStorageInformation* @@ -570,7 +462,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 6, + "id": 5, "method": "org.rdk.PackageManager.getStorageInformation" } ``` @@ -579,7 +471,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "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.getStorageInformation"}' http://127.0.0.1:9998/jsonrpc ``` @@ -588,7 +480,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, + "id": 5, "result": { "quotaKb": 0, "usedKb": 0 @@ -688,7 +580,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 8, + "id": 7, "method": "org.rdk.PackageManager.listPackages" } ``` @@ -697,7 +589,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "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.listPackages"}' http://127.0.0.1:9998/jsonrpc ``` @@ -706,7 +598,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "met ```json { "jsonrpc": 2.0, - "id": 8, + "id": 7, "result": [ { "packageId": "", @@ -719,68 +611,6 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "met } ``` - -## *lock* - -Locks an application to prevent uninstallation. - -### Events -Event details will be updated soon. -### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.type | string | | -| params.id | string | | -| params.version | string | | -| params.reason | string | | -| params.owner | string | | -### Results -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | object | | -| result.handle | string | | - -### Examples - - -#### Request - -```json -{ - "jsonrpc": 2.0, - "id": 9, - "method": "org.rdk.PackageManager.lock", - "params": { - "type": "", - "id": "", - "version": "", - "reason": "", - "owner": "" - } -} -``` - - -#### 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 -``` - - -#### Response - -```json -{ - "jsonrpc": 2.0, - "id": 9, - "result": { - "handle": "" - } -} -``` - ## *packageState* @@ -808,7 +638,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 10, + "id": 8, "method": "org.rdk.PackageManager.packageState", "params": { "packageId": "", @@ -821,7 +651,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.packageState", "params": {"packageId": "", "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 ``` @@ -830,7 +660,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "me ```json { "jsonrpc": 2.0, - "id": 10, + "id": 8, "result": { "state": "INSTALLING" } @@ -862,7 +692,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 11, + "id": 9, "method": "org.rdk.PackageManager.pause", "params": { "downloadId": "" @@ -874,7 +704,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.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.pause", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -883,7 +713,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me ```json { "jsonrpc": 2.0, - "id": 11, + "id": 9, "result": null } ``` @@ -914,7 +744,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 12, + "id": 10, "method": "org.rdk.PackageManager.progress", "params": { "downloadId": "" @@ -926,7 +756,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.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.progress", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -935,7 +765,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, + "id": 10, "result": { "progress": 0 } @@ -968,7 +798,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 13, + "id": 11, "method": "org.rdk.PackageManager.rateLimit", "params": { "downloadId": "", @@ -981,7 +811,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.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.rateLimit", "params": {"downloadId": "", "limit": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -990,7 +820,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "me ```json { "jsonrpc": 2.0, - "id": 13, + "id": 11, "result": null } ``` @@ -1020,7 +850,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 14, + "id": 12, "method": "org.rdk.PackageManager.resume", "params": { "downloadId": "" @@ -1032,7 +862,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "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": 12, "method": "org.rdk.PackageManager.resume", "params": {"downloadId": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1041,7 +871,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, + "id": 12, "result": null } ``` @@ -1106,57 +936,6 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me } ``` - -## *unlock* - -Unlocks a previously locked application. - -### Events -Event details will be updated soon. -### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.handle | string | | -### Results -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | - -### Examples - - -#### Request - -```json -{ - "jsonrpc": 2.0, - "id": 13, - "method": "org.rdk.PackageManager.unlock", - "params": { - "handle": "" - } -} -``` - - -#### 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 -``` - - -#### Response - -```json -{ - "jsonrpc": 2.0, - "id": 13, - "result": null -} -``` - ## *clearAuxMetadata* @@ -1546,6 +1325,68 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "met } ``` + +## *lock* + +Locks an application to prevent uninstallation. + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.type | string | | +| params.id | string | | +| params.version | string | | +| params.reason | string | | +| params.owner | string | | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.handle | string | | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 9, + "method": "org.rdk.PackageManager.lock", + "params": { + "type": "", + "id": "", + "version": "", + "reason": "", + "owner": "" + } +} +``` + + +#### 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 +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 9, + "result": { + "handle": "" + } +} +``` + ## *reset* @@ -1662,6 +1503,57 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me } ``` + +## *unlock* + +Unlocks a previously locked application. + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.handle | string | | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 13, + "method": "org.rdk.PackageManager.unlock", + "params": { + "handle": "" + } +} +``` + + +#### 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 +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 13, + "result": null +} +``` + diff --git a/docs/apis/RDKWindowManager.md b/docs/apis/RDKWindowManager.md index 76508ccb..6136c9ea 100644 --- a/docs/apis/RDKWindowManager.md +++ b/docs/apis/RDKWindowManager.md @@ -59,6 +59,7 @@ RDKWindowManager interface methods: | [getApps](#getApps) | Get the list of Apps which are currently active and available | | [getKeyRepeatsEnabled](#getKeyRepeatsEnabled) | Retrieves the flag determining whether keyRepeat true/false | | [getLastKeyInfo](#getLastKeyInfo) | Retrieves information about the most recent key press event, including the key code, modifier flags, and the timestamp in seconds when the key was pressed. | +| [getZOrder](#getZOrder) | Gets the zOrder of the given client or appInstanceId | | [ignoreKeyInputs](#ignoreKeyInputs) | Ignore key inputs | | [injectKey](#injectKey) | Simulates a key press event with optional modifiers. | | [keyRepeatConfig](#keyRepeatConfig) | Enables KeyInputEvents for list of clients specified | @@ -69,6 +70,9 @@ RDKWindowManager interface methods: | [setFocus](#setFocus) | Sets the focus to the app with the app id | | [setInactivityInterval](#setInactivityInterval) | Sets inactivity interval if EnableUserInactivity feature is enabled | | [setVisible](#setVisible) | Sets the visibility of the given client or appInstanceId | +| [setZOrder](#setZOrder) | Sets the zOrder of the given client or appInstanceId | +| [startVncServer](#startVncServer) | Starts the VNC server @retval Core::ERROR_NONE on success | +| [stopVncServer](#stopVncServer) | Stops the VNC server @retval Core::ERROR_NONE on success | ## *addKeyIntercept* @@ -683,6 +687,60 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me } ``` + +## *getZOrder* + +Gets the zOrder of the given client or appInstanceId + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.appInstanceId | string | the identifier of the connected application | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 12, + "method": "org.rdk.RDKWindowManager.getZOrder", + "params": { + "appInstanceId": "" + } +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.RDKWindowManager.getZOrder", "params": {"appInstanceId": ""}}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 12, + "result": { + "zOrder": 0 + } +} +``` + ## *ignoreKeyInputs* @@ -708,7 +766,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 12, + "id": 13, "method": "org.rdk.RDKWindowManager.ignoreKeyInputs", "params": { "ignore": true @@ -720,7 +778,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.RDKWindowManager.ignoreKeyInputs", "params": {"ignore": true}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.RDKWindowManager.ignoreKeyInputs", "params": {"ignore": true}}' http://127.0.0.1:9998/jsonrpc ``` @@ -729,7 +787,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, + "id": 13, "result": null } ``` @@ -760,7 +818,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 13, + "id": 14, "method": "org.rdk.RDKWindowManager.injectKey", "params": { "keyCode": 0, @@ -773,7 +831,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.RDKWindowManager.injectKey", "params": {"keyCode": 0, "modifiers": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.RDKWindowManager.injectKey", "params": {"keyCode": 0, "modifiers": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -782,7 +840,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "me ```json { "jsonrpc": 2.0, - "id": 13, + "id": 14, "result": null } ``` @@ -813,7 +871,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 14, + "id": 15, "method": "org.rdk.RDKWindowManager.keyRepeatConfig", "params": { "input": "", @@ -826,7 +884,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.RDKWindowManager.keyRepeatConfig", "params": {"input": "", "keyConfig": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.RDKWindowManager.keyRepeatConfig", "params": {"input": "", "keyConfig": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -835,7 +893,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, + "id": 15, "result": null } ``` @@ -865,7 +923,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 15, + "id": 16, "method": "org.rdk.RDKWindowManager.removeKeyIntercept", "params": { "intercept": "" @@ -877,7 +935,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.RDKWindowManager.removeKeyIntercept", "params": {"intercept": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.RDKWindowManager.removeKeyIntercept", "params": {"intercept": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -886,7 +944,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me ```json { "jsonrpc": 2.0, - "id": 15, + "id": 16, "result": null } ``` @@ -916,7 +974,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 16, + "id": 17, "method": "org.rdk.RDKWindowManager.removeKeyListener", "params": { "keyListeners": "" @@ -928,7 +986,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.RDKWindowManager.removeKeyListener", "params": {"keyListeners": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.RDKWindowManager.removeKeyListener", "params": {"keyListeners": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -937,7 +995,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me ```json { "jsonrpc": 2.0, - "id": 16, + "id": 17, "result": null } ``` @@ -968,7 +1026,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 17, + "id": 18, "method": "org.rdk.RDKWindowManager.renderReady", "params": { "client": "" @@ -980,7 +1038,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.RDKWindowManager.renderReady", "params": {"client": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.RDKWindowManager.renderReady", "params": {"client": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -989,7 +1047,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "me ```json { "jsonrpc": 2.0, - "id": 17, + "id": 18, "result": { "status": true } @@ -1018,7 +1076,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 18, + "id": 19, "method": "org.rdk.RDKWindowManager.resetInactivityTime" } ``` @@ -1027,7 +1085,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.RDKWindowManager.resetInactivityTime"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.RDKWindowManager.resetInactivityTime"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1036,7 +1094,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me ```json { "jsonrpc": 2.0, - "id": 18, + "id": 19, "result": null } ``` @@ -1066,7 +1124,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 19, + "id": 20, "method": "org.rdk.RDKWindowManager.setFocus", "params": { "client": "" @@ -1078,7 +1136,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.RDKWindowManager.setFocus", "params": {"client": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.RDKWindowManager.setFocus", "params": {"client": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1087,7 +1145,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me ```json { "jsonrpc": 2.0, - "id": 19, + "id": 20, "result": null } ``` @@ -1117,7 +1175,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 20, + "id": 21, "method": "org.rdk.RDKWindowManager.setInactivityInterval", "params": { "interval": 0 @@ -1129,7 +1187,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.RDKWindowManager.setInactivityInterval", "params": {"interval": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.RDKWindowManager.setInactivityInterval", "params": {"interval": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1138,7 +1196,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me ```json { "jsonrpc": 2.0, - "id": 20, + "id": 21, "result": null } ``` @@ -1169,7 +1227,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 21, + "id": 22, "method": "org.rdk.RDKWindowManager.setVisible", "params": { "client": "", @@ -1182,7 +1240,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.RDKWindowManager.setVisible", "params": {"client": "", "visible": true}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.RDKWindowManager.setVisible", "params": {"client": "", "visible": true}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1191,7 +1249,150 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me ```json { "jsonrpc": 2.0, - "id": 21, + "id": 22, + "result": null +} +``` + + +## *setZOrder* + +Sets the zOrder of the given client or appInstanceId + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.appInstanceId | string | the identifier of the connected application | +| params.zOrder | integer | integer value indicating the zOrder @retval Core::ERROR_NONE on success | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 23, + "method": "org.rdk.RDKWindowManager.setZOrder", + "params": { + "appInstanceId": "", + "zOrder": 0 + } +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 23, "method": "org.rdk.RDKWindowManager.setZOrder", "params": {"appInstanceId": "", "zOrder": 0}}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 23, + "result": null +} +``` + + +## *startVncServer* + +Starts the VNC server @retval Core::ERROR_NONE on success + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 24, + "method": "org.rdk.RDKWindowManager.startVncServer" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 24, "method": "org.rdk.RDKWindowManager.startVncServer"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 24, + "result": null +} +``` + + +## *stopVncServer* + +Stops the VNC server @retval Core::ERROR_NONE on success + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 25, + "method": "org.rdk.RDKWindowManager.stopVncServer" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 25, "method": "org.rdk.RDKWindowManager.stopVncServer"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 25, "result": null } ``` @@ -1234,7 +1435,7 @@ Notifies when an application is blurred ```json { "jsonrpc": 2.0, - "id": 22, + "id": 26, "method": "org.rdk.RDKWindowManager.onBlur", "params": { "appInstanceId": "" @@ -1258,7 +1459,7 @@ Notifies when an application is connected ```json { "jsonrpc": 2.0, - "id": 23, + "id": 27, "method": "org.rdk.RDKWindowManager.onConnected", "params": { "appInstanceId": "" @@ -1282,7 +1483,7 @@ Notifies when an application is disconnected ```json { "jsonrpc": 2.0, - "id": 24, + "id": 28, "method": "org.rdk.RDKWindowManager.onDisconnected", "params": { "client": "" @@ -1306,7 +1507,7 @@ Notifies when an application is in focus ```json { "jsonrpc": 2.0, - "id": 25, + "id": 29, "method": "org.rdk.RDKWindowManager.onFocus", "params": { "appInstanceId": "" @@ -1330,7 +1531,7 @@ Notifies when an application is hidden ```json { "jsonrpc": 2.0, - "id": 26, + "id": 30, "method": "org.rdk.RDKWindowManager.onHidden", "params": { "appInstanceId": "" @@ -1354,7 +1555,7 @@ Posting the client for first frame ready. ```json { "jsonrpc": 2.0, - "id": 27, + "id": 31, "method": "org.rdk.RDKWindowManager.onReady", "params": { "client": "" @@ -1378,7 +1579,7 @@ Posting the client is inactive state ```json { "jsonrpc": 2.0, - "id": 28, + "id": 32, "method": "org.rdk.RDKWindowManager.onUserInactivity", "params": { "minutes": 0.0 @@ -1402,7 +1603,7 @@ Notifies when an application is visible ```json { "jsonrpc": 2.0, - "id": 29, + "id": 33, "method": "org.rdk.RDKWindowManager.onVisible", "params": { "appInstanceId": ""