chore: Publish pr-app-passthrough-additions

rdkcentral · Aug 12, 2024 · e4f4400 · e4f4400
1 parent c056194
commit e4f4400
Show file tree

Hide file tree

Showing 38 changed files with 215 additions and 77 deletions.
diff --git a/apis/pr-app-passthrough-additions/core/Accessibility/index.md b/apis/pr-app-passthrough-additions/core/Accessibility/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Accessibility 1.2.1-app-passthrough-additions.0
+Version Accessibility 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Account/index.md b/apis/pr-app-passthrough-additions/core/Account/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Account 1.2.1-app-passthrough-additions.0
+Version Account 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Advertising/index.md b/apis/pr-app-passthrough-additions/core/Advertising/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Advertising 1.2.1-app-passthrough-additions.0
+Version Advertising 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Authentication/index.md b/apis/pr-app-passthrough-additions/core/Authentication/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Authentication 1.2.1-app-passthrough-additions.0
+Version Authentication 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Capabilities/index.md b/apis/pr-app-passthrough-additions/core/Capabilities/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Capabilities 1.2.1-app-passthrough-additions.0
+Version Capabilities 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Device/index.md b/apis/pr-app-passthrough-additions/core/Device/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Device 1.2.1-app-passthrough-additions.0
+Version Device 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Discovery/index.md b/apis/pr-app-passthrough-additions/core/Discovery/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Discovery 1.2.1-app-passthrough-additions.0
+Version Discovery 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 
@@ -3650,20 +3650,20 @@ Suggest a call-to-action for this app on the platform home screen
 ```typescript
 function watchNext(
   title: LocalizedString,
-  identifiers: Entity,
+  identifiers: ContentIdentifiers,
   expires: string,
   images: object,
 ): Promise<boolean>
 ```
 
 Parameters:
 
