Merge pull request #225 from rdkcentral/feature/RDK-57747

RDK-57747: Updated version details.

Author: ramasat

docs/apis/UserSettingsPlugin.md

@@ -2,7 +2,7 @@
 <a name="UserSettings_Plugin"></a>
 # UserSettings Plugin
 
-**Version: [1.0.0]()**
+**Version: [2.3.0](https://github.com/rdkcentral/rdkservices/blob/main/UserSettings/CHANGELOG.md)**
 
 A org.rdk.UserSettings plugin for Thunder framework.
 
@@ -17,7 +17,7 @@ A org.rdk.UserSettings plugin for Thunder framework.
 <a name="Abbreviation,_Acronyms_and_Terms"></a>
 # Abbreviation, Acronyms and Terms
 
-[[Refer to this link](overview/aat.md)]
+[[Refer to this link](userguide/aat.md)]
 
 <a name="Description"></a>
 # Description
@@ -64,6 +64,7 @@ org.rdk.UserSettings interface methods:
 | [setVoiceGuidance](#setVoiceGuidance) | Sets voiceGuidance |
 | [setVoiceGuidanceRate](#setVoiceGuidanceRate) | Sets voiceGuidanceRate |
 | [setVoiceGuidanceHints](#setVoiceGuidanceHints) | Sets voiceGuidanceHints ON/OFF |
+| [setContentPin](#setContentPin) | Setting ContentPin |
 | [getAudioDescription](#getAudioDescription) | Returns Audio Description |
 | [getPreferredAudioLanguages](#getPreferredAudioLanguages) | Returns Preferred Audio Languages |
 | [getPresentationLanguage](#getPresentationLanguage) | Getting Presentation Languages |
@@ -83,6 +84,7 @@ org.rdk.UserSettings interface methods:
 | [getVoiceGuidanceHints](#getVoiceGuidanceHints) | Gets the current voiceGuidanceHints setting |
 | [getMigrationState](#getMigrationState) | Gets the migration state of the respective key |
 | [getMigrationStates](#getMigrationStates) | Gets the migration state of all the defined keys |
+| [getContentPin](#getContentPin) | Returns ContentPin |
 
 
 <a name="setAudioDescription"></a>
@@ -901,6 +903,54 @@ Sets voiceGuidanceHints ON/OFF. Whether Voice Guidance hints setting is switched
 }
 ```
 
+<a name="setContentPin"></a>
+## *setContentPin*
+
+Setting ContentPin.
+
+### Events
+
+| Event | Description |
+| :-------- | :-------- |
+| [onContentPinChanged](#onContentPinChanged) | Triggered when the ContentPin changes. |
+### Parameters
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.contentPin | string | contentPin |
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | string | On success null will be returned |
+
+### Example
+
+#### Request
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "method": "org.rdk.UserSettings.setContentPin",
+    "params": {
+        "contentPin": "1234"
+    }
+}
+```
+
+#### Response
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "result": "null"
+}
+```
+
 <a name="getAudioDescription"></a>
 ## *getAudioDescription*
 
@@ -1664,8 +1714,8 @@ This method takes no parameters.
 | :-------- | :-------- | :-------- |
 | result | array | migration state of all the defined keys |
 | result[#] | object | Keys and it's migration states |
-| result[#].key | string | key of the property |
-| result[#].requiresMigration | boolean | Migration State Of the Property |
+| result[#]?.key | string | <sup>*(optional)*</sup> key of the property |
+| result[#]?.requiresMigration | boolean | <sup>*(optional)*</sup> migration state of the property |
 
 ### Example
 
@@ -1694,6 +1744,47 @@ This method takes no parameters.
 }
 ```
 
+<a name="getContentPin"></a>
+## *getContentPin*
+
+Returns ContentPin.
+
+### Events
+
+No Events
+
+### Parameters
+
+This method takes no parameters.
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | string | contentPin |
+
+### Example
+
+#### Request
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "method": "org.rdk.UserSettings.getContentPin"
+}
+```
+
+#### Response
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "result": "1234"
+}
+```
+
 <a name="Notifications"></a>
 # Notifications
 
@@ -1722,6 +1813,7 @@ org.rdk.UserSettings interface events:
 | [onVoiceGuidanceChanged](#onVoiceGuidanceChanged) | Triggered after the voice guidance enabled settings changes |
 | [onVoiceGuidanceRateChanged](#onVoiceGuidanceRateChanged) | Triggered after the voice guidance rate changed |
 | [onVoiceGuidanceHintsChanged](#onVoiceGuidanceHintsChanged) | Triggered after the voice guidance hints changes |
+| [onContentPinChanged](#onContentPinChanged) | Triggered after the ContentPin changes (see `setContentPin`) |
 
 
 <a name="onAudioDescriptionChanged"></a>
@@ -2132,3 +2224,27 @@ Triggered after the voice guidance hints changes.(see `SetVoiceGuidanceHints`).
 }
 ```
 
+<a name="onContentPinChanged"></a>
+## *onContentPinChanged*
+
+Triggered after the ContentPin changes (see `setContentPin`).
+
+### Parameters
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| params | object |  |
+| params.contentPin | string | contentPin |
+
+### Example
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "client.events.onContentPinChanged",
+    "params": {
+        "contentPin": "1234"
+    }
+}
+```
+

tools/json_generator/output/UserSettings/UserSettings.json

@@ -46,7 +46,12 @@
             "type": "number",
             "example": 0.1
         },
-		"MigrationStates": {
+        "contentPin": {
+            "summary": "contentPin",
+            "type": "string",
+            "example": "1234"
+        },
+        "MigrationStates": {
             "summary": "Keys and it's migration states",
             "type": "object",
             "properties": {
@@ -56,7 +61,7 @@
                     "example": "PREFERRED_AUDIO_LANGUAGES"
                 },
                 "requiresMigration": {
-                    "summary": "The name of the USB device",
+                    "summary": "migration state of the property",
                     "type": "boolean",
                     "example": true
                 }
@@ -408,6 +413,25 @@
                 "example": "null"
             }
         },
+        "setContentPin": {
+            "summary": "Setting ContentPin.",
+			"events": {
+                "onContentPinChanged" : "Triggered when the ContentPin changes."
+            },
+            "params": {
+                "type": "object",
+                "properties": {
+                    "contentPin": {
+                        "$ref": "#/definitions/contentPin"
+                    }
+                }
+            },
+            "result": {
+                "summary": "On success null will be returned",
+                "type": "string",
+                "example": "null"
+            }
+        },
         "getAudioDescription":
 		{
             "summary": "Returns Audio Description.",
@@ -545,7 +569,7 @@
                         "example": "VOICE_GUIDANCE_RATE"
                     }
                 },
-                "required": ["deviceName"]
+                "required": ["key"]
             },
             "result": {
                 "summary": "migration state of the respective key true/false",
@@ -563,6 +587,12 @@
                     "$ref": "#/definitions/MigrationStates"
                 }
             }
+        },
+        "getContentPin":{
+            "summary": "Returns ContentPin.",
+            "result": {
+              "$ref": "#/definitions/contentPin"
+            }
         }
     },
     "events": {
@@ -833,8 +863,21 @@
                 },
                 "required": [ "hints" ]
             }
-        }
+        },
+        "onContentPinChanged": {
+			"summary": "Triggered after the ContentPin changes (see `setContentPin`)",
+			"params": {
+				"type": "object",
+				"properties": {
+                    "contentPin": {
+                        "$ref": "#/definitions/contentPin"
+                    }
+				},
+				"required": [
+					"contentPin"
+				]
+			}
+		}
     }
 }
 
-