chore: Publish pr-feature-high-contrast-ui

rdkcentral · Jan 8, 2025 · 38ff3a2 · 38ff3a2
1 parent 9f37e8f
commit 38ff3a2
Show file tree

Hide file tree

Showing 5 changed files with 257 additions and 5 deletions.
diff --git a/apis/pr-feature-high-contrast-ui/core/Accessibility/index.md b/apis/pr-feature-high-contrast-ui/core/Accessibility/index.md
@@ -29,6 +29,7 @@ Version Accessibility 1.5.0-feature-high-contrast-ui.0
 - [Events](#events)
   - [audioDescriptionSettingsChanged](#audiodescriptionsettingschanged)
   - [closedCaptionsSettingsChanged](#closedcaptionssettingschanged)
+  - [highContrastModeChanged](#highcontrastmodechanged)
   - [voiceGuidanceSettingsChanged](#voiceguidancesettingschanged)
 - [Types](#types)
   - [AudioDescriptionSettings](#audiodescriptionsettings-1)
@@ -494,7 +495,9 @@ Response:
 
 ### highContrastMode
 
-Get whether high-contrast UI mode is enabled on the device
+The user's preference for a high-contrast UI
+
+To get the value of `highContrastMode` call the method like this:
 
 ```typescript
 function highContrastMode(): Promise<boolean>
@@ -554,6 +557,68 @@ Response:
 
 ---
 
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function highContrastMode(callback: (value) => boolean): Promise<number>
+```
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+High-contrast mode is enabled
+
+JavaScript:
+
+```javascript
+import { Accessibility } from '@firebolt-js/sdk'
+
+let listenerId = await highContrastMode((value) => {
+  console.log(value)
+})
+console.log(listenerId)
+```
+
+Value of `highContrastMode`:
+
+```javascript
+true
+```
+
+<details markdown="1" >
+<summary>JSON-RPC:</summary>
+Request:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "Accessibility.onHighContrastModeChanged",
+  "params": {
+    "listen": true
+  }
+}
+```
+
+Response:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": true
+}
+```
+
+</details>
+
+---
+
 ### listen
 
 To listen to a specific event pass the event name as the first parameter:
@@ -886,6 +951,10 @@ See: [audioDescriptionSettings](#audiodescriptionsettings)
 
 See: [closedCaptionsSettings](#closedcaptionssettings)
 
+### highContrastModeChanged
+
+See: [highContrastMode](#highcontrastmode)
+
 ### voiceGuidanceSettingsChanged
 
 See: [voiceGuidanceSettings](#voiceguidancesettings)

diff --git a/apis/pr-feature-high-contrast-ui/index.md b/apis/pr-feature-high-contrast-ui/index.md
@@ -41,7 +41,7 @@ The schemas are used to generate SDK and Documentation artifacts.
 
 | Uses |
 | ---- |
-| [Accessibility.highContrastMode](./core/Accessibility/#highcontrastmode) |
+| [Accessibility.highContrastMode](./core/Accessibility/#highcontrastmode)<br/>[Accessibility.onHighContrastModeChanged](./core/Accessibility/#highcontrastmodechanged) |
 
 
 ### `xrn:firebolt:capability:accessibility:voiceguidance`

diff --git a/requirements/pr-feature-high-contrast-ui/specifications/firebolt-core-open-rpc.json b/requirements/pr-feature-high-contrast-ui/specifications/firebolt-core-open-rpc.json
@@ -133,9 +133,12 @@
 		},
 		{
 			"name": "Accessibility.highContrastMode",
-			"summary": "Get whether high-contrast UI mode is enabled on the device",
+			"summary": "The user's preference for a high-contrast UI",
 			"params": [],
 			"tags": [
+				{
+					"name": "property:readonly"
+				},
 				{
 					"name": "capabilities",
 					"x-uses": [
@@ -348,6 +351,64 @@
 				}
 			]
 		},
+		{
+			"name": "Accessibility.onHighContrastModeChanged",
+			"summary": "The user's preference for a high-contrast UI",
+			"params": [
+				{
+					"name": "listen",
+					"required": true,
+					"schema": {
+						"type": "boolean"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "subscriber",
+					"x-subscriber-for": "Accessibility.highContrastMode"
+				},
+				{
+					"name": "event",
+					"x-alternative": "highContrastMode"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:highcontrastmode"
+					]
+				}
+			],
+			"result": {
+				"name": "highContrastMode",
+				"summary": "Whether high-contrast mode is enabled",
+				"schema": {
+					"anyOf": [
+						{
+							"$ref": "#/x-schemas/Types/ListenResponse"
+						},
+						{
+							"type": "boolean"
+						}
+					]
+				}
+			},
+			"examples": [
+				{
+					"name": "High-contrast mode is enabled",
+					"params": [
+						{
+							"name": "listen",
+							"value": true
+						}
+					],
+					"result": {
+						"name": "Default Result",
+						"value": true
+					}
+				}
+			]
+		},
 		{
 			"name": "Accessibility.onVoiceGuidanceSettingsChanged",
 			"summary": "Get the user's preferred voice guidance settings",

diff --git a/requirements/pr-feature-high-contrast-ui/specifications/firebolt-open-rpc.json b/requirements/pr-feature-high-contrast-ui/specifications/firebolt-open-rpc.json
@@ -231,9 +231,12 @@
 		},
 		{
 			"name": "Accessibility.highContrastMode",
-			"summary": "Get whether high-contrast UI mode is enabled on the device",
+			"summary": "The user's preference for a high-contrast UI",
 			"params": [],
 			"tags": [
+				{
+					"name": "property:readonly"
+				},
 				{
 					"name": "capabilities",
 					"x-uses": [
@@ -446,6 +449,64 @@
 				}
 			]
 		},
+		{
+			"name": "Accessibility.onHighContrastModeChanged",
+			"summary": "The user's preference for a high-contrast UI",
+			"params": [
+				{
+					"name": "listen",
+					"required": true,
+					"schema": {
+						"type": "boolean"
+					}
+				}
+			],
+			"tags": [
+				{
+					"name": "subscriber",
+					"x-subscriber-for": "Accessibility.highContrastMode"
+				},
+				{
+					"name": "event",
+					"x-alternative": "highContrastMode"
+				},
+				{
+					"name": "capabilities",
+					"x-uses": [
+						"xrn:firebolt:capability:accessibility:highcontrastmode"
+					]
+				}
+			],
+			"result": {
+				"name": "highContrastMode",
+				"summary": "Whether high-contrast mode is enabled",
+				"schema": {
+					"anyOf": [
+						{
+							"$ref": "#/x-schemas/Types/ListenResponse"
+						},
+						{
+							"type": "boolean"
+						}
+					]
+				}
+			},
+			"examples": [
+				{
+					"name": "High-contrast mode is enabled",
+					"params": [
+						{
+							"name": "listen",
+							"value": true
+						}
+					],
+					"result": {
+						"name": "Default Result",
+						"value": true
+					}
+				}
+			]
+		},
 		{
 			"name": "Accessibility.onVoiceGuidanceSettingsChanged",
 			"summary": "Get the user's preferred voice guidance settings",

diff --git a/requirements/pr-feature-high-contrast-ui/specifications/firebolt-specification.json b/requirements/pr-feature-high-contrast-ui/specifications/firebolt-specification.json
@@ -1186,9 +1186,12 @@
 				},
 				{
 					"name": "Accessibility.highContrastMode",
-					"summary": "Get whether high-contrast UI mode is enabled on the device",
+					"summary": "The user's preference for a high-contrast UI",
 					"params": [],
 					"tags": [
+						{
+							"name": "property:readonly"
+						},
 						{
 							"name": "capabilities",
 							"x-uses": [
@@ -1401,6 +1404,64 @@
 						}
 					]
 				},
+				{
+					"name": "Accessibility.onHighContrastModeChanged",
+					"summary": "The user's preference for a high-contrast UI",
+					"params": [
+						{
+							"name": "listen",
+							"required": true,
+							"schema": {
+								"type": "boolean"
+							}
+						}
+					],
+					"tags": [
+						{
+							"name": "subscriber",
+							"x-subscriber-for": "Accessibility.highContrastMode"
+						},
+						{
+							"name": "event",
+							"x-alternative": "highContrastMode"
+						},
+						{
+							"name": "capabilities",
+							"x-uses": [
+								"xrn:firebolt:capability:accessibility:highcontrastmode"
+							]
+						}
+					],
+					"result": {
+						"name": "highContrastMode",
+						"summary": "Whether high-contrast mode is enabled",
+						"schema": {
+							"anyOf": [
+								{
+									"$ref": "#/x-schemas/Types/ListenResponse"
+								},
+								{
+									"type": "boolean"
+								}
+							]
+						}
+					},
+					"examples": [
+						{
+							"name": "High-contrast mode is enabled",
+							"params": [
+								{
+									"name": "listen",
+									"value": true
+								}
+							],
+							"result": {
+								"name": "Default Result",
+								"value": true
+							}
+						}
+					]
+				},
 				{
 					"name": "Accessibility.onVoiceGuidanceSettingsChanged",
 					"summary": "Get the user's preferred voice guidance settings",