DELIA-67834 : Updated docs. (#276)

sborushevsky · anand-ky · web-flow · commit 4ab8acb1c34c · 2025-06-16T12:16:32.000-04:00
Co-authored-by: Anand Kandasamy &lt;37086488+anand-ky@users.noreply.github.com&gt;
diff --git a/docs/apis/SystemPlugin.md b/docs/apis/SystemPlugin.md
@@ -116,8 +116,6 @@ org.rdk.System interface methods:
 | [uploadLogsAsync](#uploadLogsAsync) | Starts background process to upload logs |
 | [abortLogUpload](#abortLogUpload) | Stops background process to upload logs |
 | [getThunderStartReason](#getThunderStartReason) | Returns the Thunder start reason |
-| [SetPrivacyMode](#SetPrivacyMode) | Setting Privacy Mode |
-| [getPrivacyMode](#getPrivacyMode) | Getting Privacy Mode |
 
 
 <a name="clearLastDeepSleepReason"></a>
@@ -3646,95 +3644,6 @@ This method takes no parameters.
 }
 ```
 
-<a name="SetPrivacyMode"></a>
-## *SetPrivacyMode*
-
-Setting Privacy Mode.
-
-### Events
-
-| Event | Description |
-| :-------- | :-------- |
-| [onPrivacyModeChanged](#onPrivacyModeChanged) | Triggered when the Privacy Mode changes. |
-### Parameters
-
-| Name | Type | Description |
-| :-------- | :-------- | :-------- |
-| params | object |  |
-| params.privacyMode | string | New Privacy Mode |
-
-### Result
-
-| Name | Type | Description |
-| :-------- | :-------- | :-------- |
-| result | string | On success null will be returned |
-
-### Example
-
-#### Request
-
-```json
-{
-    "jsonrpc": "2.0",
-    "id": 42,
-    "method": "org.rdk.System.SetPrivacyMode",
-    "params": {
-        "privacyMode": "DO_NOT_SHARE"
-    }
-}
-```
-
-#### Response
-
-```json
-{
-    "jsonrpc": "2.0",
-    "id": 42,
-    "result": "null"
-}
-```
-
-<a name="getPrivacyMode"></a>
-## *getPrivacyMode*
-
-Getting Privacy Mode.
-
-### Events
-
-No Events
-
-### Parameters
-
-This method takes no parameters.
-
-### Result
-
-| Name | Type | Description |
-| :-------- | :-------- | :-------- |
-| result | string | Current Privacy Mode |
-
-### Example
-
-#### Request
-
-```json
-{
-    "jsonrpc": "2.0",
-    "id": 42,
-    "method": "org.rdk.System.getPrivacyMode"
-}
-```
-
-#### Response
-
-```json
-{
-    "jsonrpc": "2.0",
-    "id": 42,
-    "result": "DO_NOT_SHARE"
-}
-```
-
 <a name="Notifications"></a>
 # Notifications
 
@@ -3761,7 +3670,6 @@ org.rdk.System interface events:
 | [onDeviceMgtUpdateReceived](#onDeviceMgtUpdateReceived) | Triggered when the device management update completes |
 | [onTimeZoneDSTChanged](#onTimeZoneDSTChanged) | Triggered when device time zone changed |
 | [onLogUpload](#onLogUpload) | Triggered when logs upload process is done or stopped |
-| [onPrivacyModeChanged](#onPrivacyModeChanged) | Triggered after the Privacy Mode changes (see `SetPrivacyMode`) |
 
 
 <a name="onFirmwarePendingReboot"></a>
@@ -4185,27 +4093,3 @@ Triggered when logs upload process is done or stopped.
 }
 ```
 
-<a name="onPrivacyModeChanged"></a>
-## *onPrivacyModeChanged*
-
-Triggered after the Privacy Mode changes (see `SetPrivacyMode`).
-
-### Parameters
-
-| Name | Type | Description |
-| :-------- | :-------- | :-------- |
-| params | object |  |
-| params.privacyMode | string | Receive Privacy Mode changes |
-
-### Example
-
-```json
-{
-    "jsonrpc": "2.0",
-    "method": "client.events.onPrivacyModeChanged",
-    "params": {
-        "privacyMode": "DO_NOT_SHARE"
-    }
-}
-```
-
diff --git a/docs/apis/UserSettingsPlugin.md b/docs/apis/UserSettingsPlugin.md
@@ -53,6 +53,7 @@ org.rdk.UserSettings interface methods:
 | [setCaptions](#setCaptions) | Setting Captions |
 | [setPreferredCaptionsLanguages](#setPreferredCaptionsLanguages) | Setting PreferredCaption Languages |
 | [setPreferredClosedCaptionService](#setPreferredClosedCaptionService) | Setting Preferred Closed Caption Service |
+| [setPrivacyMode](#setPrivacyMode) | Setting Privacy Mode |
 | [setPinControl](#setPinControl) | Setting PinControl |
 | [setViewingRestrictions](#setViewingRestrictions) | Setting ViewingRestrictions |
 | [setViewingRestrictionsWindow](#setViewingRestrictionsWindow) | Setting viewingRestrictionsWindow |
@@ -71,6 +72,7 @@ org.rdk.UserSettings interface methods:
 | [getCaptions](#getCaptions) | Getting Captions Enabled |
 | [getPreferredCaptionsLanguages](#getPreferredCaptionsLanguages) | Getting Preferred Caption Languages |
 | [getPreferredClosedCaptionService](#getPreferredClosedCaptionService) | Getting Preferred ClosedCaption Service |
+| [getPrivacyMode](#getPrivacyMode) | Getting Privacy Mode |
 | [getPinControl](#getPinControl) | Returns Pin Control |
 | [getViewingRestrictions](#getViewingRestrictions) | Returns Get Viewing Restrictions |
 | [getViewingRestrictionsWindow](#getViewingRestrictionsWindow) | Returns Get Viewing Restrictions Window |
@@ -375,6 +377,54 @@ Setting Preferred Closed Caption Service.
 }
 ```
 
+<a name="setPrivacyMode"></a>
+## *setPrivacyMode*
+
+Setting Privacy Mode.
+
+### Events
+
+| Event | Description |
+| :-------- | :-------- |
+| [onPrivacyModeChanged](#onPrivacyModeChanged) | Triggered when the Privacy Mode changes. |
+### Parameters
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.privacyMode | string | The Privacy Mode. Valid values are SHARE, DO_NOT_SHARE |
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | null | On success null will be returned |
+
+### Example
+
+#### Request
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "method": "org.rdk.UserSettings.setPrivacyMode",
+    "params": {
+        "privacyMode": "SHARE"
+    }
+}
+```
+
+#### Response
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "result": null
+}
+```
+
 <a name="setPinControl"></a>
 ## *setPinControl*
 
@@ -1197,6 +1247,47 @@ This method takes no parameters.
 }
 ```
 
+<a name="getPrivacyMode"></a>
+## *getPrivacyMode*
+
+Getting Privacy Mode.
+
+### Events
+
+No Events
+
+### Parameters
+
+This method takes no parameters.
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | string | The Privacy Mode. Valid values are SHARE, DO_NOT_SHARE |
+
+### Example
+
+#### Request
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "method": "org.rdk.UserSettings.getPrivacyMode"
+}
+```
+
+#### Response
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "result": "SHARE"
+}
+```
+
 <a name="getPinControl"></a>
 ## *getPinControl*
 
@@ -1802,6 +1893,7 @@ org.rdk.UserSettings interface events:
 | [onCaptionsChanged](#onCaptionsChanged) | Triggered after the captions changes (see `SetCaptions`) |
 | [onPreferredCaptionsLanguagesChanged](#onPreferredCaptionsLanguagesChanged) | Triggered after the PreferredCaption Languages changes (see `SetPreferredCaptionsLanguages`) |
 | [onPreferredClosedCaptionServiceChanged](#onPreferredClosedCaptionServiceChanged) | Triggered after the Preferred Closed Caption changes (see `SetPreferredClosedCaptionService`) |
+| [onPrivacyModeChanged](#onPrivacyModeChanged) | Triggered after the Privacy Mode changes (see `SetPrivacyMode`) |
 | [onPinControlChanged](#onPinControlChanged) | Triggered after the pin control changes (see `setPinControl`) |
 | [onViewingRestrictionsChanged](#onViewingRestrictionsChanged) | Triggered after the viewingRestrictions changes (see `setViewingRestrictions`) |
 | [onViewingRestrictionsWindowChanged](#onViewingRestrictionsWindowChanged) | Triggered after the viewingRestrictionsWindow changes (see `setViewingRestrictionsWindow`) |
@@ -1960,6 +2052,30 @@ Triggered after the Preferred Closed Caption changes (see `SetPreferredClosedCap
 }
 ```
 
+<a name="onPrivacyModeChanged"></a>
+## *onPrivacyModeChanged*
+
+Triggered after the Privacy Mode changes (see `SetPrivacyMode`).
+
+### Parameters
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.privacyMode | string | Receive Privacy Mode changes |
+
+### Example
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "client.events.onPrivacyModeChanged",
+    "params": {
+        "privacyMode": "DO_NOT_SHARE"
+    }
+}
+```
+
 <a name="onPinControlChanged"></a>
 ## *onPinControlChanged*
 
diff --git a/tools/json_generator/output/SystemServices/System.json b/tools/json_generator/output/SystemServices/System.json
@@ -1939,35 +1939,6 @@
                     "success"
                 ]
             }
-        },
-        "SetPrivacyMode": {
-            "summary": "Setting Privacy Mode.",          
-            "events": {
-                "onPrivacyModeChanged" : "Triggered when the Privacy Mode changes."
-            },
-            "params": {
-                "type": "object",
-                "properties": {
-                    "privacyMode": {
-                        "summary": "New Privacy Mode",
-                        "type": "string",
-                        "example": "DO_NOT_SHARE"
-                    }
-                }
-            },
-            "result": {
-                "summary": "On success null will be returned",
-                "type": "string",
-                "example": "null"
-            }
-        },
-        "getPrivacyMode":{
-            "summary": "Getting Privacy Mode",
-            "result": {
-                "summary": "Current Privacy Mode",
-                "type": "string",
-                "example": "DO_NOT_SHARE"
-            }
         }
     },
     "events": {
@@ -2350,22 +2321,6 @@
                     "logUploadStatus"
                 ]
             }
-        },
-        "onPrivacyModeChanged": {
-            "summary": "Triggered after the Privacy Mode changes (see `SetPrivacyMode`)",
-            "params": {
-                "type": "object",
-                "properties": {
-                    "privacyMode":{
-                        "summary": "Receive Privacy Mode changes",
-                        "type": "string",
-                        "example": "DO_NOT_SHARE"
-                    }
-                },
-                "required": [
-                    "privacyMode"
-                ]
-            }
         }
     }
 }
diff --git a/tools/json_generator/output/UserSettings/UserSettings.json b/tools/json_generator/output/UserSettings/UserSettings.json
