chore: Publish pr-feature-user-interest

rdkcentral · May 28, 2024 · ef92a50 · ef92a50
1 parent 9ea7c1a
commit ef92a50
Show file tree

Hide file tree

Showing 67 changed files with 2,923 additions and 3,877 deletions.
diff --git a/apis/pr-feature-user-interest/core/Accessibility/index.md b/apis/pr-feature-user-interest/core/Accessibility/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Accessibility 1.2.0-feature-user-interest.7
+Version Accessibility 1.2.0-feature-user-interest.8
 
 ## Table of Contents
 
@@ -55,28 +55,21 @@ Get the user's preferred audio description settings
 To get the value of `audioDescriptionSettings` call the method like this:
 
 ```typescript
-${method.signature}
+function audioDescriptionSettings(): Promise<AudioDescriptionSettings>
 ```
 
 Promise resolution:
 
-````typescript
-```typescript
-
-````
-
-````
+[AudioDescriptionSettings](#audiodescriptionsettings-1)
 
 Capabilities:
 
-| Role                  | Capability                 |
-| --------------------- | -------------------------- |
+| Role | Capability                                              |
+| ---- | ------------------------------------------------------- |
 | uses | xrn:firebolt:capability:accessibility:audiodescriptions |
 
-
 #### Examples
 
-
 Getting the audio description settings
 
 JavaScript:
@@ -86,7 +79,7 @@ import { Accessibility } from '@firebolt-js/sdk'
 
 let settings = await Accessibility.audioDescriptionSettings()
 console.log(settings)
-````
+```
 
 Value of `settings`:
 
@@ -128,7 +121,9 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function audioDescriptionSettings(callback: (value) => ): Promise<number>
+function audioDescriptionSettings(
+  callback: (value) => AudioDescriptionSettings,
+): Promise<number>
 ```
 
 Promise resolution:
@@ -196,28 +191,21 @@ Response:
 Get the user's preferred closed-captions settings
 
 ```typescript
-${method.signature}
+function closedCaptions(): Promise<ClosedCaptionsSettings>
 ```
 
 Promise resolution:
 
-````typescript
-```typescript
-
-````
-
-````
+[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings)
 
 Capabilities:
 
-| Role                  | Capability                 |
-| --------------------- | -------------------------- |
+| Role | Capability                                           |
+| ---- | ---------------------------------------------------- |
 | uses | xrn:firebolt:capability:accessibility:closedcaptions |
 
-
 #### Examples
 
-
 Getting the closed captions settings
 
 JavaScript:
@@ -227,7 +215,7 @@ import { Accessibility } from '@firebolt-js/sdk'
 
 let closedCaptionsSettings = await Accessibility.closedCaptions()
 console.log(closedCaptionsSettings)
-````
+```
 
 Value of `closedCaptionsSettings`:
 
@@ -306,28 +294,21 @@ Get the user's preferred closed-captions settings
 To get the value of `closedCaptionsSettings` call the method like this:
 
 ```typescript
-${method.signature}
+function closedCaptionsSettings(): Promise<ClosedCaptionsSettings>
 ```
 
 Promise resolution:
 
-````typescript
-```typescript
-
-````
-
-````
+[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings)
 
 Capabilities:
 
-| Role                  | Capability                 |
-| --------------------- | -------------------------- |
+| Role | Capability                                           |
+| ---- | ---------------------------------------------------- |
 | uses | xrn:firebolt:capability:accessibility:closedcaptions |
 
-
 #### Examples
 
-
 Getting the closed captions settings
 
 JavaScript:
@@ -337,7 +318,7 @@ import { Accessibility } from '@firebolt-js/sdk'
 
 let closedCaptionsSettings = await Accessibility.closedCaptionsSettings()
 console.log(closedCaptionsSettings)
-````
+```
 
 Value of `closedCaptionsSettings`:
 
@@ -412,7 +393,9 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function closedCaptionsSettings(callback: (value) => ): Promise<number>
+function closedCaptionsSettings(
+  callback: (value) => ClosedCaptionsSettings,
+): Promise<number>
 ```
 
 Promise resolution:
@@ -623,28 +606,21 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio
 Get the user's preferred voice guidance settings
 
 ```typescript
-${method.signature}
+function voiceGuidance(): Promise<VoiceGuidanceSettings>
 ```
 
 Promise resolution:
 
-````typescript
-```typescript
-
-````
-
-````
+[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings)
 
 Capabilities:
 
-| Role                  | Capability                 |
-| --------------------- | -------------------------- |
+| Role | Capability                                          |
+| ---- | --------------------------------------------------- |
 | uses | xrn:firebolt:capability:accessibility:voiceguidance |
 
-
 #### Examples
 
-
 Getting the voice guidance settings
 
 JavaScript:
@@ -654,7 +630,7 @@ import { Accessibility } from '@firebolt-js/sdk'
 
 let settings = await Accessibility.voiceGuidance()
 console.log(settings)
-````
+```
 
 Value of `settings`:
 
