Skip to content

Commit a450f36

Browse files
DosakayaDosakaya
committed
RDK-57747: Updated documentation with the actual response(result is 'null')
1 parent e0c9a17 commit a450f36

File tree

4 files changed

+84
-105
lines changed

4 files changed

+84
-105
lines changed

‎docs/apis/USBDevicePlugin.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ No Events
265265

266266
| Name | Type | Description |
267267
| :-------- | :-------- | :-------- |
268-
| result | string | On success null will be returned |
268+
| result | null | On success null will be returned |
269269

270270
### Errors
271271

@@ -294,7 +294,7 @@ No Events
294294
{
295295
"jsonrpc": "2.0",
296296
"id": 42,
297-
"result": "null"
297+
"result": null
298298
}
299299
```
300300

@@ -318,7 +318,7 @@ No Events
318318

319319
| Name | Type | Description |
320320
| :-------- | :-------- | :-------- |
321-
| result | string | On success null will be returned |
321+
| result | null | On success null will be returned |
322322

323323
### Errors
324324

@@ -347,7 +347,7 @@ No Events
347347
{
348348
"jsonrpc": "2.0",
349349
"id": 42,
350-
"result": "null"
350+
"result": null
351351
}
352352
```
353353

‎docs/apis/UserSettingsPlugin.md‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="UserSettings_Plugin"></a>
33
# UserSettings Plugin
44

5-
**Version: [2.3.0](https://github.com/rdkcentral/rdkservices/blob/main/UserSettings/CHANGELOG.md)**
5+
**Version: [1.0.0]()**
66

77
A 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](userguide/aat.md)]
20+
[[Refer to this link](overview/aat.md)]
2121

2222
<a name="Description"></a>
2323
# Description
@@ -108,7 +108,7 @@ Setting Audio Description.
108108

109109
| Name | Type | Description |
110110
| :-------- | :-------- | :-------- |
111-
| result | string | On success null will be returned |
111+
| result | null | On success null will be returned |
112112

113113
### Example
114114

@@ -131,7 +131,7 @@ Setting Audio Description.
131131
{
132132
"jsonrpc": "2.0",
133133
"id": 42,
134-
"result": "null"
134+
"result": null
135135
}
136136
```
137137

@@ -156,7 +156,7 @@ Setting Preferred Audio Languages.
156156

157157
| Name | Type | Description |
158158
| :-------- | :-------- | :-------- |
159-
| result | string | On success null will be returned |
159+
| result | null | On success null will be returned |
160160

161161
### Example
162162

@@ -179,7 +179,7 @@ Setting Preferred Audio Languages.
179179
{
180180
"jsonrpc": "2.0",
181181
"id": 42,
182-
"result": "null"
182+
"result": null
183183
}
184184
```
185185

@@ -204,7 +204,7 @@ Setting Presentation Languages.
204204

205205
| Name | Type | Description |
206206
| :-------- | :-------- | :-------- |
207-
| result | string | On success null will be returned |
207+
| result | null | On success null will be returned |
208208

209209
### Example
210210

@@ -227,7 +227,7 @@ Setting Presentation Languages.
227227
{
228228
"jsonrpc": "2.0",
229229
"id": 42,
230-
"result": "null"
230+
"result": null
231231
}
232232
```
233233

@@ -252,7 +252,7 @@ Setting Captions.
252252

253253
| Name | Type | Description |
254254
| :-------- | :-------- | :-------- |
255-
| result | string | On success null will be returned |
255+
| result | null | On success null will be returned |
256256

257257
### Example
258258

@@ -275,7 +275,7 @@ Setting Captions.
275275
{
276276
"jsonrpc": "2.0",
277277
"id": 42,
278-
"result": "null"
278+
"result": null
279279
}
280280
```
281281

@@ -300,7 +300,7 @@ Setting PreferredCaption Languages.
300300

301301
| Name | Type | Description |
302302
| :-------- | :-------- | :-------- |
303-
| result | string | On success null will be returned |
303+
| result | null | On success null will be returned |
304304

305305
### Example
306306

@@ -323,7 +323,7 @@ Setting PreferredCaption Languages.
323323
{
324324
"jsonrpc": "2.0",
325325
"id": 42,
326-
"result": "null"
326+
"result": null
327327
}
328328
```
329329

@@ -348,7 +348,7 @@ Setting Preferred Closed Caption Service.
348348

349349
| Name | Type | Description |
350350
| :-------- | :-------- | :-------- |
351-
| result | string | On success null will be returned |
351+
| result | null | On success null will be returned |
352352

353353
### Example
354354

@@ -371,7 +371,7 @@ Setting Preferred Closed Caption Service.
371371
{
372372
"jsonrpc": "2.0",
373373
"id": 42,
374-
"result": "null"
374+
"result": null
375375
}
376376
```
377377

@@ -396,7 +396,7 @@ Setting PinControl.
396396

397397
| Name | Type | Description |
398398
| :-------- | :-------- | :-------- |
399-
| result | string | On success null will be returned |
399+
| result | null | On success null will be returned |
400400

401401
### Example
402402

@@ -419,7 +419,7 @@ Setting PinControl.
419419
{
420420
"jsonrpc": "2.0",
421421
"id": 42,
422-
"result": "null"
422+
"result": null
423423
}
424424
```
425425

@@ -444,7 +444,7 @@ Setting ViewingRestrictions.
444444

445445
| Name | Type | Description |
446446
| :-------- | :-------- | :-------- |
447-
| result | string | On success null will be returned |
447+
| result | null | On success null will be returned |
448448

449449
### Example
450450

@@ -467,7 +467,7 @@ Setting ViewingRestrictions.
467467
{
468468
"jsonrpc": "2.0",
469469
"id": 42,
470-
"result": "null"
470+
"result": null
471471
}
472472
```
473473