-| Param         | Type                                                   | Required | Description                                                                            |
-| ------------- | ------------------------------------------------------ | -------- | -------------------------------------------------------------------------------------- |
-| `title`       | [`LocalizedString`](../Types/schemas/#LocalizedString) | true     | The title of this call to action                                                       |
-| `identifiers` | [`Entity`](../Entity/schemas/#Entity)                  | true     | A set of content identifiers for this call to action                                   |
-| `expires`     | `string`                                               | false    | When this call to action should no longer be presented to users <br/>format: date-time |
-| `images`      | `object`                                               | false    | A set of images for this call to action                                                |
+| Param         | Type                                                                 | Required | Description                                                                            |
+| ------------- | -------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------- |
+| `title`       | [`LocalizedString`](../Types/schemas/#LocalizedString)               | true     | The title of this call to action                                                       |
+| `identifiers` | [`ContentIdentifiers`](../Entertainment/schemas/#ContentIdentifiers) | true     | A set of content identifiers for this call to action                                   |
+| `expires`     | `string`                                                             | false    | When this call to action should no longer be presented to users <br/>format: date-time |
+| `images`      | `object`                                                             | false    | A set of images for this call to action                                                |
 
 Promise resolution:
 

diff --git a/apis/pr-app-passthrough-additions/core/Internal/index.md b/apis/pr-app-passthrough-additions/core/Internal/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Internal 1.2.1-app-passthrough-additions.0
+Version Internal 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Keyboard/index.md b/apis/pr-app-passthrough-additions/core/Keyboard/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Keyboard 1.2.1-app-passthrough-additions.0
+Version Keyboard 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Lifecycle/index.md b/apis/pr-app-passthrough-additions/core/Lifecycle/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Lifecycle 1.2.1-app-passthrough-additions.0
+Version Lifecycle 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Localization/index.md b/apis/pr-app-passthrough-additions/core/Localization/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Localization 1.2.1-app-passthrough-additions.0
+Version Localization 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Metrics/index.md b/apis/pr-app-passthrough-additions/core/Metrics/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Metrics 1.2.1-app-passthrough-additions.0
+Version Metrics 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 
@@ -19,6 +19,7 @@ Version Metrics 1.2.1-app-passthrough-additions.0
 - [Overview](#overview)
 - [Methods](#methods)
   - [action](#action)
+  - [appInfo](#appinfo)
   - [error](#error)
   - [mediaEnded](#mediaended)
   - [mediaLoadStart](#medialoadstart)
@@ -132,6 +133,76 @@ Response:
 
 ---
 
+### appInfo
+
+Inform the platform about an app's build info.
+
+```typescript
+function appInfo(build: string): Promise<null>
+```
+
+Parameters:
+
+| Param   | Type     | Required | Description                      |
+| ------- | -------- | -------- | -------------------------------- |
+| `build` | `string` | true     | The build / version of this app. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send appInfo metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/sdk'
+
+let result = await Metrics.appInfo('1.2.2')
+console.log(result)
+```
+
+Value of `result`:
+
+```javascript
+null
+```
+
+<details markdown="1" >
+<summary>JSON-RPC:</summary>
+Request:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "Metrics.appInfo",
+  "params": {
+    "build": "1.2.2"
+  }
+}
+```
+
+Response:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": null
+}
+```
+
+</details>
+
+---
+
 ### error
 
 Inform the platform of an error that has occured in your app.

diff --git a/apis/pr-app-passthrough-additions/core/Parameters/index.md b/apis/pr-app-passthrough-additions/core/Parameters/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Parameters 1.2.1-app-passthrough-additions.0
+Version Parameters 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/Profile/index.md b/apis/pr-app-passthrough-additions/core/Profile/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version Profile 1.2.1-app-passthrough-additions.0
+Version Profile 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/SecondScreen/index.md b/apis/pr-app-passthrough-additions/core/SecondScreen/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version SecondScreen 1.2.1-app-passthrough-additions.0
+Version SecondScreen 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/core/SecureStorage/index.md b/apis/pr-app-passthrough-additions/core/SecureStorage/index.md
@@ -10,7 +10,7 @@ sdk: core
 
 ---
 
-Version SecureStorage 1.2.1-app-passthrough-additions.0
+Version SecureStorage 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/discovery/Content/index.md b/apis/pr-app-passthrough-additions/discovery/Content/index.md
@@ -10,7 +10,7 @@ sdk: discovery
 
 ---
 
-Version Content 1.2.1-app-passthrough-additions.0
+Version Content 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/index.md b/apis/pr-app-passthrough-additions/index.md
@@ -449,7 +449,7 @@ The schemas are used to generate SDK and Documentation artifacts.
 
 | Uses |
 | ---- |
-| [Metrics.ready](./core/Metrics/#ready)<br/>[Metrics.signIn](./core/Metrics/#signin)<br/>[Metrics.signOut](./core/Metrics/#signout)<br/>[Metrics.startContent](./core/Metrics/#startcontent)<br/>[Metrics.stopContent](./core/Metrics/#stopcontent)<br/>[Metrics.page](./core/Metrics/#page)<br/>[Metrics.action](./core/Metrics/#action)<br/>[Metrics.error](./core/Metrics/#error) |
+| [Metrics.ready](./core/Metrics/#ready)<br/>[Metrics.signIn](./core/Metrics/#signin)<br/>[Metrics.signOut](./core/Metrics/#signout)<br/>[Metrics.startContent](./core/Metrics/#startcontent)<br/>[Metrics.stopContent](./core/Metrics/#stopcontent)<br/>[Metrics.page](./core/Metrics/#page)<br/>[Metrics.action](./core/Metrics/#action)<br/>[Metrics.error](./core/Metrics/#error)<br/>[Metrics.appInfo](./core/Metrics/#appinfo) |
 
 
 ### `xrn:firebolt:capability:metrics:media`

diff --git a/apis/pr-app-passthrough-additions/manage/Account/index.md b/apis/pr-app-passthrough-additions/manage/Account/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version Account 1.2.1-app-passthrough-additions.0
+Version Account 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md b/apis/pr-app-passthrough-additions/manage/AcknowledgeChallenge/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version AcknowledgeChallenge 1.2.1-app-passthrough-additions.0
+Version AcknowledgeChallenge 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 
@@ -348,12 +348,7 @@ Response:
 The provider interface for the `xrn:firebolt:capability:usergrant:acknowledgechallenge` capability.
 
 ```typescript
-interface ChallengeProvider {
-  challenge(
-    parameters: object,
-    session: FocusableProviderSession,
-  ): Promise<GrantResult>
-}
+
 ```
 
 Usage:
@@ -371,7 +366,9 @@ import { AcknowledgeChallenge } from '@firebolt-js/manage-sdk'
 
 class MyChallengeProvider {
   async challenge(parameters, session) {
-    return null
+    return {
+      granted: true,
+    }
   }
 }
 
@@ -440,7 +437,9 @@ Request:
   "method": "AcknowledgeChallenge.challengeResponse",
   "params": {
     "correlationId": undefined,
-    "result": null
+    "result": {
+      "granted": true
+    }
   }
 }
 ```

diff --git a/apis/pr-app-passthrough-additions/manage/Advertising/index.md b/apis/pr-app-passthrough-additions/manage/Advertising/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version Advertising 1.2.1-app-passthrough-additions.0
+Version Advertising 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md b/apis/pr-app-passthrough-additions/manage/AudioDescriptions/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version AudioDescriptions 1.2.1-app-passthrough-additions.0
+Version AudioDescriptions 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md b/apis/pr-app-passthrough-additions/manage/ClosedCaptions/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version ClosedCaptions 1.2.1-app-passthrough-additions.0
+Version ClosedCaptions 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/Device/index.md b/apis/pr-app-passthrough-additions/manage/Device/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version Device 1.2.1-app-passthrough-additions.0
+Version Device 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/Discovery/index.md b/apis/pr-app-passthrough-additions/manage/Discovery/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version Discovery 1.2.1-app-passthrough-additions.0
+Version Discovery 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents
 

diff --git a/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md b/apis/pr-app-passthrough-additions/manage/HDMIInput/index.md
@@ -10,7 +10,7 @@ sdk: manage
 
 ---
 
-Version HDMIInput 1.2.1-app-passthrough-additions.0
+Version HDMIInput 1.3.0-app-passthrough-additions.0
 
 ## Table of Contents