@@ -702,28 +678,21 @@ Get the user's preferred voice guidance settings
 To get the value of `voiceGuidanceSettings` call the method like this:
 
 ```typescript
-${method.signature}
+function voiceGuidanceSettings(): Promise<VoiceGuidanceSettings>
 ```
 
 Promise resolution:
 
-````typescript
-```typescript
-
-````
-
-````
+[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings)
 
 Capabilities:
 
-| Role                  | Capability                 |
-| --------------------- | -------------------------- |
+| Role | Capability                                          |
+| ---- | --------------------------------------------------- |
 | uses | xrn:firebolt:capability:accessibility:voiceguidance |
 
-
 #### Examples
 
-
 Getting the voice guidance settings
 
 JavaScript:
@@ -733,7 +702,7 @@ import { Accessibility } from '@firebolt-js/sdk'
 
 let settings = await Accessibility.voiceGuidanceSettings()
 console.log(settings)
-````
+```
 
 Value of `settings`:
 
@@ -777,7 +746,9 @@ Response:
 To subscribe to notifications when the value changes, call the method like this:
 
 ```typescript
-function voiceGuidanceSettings(callback: (value) => ): Promise<number>
+function voiceGuidanceSettings(
+  callback: (value) => VoiceGuidanceSettings,
+): Promise<number>
 ```
 
 Promise resolution:
@@ -860,14 +831,10 @@ See: [voiceGuidanceSettings](#voiceguidancesettings)
 
 ### AudioDescriptionSettings
 
-````typescript
 ```typescript
-
-````
-
+type AudioDescriptionSettings = {
+  enabled: boolean // Whether or not audio descriptions should be enabled by default
+}
 ```
 
-
-
 ---
-```
diff --git a/apis/pr-feature-user-interest/core/Accessibility/schemas/index.md b/apis/pr-feature-user-interest/core/Accessibility/schemas/index.md
@@ -53,26 +53,24 @@ undefined
 
 ### VoiceGuidanceSettings
 
-````typescript
 ```typescript
-
-````
-
-````
+type VoiceGuidanceSettings = {
+  enabled: boolean // Whether or not voice guidance should be enabled by default
+  speed: VoiceSpeed // The speed at which voice guidance speech will be read back to the user
+}
+```
 
 See also:
 
-
+[VoiceSpeed](#voicespeed)
 
 ---
 
 ### FontSize
 
-
-
 ```typescript
 
-````
+```
 
 ---
 
@@ -120,31 +118,37 @@ See also:
 
 The default styles to use when displaying closed-captions
 
-````typescript
 ```typescript
-
-````
-
-````
-
-
+type ClosedCaptionsStyles = {
+  fontFamily?: string
+  fontSize?: number
+  fontColor?: string
+  fontEdge?: string
+  fontEdgeColor?: string
+  fontOpacity?: number
+  backgroundColor?: string
+  backgroundOpacity?: number
+  textAlign?: string
+  textAlignVertical?: string
+  windowColor?: string
+  windowOpacity?: number
+}
+```
 
 ---
 
 ### ClosedCaptionsSettings
 
-
-
-```typescript
 ```typescript
-
-````
-
+type ClosedCaptionsSettings = {
+  enabled: boolean // Whether or not closed-captions should be enabled by default
+  styles: ClosedCaptionsStyles // The default styles to use when displaying closed-captions
+  preferredLanguages?: string[]
+}
 ```
 
 See also:
 
-
+[ClosedCaptionsStyles](#closedcaptionsstyles)
 
 ---
-```
diff --git a/apis/pr-feature-user-interest/core/Account/index.md b/apis/pr-feature-user-interest/core/Account/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Account 1.2.0-feature-user-interest.7
+Version Account 1.2.0-feature-user-interest.8
 
 ## Table of Contents
 
@@ -43,15 +43,11 @@ Get the platform back-office account identifier
 To get the value of `id` call the method like this:
 
 ```typescript
-${method.signature}
+function id(): Promise<string>
 ```
 
 Promise resolution:
 
-```typescript
-string
-```
-
 Capabilities:
 
 | Role | Capability                         |
@@ -111,15 +107,11 @@ Gets a unique id for the current app & account
 To get the value of `uid` call the method like this:
 
 ```typescript
-${method.signature}
+function uid(): Promise<string>
 ```
 
 Promise resolution:
 
-```typescript
-string
-```
-
 Capabilities:
 
 | Role | Capability                          |