@@ -492,7 +492,7 @@ Setting viewingRestrictionsWindow.
492492

493493
| Name | Type | Description |
494494
| :-------- | :-------- | :-------- |
495-
| result | string | On success null will be returned |
495+
| result | null | On success null will be returned |
496496

497497
### Example
498498

@@ -515,7 +515,7 @@ Setting viewingRestrictionsWindow.
515515
{
516516
"jsonrpc": "2.0",
517517
"id": 42,
518-
"result": "null"
518+
"result": null
519519
}
520520
```
521521

@@ -540,7 +540,7 @@ Setting LiveWatershed.
540540

541541
| Name | Type | Description |
542542
| :-------- | :-------- | :-------- |
543-
| result | string | On success null will be returned |
543+
| result | null | On success null will be returned |
544544

545545
### Example
546546

@@ -563,7 +563,7 @@ Setting LiveWatershed.
563563
{
564564
"jsonrpc": "2.0",
565565
"id": 42,
566-
"result": "null"
566+
"result": null
567567
}
568568
```
569569

@@ -588,7 +588,7 @@ Setting PlaybackWatershed.
588588

589589
| Name | Type | Description |
590590
| :-------- | :-------- | :-------- |
591-
| result | string | On success null will be returned |
591+
| result | null | On success null will be returned |
592592

593593
### Example
594594

@@ -611,7 +611,7 @@ Setting PlaybackWatershed.
611611
{
612612
"jsonrpc": "2.0",
613613
"id": 42,
614-
"result": "null"
614+
"result": null
615615
}
616616
```
617617

@@ -636,7 +636,7 @@ Setting BlockNotRatedContent.
636636

637637
| Name | Type | Description |
638638
| :-------- | :-------- | :-------- |
639-
| result | string | On success null will be returned |
639+
| result | null | On success null will be returned |
640640

641641
### Example
642642

@@ -659,7 +659,7 @@ Setting BlockNotRatedContent.
659659
{
660660
"jsonrpc": "2.0",
661661
"id": 42,
662-
"result": "null"
662+
"result": null
663663
}
664664
```
665665

@@ -684,7 +684,7 @@ Setting setPinOnPurchase.
684684

685685
| Name | Type | Description |
686686
| :-------- | :-------- | :-------- |
687-
| result | string | On success null will be returned |
687+
| result | null | On success null will be returned |
688688

689689
### Example
690690

@@ -707,7 +707,7 @@ Setting setPinOnPurchase.
707707
{
708708
"jsonrpc": "2.0",
709709
"id": 42,
710-
"result": "null"
710+
"result": null
711711
}
712712
```
713713

@@ -732,7 +732,7 @@ Sets highContrast. Whether the app should display with high contrast or not.
732732

733733
| Name | Type | Description |
734734
| :-------- | :-------- | :-------- |
735-
| result | string | On success null will be returned |
735+
| result | null | On success null will be returned |
736736

737737
### Example
738738

@@ -755,7 +755,7 @@ Sets highContrast. Whether the app should display with high contrast or not.
755755
{
756756
"jsonrpc": "2.0",
757757
"id": 42,
758-
"result": "null"
758+
"result": null
759759
}
760760
```
761761

@@ -780,7 +780,7 @@ Sets voiceGuidance. Whether Voice Guidance is enabled or not.
780780

781781
| Name | Type | Description |
782782
| :-------- | :-------- | :-------- |
783-
| result | string | On success null will be returned |
783+
| result | null | On success null will be returned |
784784

785785
### Example
786786

@@ -803,7 +803,7 @@ Sets voiceGuidance. Whether Voice Guidance is enabled or not.
803803
{
804804
"jsonrpc": "2.0",
805805
"id": 42,
806-
"result": "null"
806+
"result": null
807807
}
808808
```
809809

@@ -828,7 +828,7 @@ Sets voiceGuidanceRate. Setting voice guidance rate value. from 0.1 to 10 inclus
828828

829829
| Name | Type | Description |
830830
| :-------- | :-------- | :-------- |
831-
| result | string | On success null will be returned |
831+
| result | null | On success null will be returned |
832832

833833
### Example
834834

@@ -851,7 +851,7 @@ Sets voiceGuidanceRate. Setting voice guidance rate value. from 0.1 to 10 inclus
851851
{
852852
"jsonrpc": "2.0",
853853
"id": 42,
854-
"result": "null"
854+
"result": null
855855
}
856856
```
857857

@@ -876,7 +876,7 @@ Sets voiceGuidanceHints ON/OFF. Whether Voice Guidance hints setting is switched
876876

877877
| Name | Type | Description |
878878
| :-------- | :-------- | :-------- |
879-
| result | string | On success null will be returned |
879+
| result | null | On success null will be returned |
880880

881881
### Example
882882

@@ -899,7 +899,7 @@ Sets voiceGuidanceHints ON/OFF. Whether Voice Guidance hints setting is switched
899899
{
900900
"jsonrpc": "2.0",
901901
"id": 42,
902-
"result": "null"
902+
"result": null
903903
}
904904
```
905905

@@ -924,7 +924,7 @@ Setting ContentPin.
924924

925925
| Name | Type | Description |
926926
| :-------- | :-------- | :-------- |
927-
| result | string | On success null will be returned |
927+
| result | null | On success null will be returned |
928928

929929
### Example
930930

@@ -947,7 +947,7 @@ Setting ContentPin.
947947
{
948948
"jsonrpc": "2.0",
949949
"id": 42,
950-
"result": "null"
950+
"result": null
951951
}
952952
```
953953

0 commit comments

Comments
 (0)