22<a name =" UserSettings_Plugin " ></a >
33# UserSettings Plugin
44
5- ** Version: [ 1.0 .0] ( ) **
5+ ** Version: [ 2.3 .0] ( https://github.com/rdkcentral/rdkservices/blob/main/UserSettings/CHANGELOG.md ) **
66
77A org.rdk.UserSettings plugin for Thunder framework.
88
@@ -17,7 +17,7 @@ A org.rdk.UserSettings plugin for Thunder framework.
1717<a name =" Abbreviation,_Acronyms_and_Terms " ></a >
1818# Abbreviation, Acronyms and Terms
1919
20- [[ Refer to this link] ( overview /aat.md)]
20+ [[ Refer to this link] ( userguide /aat.md)]
2121
2222<a name =" Description " ></a >
2323# Description
@@ -64,6 +64,7 @@ org.rdk.UserSettings interface methods:
6464| [ setVoiceGuidance] ( #setVoiceGuidance ) | Sets voiceGuidance |
6565| [ setVoiceGuidanceRate] ( #setVoiceGuidanceRate ) | Sets voiceGuidanceRate |
6666| [ setVoiceGuidanceHints] ( #setVoiceGuidanceHints ) | Sets voiceGuidanceHints ON/OFF |
67+ | [ setContentPin] ( #setContentPin ) | Setting ContentPin |
6768| [ getAudioDescription] ( #getAudioDescription ) | Returns Audio Description |
6869| [ getPreferredAudioLanguages] ( #getPreferredAudioLanguages ) | Returns Preferred Audio Languages |
6970| [ getPresentationLanguage] ( #getPresentationLanguage ) | Getting Presentation Languages |
@@ -83,6 +84,7 @@ org.rdk.UserSettings interface methods:
8384| [ getVoiceGuidanceHints] ( #getVoiceGuidanceHints ) | Gets the current voiceGuidanceHints setting |
8485| [ getMigrationState] ( #getMigrationState ) | Gets the migration state of the respective key |
8586| [ getMigrationStates] ( #getMigrationStates ) | Gets the migration state of all the defined keys |
87+ | [ getContentPin] ( #getContentPin ) | Returns ContentPin |
8688
8789
8890<a name =" setAudioDescription " ></a >
@@ -901,6 +903,54 @@ Sets voiceGuidanceHints ON/OFF. Whether Voice Guidance hints setting is switched
901903}
902904```
903905
906+ <a name =" setContentPin " ></a >
907+ ## * setContentPin*
908+
909+ Setting ContentPin.
910+
911+ ### Events
912+
913+ | Event | Description |
914+ | :-------- | :-------- |
915+ | [ onContentPinChanged] ( #onContentPinChanged ) | Triggered when the ContentPin changes. |
916+ ### Parameters
917+
918+ | Name | Type | Description |
919+ | :-------- | :-------- | :-------- |
920+ | params | object | |
921+ | params.contentPin | string | contentPin |
922+
923+ ### Result
924+
925+ | Name | Type | Description |
926+ | :-------- | :-------- | :-------- |
927+ | result | string | On success null will be returned |
928+
929+ ### Example
930+
931+ #### Request
932+
933+ ``` json
934+ {
935+ "jsonrpc" : " 2.0"
936+ "id" : 42 ,
937+ "method" : " org.rdk.UserSettings.setContentPin"
938+ "params" : {
939+ "contentPin" : " 1234"
940+ }
941+ }
942+ ```
943+
944+ #### Response
945+
946+ ``` json
947+ {
948+ "jsonrpc" : " 2.0"
949+ "id" : 42 ,
950+ "result" : " null"
951+ }
952+ ```
953+
904954<a name =" getAudioDescription " ></a >
905955## * getAudioDescription*
906956
@@ -1664,8 +1714,8 @@ This method takes no parameters.
16641714| :-------- | :-------- | :-------- |
16651715| result | array | migration state of all the defined keys |
16661716| result[ #] | object | Keys and it's migration states |
1667- | result[ #] .key | string | key of the property |
1668- | result[ #] .requiresMigration | boolean | Migration State Of the Property |
1717+ | result[ #] ? .key | string | < sup > * (optional) * </ sup > key of the property |
1718+ | result[ #] ? .requiresMigration | boolean | < sup > * (optional) * </ sup > migration state of the property |
16691719
16701720### Example
16711721
@@ -1694,6 +1744,47 @@ This method takes no parameters.
16941744}
16951745```
16961746
1747+ <a name =" getContentPin " ></a >
1748+ ## * getContentPin*
1749+
1750+ Returns ContentPin.
1751+
1752+ ### Events
1753+
1754+ No Events
1755+
1756+ ### Parameters
1757+
1758+ This method takes no parameters.
1759+
1760+ ### Result
1761+
1762+ | Name | Type | Description |
1763+ | :-------- | :-------- | :-------- |
1764+ | result | string | contentPin |
1765+
1766+ ### Example
1767+
1768+ #### Request
1769+
1770+ ``` json
1771+ {
1772+ "jsonrpc" : " 2.0"
1773+ "id" : 42 ,
1774+ "method" : " org.rdk.UserSettings.getContentPin"
1775+ }
1776+ ```
1777+
1778+ #### Response
1779+
1780+ ``` json
1781+ {
1782+ "jsonrpc" : " 2.0"
1783+ "id" : 42 ,
1784+ "result" : " 1234"
1785+ }
1786+ ```
1787+
16971788<a name =" Notifications " ></a >
16981789# Notifications
16991790
@@ -1722,6 +1813,7 @@ org.rdk.UserSettings interface events:
17221813| [ onVoiceGuidanceChanged] ( #onVoiceGuidanceChanged ) | Triggered after the voice guidance enabled settings changes |
17231814| [ onVoiceGuidanceRateChanged] ( #onVoiceGuidanceRateChanged ) | Triggered after the voice guidance rate changed |
17241815| [ onVoiceGuidanceHintsChanged] ( #onVoiceGuidanceHintsChanged ) | Triggered after the voice guidance hints changes |
1816+ | [ onContentPinChanged] ( #onContentPinChanged ) | Triggered after the ContentPin changes (see ` setContentPin ` ) |
17251817
17261818
17271819<a name =" onAudioDescriptionChanged " ></a >
@@ -2132,3 +2224,27 @@ Triggered after the voice guidance hints changes.(see `SetVoiceGuidanceHints`).
21322224}
21332225```
21342226
2227+ <a name =" onContentPinChanged " ></a >
2228+ ## * onContentPinChanged*
2229+
2230+ Triggered after the ContentPin changes (see ` setContentPin ` ).
2231+
2232+ ### Parameters
2233+
2234+ | Name | Type | Description |
2235+ | :-------- | :-------- | :-------- |
2236+ | params | object | |
2237+ | params.contentPin | string | contentPin |
2238+
2239+ ### Example
2240+
2241+ ``` json
2242+ {
2243+ "jsonrpc" : " 2.0"
2244+ "method" : " client.events.onContentPinChanged"
2245+ "params" : {
2246+ "contentPin" : " 1234"
2247+ }
2248+ }
2249+ ```
2250+
0 commit comments