chore: Publish pr-feature-media-info

rdkcentral · Oct 1, 2024 · 6b4382d · 6b4382d
1 parent 0a4d17c
commit 6b4382d
Show file tree

Hide file tree

Showing 30 changed files with 31,671 additions and 3,713 deletions.
diff --git a/apis/pr-feature-media-info/core/Accessibility/schemas/index.md b/apis/pr-feature-media-info/core/Accessibility/schemas/index.md
@@ -56,7 +56,7 @@ undefined
 ```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
+  speed?: VoiceSpeed // The speed at which voice guidance speech will be read back to the user
 }
 ```
 
@@ -142,7 +142,7 @@ type ClosedCaptionsStyles = {
 ```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
+  styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions
   preferredLanguages?: string[]
 }
 ```

diff --git a/apis/pr-feature-media-info/core/Advertising/index.md b/apis/pr-feature-media-info/core/Advertising/index.md
@@ -31,6 +31,7 @@ Version Advertising 1.2.0-feature-media-info.5
   - [AdConfigurationOptions](#adconfigurationoptions)
   - [AdPolicy](#adpolicy)
   - [AdvertisingIdOptions](#advertisingidoptions)
+  - [AdvertisingIdResult](#advertisingidresult)
 
 ## Usage
 
@@ -48,10 +49,12 @@ A module for platform provided advertising settings and functionality.
 
 ### advertisingId
 
-Get the advertising ID
+Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings.
 
 ```typescript
-function advertisingId(options: AdvertisingIdOptions): Promise<object>
+function advertisingId(
+  options: AdvertisingIdOptions,
+): Promise<AdvertisingIdResult>
 ```
 
 Parameters:
@@ -62,6 +65,8 @@ Parameters:
 
 Promise resolution:
 
+[AdvertisingIdResult](#advertisingidresult)
+
 Capabilities:
 
 | Role | Capability                                     |
@@ -86,7 +91,7 @@ Value of `advertisingId`:
 ```javascript
 {
 	"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-	"ifa_type": "idfa",
+	"ifa_type": "sspid",
 	"lmt": "0"
 }
 ```
@@ -112,7 +117,7 @@ Response:
   "id": 1,
   "result": {
     "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-    "ifa_type": "idfa",
+    "ifa_type": "sspid",
     "lmt": "0"
   }
 }
@@ -138,7 +143,7 @@ Value of `advertisingId`:
 ```javascript
 {
 	"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-	"ifa_type": "idfa",
+	"ifa_type": "sspid",
 	"lmt": "0"
 }
 ```
@@ -171,7 +176,7 @@ Response:
   "id": 1,
   "result": {
     "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-    "ifa_type": "idfa",
+    "ifa_type": "sspid",
     "lmt": "0"
   }
 }
@@ -197,7 +202,7 @@ Value of `advertisingId`:
 ```javascript
 {
 	"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
-	"ifa_type": "idfa",
+	"ifa_type": "sspid",
 	"lmt": "0"
 }
 ```
@@ -272,7 +277,7 @@ console.log(appBundleId)
 Value of `appBundleId`:
 
 ```javascript
-'operator.app'
+'app.operator'
 ```
 
 <details markdown="1" >
@@ -294,7 +299,7 @@ Response:
 {
   "jsonrpc": "2.0",
   "id": 1,
-  "result": "operator.app"
+  "result": "app.operator"
 }
 ```
 
@@ -599,9 +604,9 @@ Promise resolution:
 
 Capabilities:
 
-| Role | Capability                                                                                        |
-| ---- | ------------------------------------------------------------------------------------------------- |
-| uses | xrn:firebolt:capability:privacy:advertising<br/>xrn:firebolt:capability:advertising:configuration |
+| Role | Capability                                 |
+| ---- | ------------------------------------------ |
+| uses | xrn:firebolt:capability:advertising:policy |
 
 #### Examples
 
@@ -769,3 +774,15 @@ type AdvertisingIdOptions = {
 ```
 
 ---
+
+### AdvertisingIdResult
+
+```typescript
+type AdvertisingIdResult = {
+  ifa: string // UUID conforming to IAB standard
+  ifa_type: string // source of the IFA as defined by IAB
+  lmt: '0' | '1' // boolean that if set to 1, user has requested ad tracking and measurement is disabled
+}
+```
+
+---
diff --git a/apis/pr-feature-media-info/core/Authentication/index.md b/apis/pr-feature-media-info/core/Authentication/index.md
@@ -24,6 +24,7 @@ Version Authentication 1.2.0-feature-media-info.5
   - [token](#token)
 - [Types](#types)
   - [TokenType](#tokentype)
+  - [AuthenticationTokenResult](#authenticationtokenresult)
 
 ## Usage
 
@@ -230,7 +231,10 @@ Response:
 Get a specific `type` of authentication token
 
 ```typescript
-function token(type: TokenType, options: object): Promise<object>
+function token(
+  type: TokenType,
+  options: object,
+): Promise<AuthenticationTokenResult>
 ```
 
 Parameters:
@@ -242,6 +246,8 @@ Parameters:
 
 Promise resolution:
 
+[AuthenticationTokenResult](#authenticationtokenresult)
+
 Capabilities:
 
 | Role | Capability                             |
@@ -429,3 +435,15 @@ TokenType: {
 ```
 
 ---
+
+### AuthenticationTokenResult
+
+```typescript
+type AuthenticationTokenResult = {
+  value: string
+  expires?: string
+  type?: string
+}
+```
+
+---