From 2be38ec0f9c8bdd616918166d81905cf1fc538ce Mon Sep 17 00:00:00 2001 From: Your Name Date: Wed, 27 Mar 2024 13:38:42 +0000 Subject: [PATCH] chore: Publish next --- apis/next/core/Accessibility/index.md | 109 ++- apis/next/core/Accessibility/schemas/index.md | 68 +- apis/next/core/Account/index.md | 9 +- apis/next/core/Advertising/index.md | 91 ++- apis/next/core/Advertising/schemas/index.md | 15 +- apis/next/core/Authentication/index.md | 34 +- apis/next/core/Capabilities/index.md | 186 +++-- apis/next/core/Capabilities/schemas/index.md | 80 +- apis/next/core/Device/index.md | 202 +++-- apis/next/core/Discovery/index.md | 729 ++++++++++-------- apis/next/core/Discovery/schemas/index.md | 27 +- apis/next/core/Entertainment/schemas/index.md | 166 ++-- apis/next/core/Intents/schemas/index.md | 398 ++++------ apis/next/core/Internal/index.md | 17 +- apis/next/core/Keyboard/index.md | 27 +- apis/next/core/Lifecycle/index.md | 137 ++-- apis/next/core/Lifecycle/schemas/index.md | 34 +- apis/next/core/Localization/index.md | 66 +- apis/next/core/Localization/schemas/index.md | 12 +- apis/next/core/Metrics/index.md | 115 ++- apis/next/core/Parameters/index.md | 38 +- apis/next/core/Profile/index.md | 28 +- apis/next/core/SecondScreen/index.md | 64 +- apis/next/core/SecondScreen/schemas/index.md | 12 +- apis/next/core/SecureStorage/index.md | 72 +- apis/next/core/Types/schemas/index.md | 56 +- .../manage/Accessibility/schemas/index.md | 68 +- apis/next/manage/Account/index.md | 16 +- .../next/manage/AcknowledgeChallenge/index.md | 145 ++-- apis/next/manage/Advertising/index.md | 34 +- apis/next/manage/Advertising/schemas/index.md | 15 +- apis/next/manage/AudioDescriptions/index.md | 12 +- .../next/manage/Capabilities/schemas/index.md | 80 +- apis/next/manage/ClosedCaptions/index.md | 254 +++--- apis/next/manage/Device/index.md | 20 +- apis/next/manage/Discovery/index.md | 9 +- apis/next/manage/Discovery/schemas/index.md | 27 +- .../manage/Entertainment/schemas/index.md | 166 ++-- apis/next/manage/HDMIInput/index.md | 306 +++++--- apis/next/manage/Intents/schemas/index.md | 398 ++++------ apis/next/manage/Keyboard/index.md | 313 +++----- apis/next/manage/Lifecycle/schemas/index.md | 34 +- apis/next/manage/Localization/index.md | 125 +-- .../next/manage/Localization/schemas/index.md | 12 +- apis/next/manage/Metrics/index.md | 32 +- apis/next/manage/PinChallenge/index.md | 166 ++-- apis/next/manage/Privacy/index.md | 124 +-- .../next/manage/SecondScreen/schemas/index.md | 12 +- apis/next/manage/SecureStorage/index.md | 71 +- apis/next/manage/Types/schemas/index.md | 56 +- apis/next/manage/UserGrants/index.md | 167 ++-- apis/next/manage/VoiceGuidance/index.md | 31 +- apis/next/manage/Wifi/index.md | 167 ++-- .../specifications/firebolt-open-rpc.json | 11 +- .../firebolt-specification.json | 11 +- 55 files changed, 2916 insertions(+), 2758 deletions(-) diff --git a/apis/next/core/Accessibility/index.md b/apis/next/core/Accessibility/index.md index bb3f8763b..b72d5b571 100644 --- a/apis/next/core/Accessibility/index.md +++ b/apis/next/core/Accessibility/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Accessibility 1.1.1-next.2 +Version Accessibility 1.2.0-next.1 ## Table of Contents @@ -55,21 +55,28 @@ Get the user's preferred audio description settings To get the value of `audioDescriptionSettings` call the method like this: ```typescript -function audioDescriptionSettings(): Promise +${method.signature} ``` Promise resolution: -[AudioDescriptionSettings](#audiodescriptionsettings-1) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:accessibility:audiodescriptions | + #### Examples + Getting the audio description settings JavaScript: @@ -79,7 +86,7 @@ import { Accessibility } from '@firebolt-js/sdk' let settings = await Accessibility.audioDescriptionSettings() console.log(settings) -``` +```` Value of `settings`: @@ -121,9 +128,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function audioDescriptionSettings( - callback: (value) => AudioDescriptionSettings, -): Promise +function audioDescriptionSettings(callback: (value) => ): Promise ``` Promise resolution: @@ -191,21 +196,28 @@ Response: Get the user's preferred closed-captions settings ```typescript -function closedCaptions(): Promise +${method.signature} ``` Promise resolution: -[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ---------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:accessibility:closedcaptions | + #### Examples + Getting the closed captions settings JavaScript: @@ -215,7 +227,7 @@ import { Accessibility } from '@firebolt-js/sdk' let closedCaptionsSettings = await Accessibility.closedCaptions() console.log(closedCaptionsSettings) -``` +```` Value of `closedCaptionsSettings`: @@ -294,21 +306,28 @@ Get the user's preferred closed-captions settings To get the value of `closedCaptionsSettings` call the method like this: ```typescript -function closedCaptionsSettings(): Promise +${method.signature} ``` Promise resolution: -[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ---------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:accessibility:closedcaptions | + #### Examples + Getting the closed captions settings JavaScript: @@ -318,7 +337,7 @@ import { Accessibility } from '@firebolt-js/sdk' let closedCaptionsSettings = await Accessibility.closedCaptionsSettings() console.log(closedCaptionsSettings) -``` +```` Value of `closedCaptionsSettings`: @@ -393,9 +412,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function closedCaptionsSettings( - callback: (value) => ClosedCaptionsSettings, -): Promise +function closedCaptionsSettings(callback: (value) => ): Promise ``` Promise resolution: @@ -606,21 +623,28 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Get the user's preferred voice guidance settings ```typescript -function voiceGuidance(): Promise +${method.signature} ``` Promise resolution: -[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:accessibility:voiceguidance | + #### Examples + Getting the voice guidance settings JavaScript: @@ -630,7 +654,7 @@ import { Accessibility } from '@firebolt-js/sdk' let settings = await Accessibility.voiceGuidance() console.log(settings) -``` +```` Value of `settings`: @@ -678,21 +702,28 @@ Get the user's preferred voice guidance settings To get the value of `voiceGuidanceSettings` call the method like this: ```typescript -function voiceGuidanceSettings(): Promise +${method.signature} ``` Promise resolution: -[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:accessibility:voiceguidance | + #### Examples + Getting the voice guidance settings JavaScript: @@ -702,7 +733,7 @@ import { Accessibility } from '@firebolt-js/sdk' let settings = await Accessibility.voiceGuidanceSettings() console.log(settings) -``` +```` Value of `settings`: @@ -746,9 +777,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function voiceGuidanceSettings( - callback: (value) => VoiceGuidanceSettings, -): Promise +function voiceGuidanceSettings(callback: (value) => ): Promise ``` Promise resolution: @@ -831,10 +860,14 @@ See: [voiceGuidanceSettings](#voiceguidancesettings) ### AudioDescriptionSettings +````typescript ```typescript -type AudioDescriptionSettings = { - enabled: boolean // Whether or not audio descriptions should be enabled by default -} + +```` + ``` + + --- +``` diff --git a/apis/next/core/Accessibility/schemas/index.md b/apis/next/core/Accessibility/schemas/index.md index b2c82c25e..74e52c6f2 100644 --- a/apis/next/core/Accessibility/schemas/index.md +++ b/apis/next/core/Accessibility/schemas/index.md @@ -38,7 +38,7 @@ undefined ### FontFamily ```typescript -type FontFamily = string + ``` --- @@ -46,38 +46,40 @@ type FontFamily = string ### VoiceSpeed ```typescript -type VoiceSpeed = number + ``` --- ### VoiceGuidanceSettings +````typescript ```typescript -type VoiceGuidanceSettings = { - enabled: boolean // Whether or not voice guidance should be enabled by default - speed: VoiceSpeed -} -``` + +```` + +```` See also: -number + --- ### FontSize + + ```typescript -type FontSize = number -``` + +```` --- ### Color ```typescript -type Color = string + ``` --- @@ -85,7 +87,7 @@ type Color = string ### FontEdge ```typescript -type FontEdge = string + ``` --- @@ -93,7 +95,7 @@ type FontEdge = string ### Opacity ```typescript -type Opacity = number + ``` --- @@ -101,7 +103,7 @@ type Opacity = number ### HorizontalAlignment ```typescript -type HorizontalAlignment = string + ``` --- @@ -109,7 +111,7 @@ type HorizontalAlignment = string ### VerticalAlignment ```typescript -type VerticalAlignment = string + ``` --- @@ -118,37 +120,31 @@ type VerticalAlignment = string 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/next/core/Account/index.md b/apis/next/core/Account/index.md index 77607762c..be1b8363c 100644 --- a/apis/next/core/Account/index.md +++ b/apis/next/core/Account/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Account 1.1.1-next.2 +Version Account 1.2.0-next.1 ## Table of Contents @@ -20,6 +20,7 @@ Version Account 1.1.1-next.2 - [Methods](#methods) - [id](#id) - [uid](#uid) +- [Types](#types) ## Usage @@ -42,7 +43,7 @@ Get the platform back-office account identifier To get the value of `id` call the method like this: ```typescript -function id(): Promise +${method.signature} ``` Promise resolution: @@ -110,7 +111,7 @@ Gets a unique id for the current app & account To get the value of `uid` call the method like this: ```typescript -function uid(): Promise +${method.signature} ``` Promise resolution: @@ -170,3 +171,5 @@ Response: --- + +## Types diff --git a/apis/next/core/Advertising/index.md b/apis/next/core/Advertising/index.md index 032ca6449..6e4cd784b 100644 --- a/apis/next/core/Advertising/index.md +++ b/apis/next/core/Advertising/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Advertising 1.1.1-next.2 +Version Advertising 1.2.0-next.1 ## Table of Contents @@ -51,14 +51,14 @@ A module for platform provided advertising settings and functionality. Get the advertising ID ```typescript -function advertisingId(options?: AdvertisingIdOptions): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | ----------------------------------------------- | -------- | --------------------- | -| `options` | [`AdvertisingIdOptions`](#advertisingidoptions) | false | AdvertisingId options | +| Param | Type | Required | Description | +| --------- | ---- | -------- | --------------------- | +| `options` | `` | false | AdvertisingId options | Promise resolution: @@ -251,7 +251,7 @@ Response: Get the App's Bundle ID ```typescript -function appBundleId(): Promise +${method.signature} ``` Promise resolution: @@ -317,19 +317,22 @@ Response: Build configuration object for Ad Framework initialization ```typescript -function config(options: AdConfigurationOptions): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | --------------------------------------------------- | -------- | --------------------- | -| `options` | [`AdConfigurationOptions`](#adconfigurationoptions) | true | Configuration options | +| Param | Type | Required | Description | +| --------- | ---- | -------- | --------------------- | +| `options` | `` | true | Configuration options | Promise resolution: ```typescript -object +| Property | Type | Description | +|----------|------|-------------| +| `${property}` | ${type} | An opaque object represneting the AdConfiguration | + ``` Capabilities: @@ -429,13 +432,16 @@ Response: Get the device advertising device attributes ```typescript -function deviceAttributes(): Promise +${method.signature} ``` Promise resolution: ```typescript -object +| Property | Type | Description | +|----------|------|-------------| +| `${property}` | ${type} | | + ``` Capabilities: @@ -608,21 +614,28 @@ Get the advertising privacy and playback policy To get the value of `policy` call the method like this: ```typescript -function policy(): Promise +${method.signature} ``` Promise resolution: -[AdPolicy](#adpolicy) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------------------------------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:privacy:advertising
xrn:firebolt:capability:advertising:configuration | + #### Examples + Getting the advertising policy settings JavaScript: @@ -632,7 +645,7 @@ import { Advertising } from '@firebolt-js/sdk' let adPolicy = await Advertising.policy() console.log(adPolicy) -``` +```` Value of `adPolicy`: @@ -676,7 +689,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function policy(callback: (value) => AdPolicy): Promise +function policy(callback: (value) => ): Promise ``` Promise resolution: @@ -751,13 +764,14 @@ See: [policy](#policy) ### AdConfigurationOptions +````typescript ```typescript -type AdConfigurationOptions = { - coppa?: boolean // Whether or not the app requires US COPPA compliance. - environment?: 'prod' | 'test' // Whether the app is running in a production or test mode. - authenticationEntity?: string // The authentication provider, when it is separate entity than the app provider, e.g. an MVPD. -} -``` + +```` + +```` + + --- @@ -766,27 +780,30 @@ type AdConfigurationOptions = { Describes various ad playback enforcement rules that the app should follow. ```typescript -type AdPolicy = { - skipRestriction?: SkipRestriction // The advertisement skip restriction. - limitAdTracking?: boolean -} -``` +```typescript + +```` + +```` See also: -'none' | 'adsUnwatched' | 'adsAll' | 'all' + --- ### AdvertisingIdOptions + + ```typescript -type AdvertisingIdOptions = { - scope?: { - type: 'browse' | 'content' // The scope type, which will determine where to show advertisement - id: string // A value that identifies a specific scope within the scope type - } -} +```typescript + +```` + ``` + + --- +``` diff --git a/apis/next/core/Advertising/schemas/index.md b/apis/next/core/Advertising/schemas/index.md index 1c3a124ef..8bfc5be3b 100644 --- a/apis/next/core/Advertising/schemas/index.md +++ b/apis/next/core/Advertising/schemas/index.md @@ -41,12 +41,15 @@ Applies to fast-forward/rewind (e.g. trick mode), seeking over an entire opportu Namespace: `xrn:advertising:policy:skipRestriction:` ```typescript -enum SkipRestriction { - NONE = 'none', - ADS_UNWATCHED = 'adsUnwatched', - ADS_ALL = 'adsAll', - ALL = 'all', -} +SkipRestriction Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| ADS_UNWATCHED | adsUnwatched | +| ADS_ALL | adsAll | +| ALL | all | + ``` --- diff --git a/apis/next/core/Authentication/index.md b/apis/next/core/Authentication/index.md index 5fd87aef2..317a4c2cb 100644 --- a/apis/next/core/Authentication/index.md +++ b/apis/next/core/Authentication/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Authentication 1.1.1-next.2 +Version Authentication 1.2.0-next.1 ## Table of Contents @@ -44,7 +44,7 @@ A module for acquiring authentication tokens. Get a device token scoped to the current app. ```typescript -function device(): Promise +${method.signature} ``` Promise resolution: @@ -110,7 +110,7 @@ Response: Get a root device token. ```typescript -function root(): Promise +${method.signature} ``` Promise resolution: @@ -176,7 +176,7 @@ Response: Get a destributor session token. ```typescript -function session(): Promise +${method.signature} ``` Promise resolution: @@ -242,15 +242,18 @@ Response: Get a specific `type` of authentication token ```typescript -function token(type: TokenType, options?: object): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | ------------------------- | -------- | -------------------------------------------------------------------------------- | -| `type` | [`TokenType`](#tokentype) | true | What type of token to get
values: `'platform' \| 'device' \| 'distributor'` | -| `options` | `object` | false | Additional options for acquiring the token. | +| Param | Type | Required | Description | +| ------------- | ----------------------- | ------------------------------------------- | --------------------------------------------------------------------------- | ----------- | +| `type` | `` | true | What type of token to get values: `'platform' \| 'device' \| 'distributor'` | +| `options` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | false | Additional options for acquiring the token. | Promise resolution: @@ -438,11 +441,14 @@ Response: ### TokenType ```typescript -enum TokenType { - PLATFORM = 'platform', - DEVICE = 'device', - DISTRIBUTOR = 'distributor', -} +TokenType Enumeration: + +| key | value | +|-----|-------| +| PLATFORM | platform | +| DEVICE | device | +| DISTRIBUTOR | distributor | + ``` --- diff --git a/apis/next/core/Capabilities/index.md b/apis/next/core/Capabilities/index.md index 5abf5bf15..513c03cf7 100644 --- a/apis/next/core/Capabilities/index.md +++ b/apis/next/core/Capabilities/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Capabilities 1.1.1-next.2 +Version Capabilities 1.2.0-next.1 ## Table of Contents @@ -53,14 +53,14 @@ The Capabilities module provides information about which discreet unit of functi Returns whether a capability is available now. ```typescript -function available(capability: Capability): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Promise resolution: @@ -175,23 +175,20 @@ Response: Returns whether the current App has a user grant for passed capability and role. ```typescript -function granted( - capability: Capability, - options?: CapabilityOption, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | -| `options` | [`CapabilityOption`](#capabilityoption) | false | Capability options | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| `options` | `` | false | Capability options | Promise resolution: ```typescript -boolean | void +boolean ``` Capabilities: @@ -350,19 +347,19 @@ Response: Returns an array of CapabilityInfo objects for the passed in capabilities. ```typescript -function info(capabilities: Capability[]): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------------- | -------------- | -------- | ---------------------------------------------------------------------- | -| `capabilities` | `Capability[]` | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| -------------- | ---- | -------- | ----------------------------------------------------------------- | +| `capabilities` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Promise resolution: ```typescript -CapabilityInfo[] + ``` Capabilities: @@ -910,18 +907,15 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Returns whether the current App has permission to the passed capability and role. ```typescript -function permitted( - capability: Capability, - options?: CapabilityOption, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | -| `options` | [`CapabilityOption`](#capabilityoption) | false | Capability options | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| `options` | `` | false | Capability options | Promise resolution: @@ -1088,19 +1082,19 @@ Response: Requests grants for all capability/role combinations in the roles array. ```typescript -function request(grants: Permission[]): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | -------------- | -------- | ----------- | -| `grants` | `Permission[]` | true | | +| Param | Type | Required | Description | +| -------- | ---- | -------- | ----------- | +| `grants` | `` | true | | Promise resolution: ```typescript -CapabilityInfo[] + ``` Capabilities: @@ -1205,14 +1199,14 @@ Response: Returns whether the platform supports the passed capability. ```typescript -function supported(capability: Capability): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Promise resolution: @@ -1327,29 +1321,37 @@ Response: ### available ```typescript -function listen('available', capability: Capability, (CapabilityInfo) => void): Promise +function listen('available', | `capability` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Event value: -[CapabilityInfo](../Capabilities/schemas/#CapabilityInfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:capabilities:info | + #### Examples + Platform token is available JavaScript: @@ -1357,10 +1359,10 @@ JavaScript: ```javascript import { Capabilities } from '@firebolt-js/sdk' -Capabilities.listen('available', (value) => { +Capabilities.listen('available', value => { console.log(value) }) -``` +```` Value of `value`: @@ -1437,30 +1439,39 @@ Response: ### granted ```typescript -function listen('granted', role: Role, capability: Capability, (CapabilityInfo) => void): Promise +function listen('granted', | `role` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, | `capability` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `role` | [`Role`](../Capabilities/schemas/#Role) | true |
values: `'use' \| 'manage' \| 'provide'` | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `role` | `` | true | values: `'use' \| 'manage' \| 'provide'` | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Event value: -[CapabilityInfo](../Capabilities/schemas/#CapabilityInfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:capabilities:info | + #### Examples + Postal code granted JavaScript: @@ -1468,10 +1479,10 @@ JavaScript: ```javascript import { Capabilities } from '@firebolt-js/sdk' -Capabilities.listen('granted', (value) => { +Capabilities.listen('granted', value => { console.log(value) }) -``` +```` Value of `value`: @@ -1545,30 +1556,39 @@ Response: ### revoked ```typescript -function listen('revoked', role: Role, capability: Capability, (CapabilityInfo) => void): Promise +function listen('revoked', | `role` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, | `capability` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `role` | [`Role`](../Capabilities/schemas/#Role) | true |
values: `'use' \| 'manage' \| 'provide'` | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `role` | `` | true | values: `'use' \| 'manage' \| 'provide'` | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Event value: -[CapabilityInfo](../Capabilities/schemas/#CapabilityInfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:capabilities:info | + #### Examples + Postal code revoked JavaScript: @@ -1576,10 +1596,10 @@ JavaScript: ```javascript import { Capabilities } from '@firebolt-js/sdk' -Capabilities.listen('revoked', (value) => { +Capabilities.listen('revoked', value => { console.log(value) }) -``` +```` Value of `value`: @@ -1657,29 +1677,37 @@ Response: ### unavailable ```typescript -function listen('unavailable', capability: Capability, (CapabilityInfo) => void): Promise +function listen('unavailable', | `capability` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Event value: -[CapabilityInfo](../Capabilities/schemas/#CapabilityInfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:capabilities:info | + #### Examples + Platform token is unavailable. JavaScript: @@ -1687,10 +1715,10 @@ JavaScript: ```javascript import { Capabilities } from '@firebolt-js/sdk' -Capabilities.listen('unavailable', (value) => { +Capabilities.listen('unavailable', value => { console.log(value) }) -``` +```` Value of `value`: @@ -1768,14 +1796,16 @@ Response: ### CapabilityOption +````typescript ```typescript -type CapabilityOption = { - role?: Role // Role provides access level for the app for a given capability. -} + +```` + ``` See also: -'use' | 'manage' | 'provide' + --- +``` diff --git a/apis/next/core/Capabilities/schemas/index.md b/apis/next/core/Capabilities/schemas/index.md index 4477cf247..470388651 100644 --- a/apis/next/core/Capabilities/schemas/index.md +++ b/apis/next/core/Capabilities/schemas/index.md @@ -35,11 +35,14 @@ undefined Role provides access level for the app for a given capability. ```typescript -enum Role { - USE = 'use', - MANAGE = 'manage', - PROVIDE = 'provide', -} +Role Enumeration: + +| key | value | +|-----|-------| +| USE | use | +| MANAGE | manage | +| PROVIDE | provide | + ``` --- @@ -49,14 +52,17 @@ enum Role { Reasons why a Capability might not be invokable ```typescript -enum DenyReason { - UNPERMITTED = 'unpermitted', - UNSUPPORTED = 'unsupported', - DISABLED = 'disabled', - UNAVAILABLE = 'unavailable', - GRANT_DENIED = 'grantDenied', - UNGRANTED = 'ungranted', -} +DenyReason Enumeration: + +| key | value | +|-----|-------| +| UNPERMITTED | unpermitted | +| UNSUPPORTED | unsupported | +| DISABLED | disabled | +| UNAVAILABLE | unavailable | +| GRANT_DENIED | grantDenied | +| UNGRANTED | ungranted | + ``` --- @@ -66,7 +72,7 @@ enum DenyReason { A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. ```typescript -type Capability = string + ``` --- @@ -74,41 +80,24 @@ type Capability = string ### CapPermissionStatus ```typescript -type CapPermissionStatus = { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void -} + ``` --- ### CapabilityInfo +````typescript ```typescript -type CapabilityInfo = { - capability?: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. - supported: boolean // Provides info whether the capability is supported - available: boolean // Provides info whether the capability is available - use: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - manage: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - provide: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - details?: DenyReason[] -} -``` + +```` + +```` See also: -string -'unpermitted' | 'unsupported' | 'disabled' | 'unavailable' | 'grantDenied' | 'ungranted' + + --- @@ -117,15 +106,16 @@ string A capability combined with a Role, which an app may be permitted (by a distributor) or granted (by an end user). ```typescript -type Permission = { - role?: Role // Role provides access level for the app for a given capability. - capability: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. -} +```typescript + +```` + ``` See also: -'use' | 'manage' | 'provide' -string + + --- +``` diff --git a/apis/next/core/Device/index.md b/apis/next/core/Device/index.md index e9fed660a..ab2f1fc8f 100644 --- a/apis/next/core/Device/index.md +++ b/apis/next/core/Device/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Device 1.1.1-next.2 +Version Device 1.2.0-next.1 ## Table of Contents @@ -72,21 +72,28 @@ Get the supported audio profiles To get the value of `audio` call the method like this: ```typescript -function audio(): Promise +${method.signature} ``` Promise resolution: -[AudioProfiles](#audioprofiles) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Getting the supported audio profiles JavaScript: @@ -96,7 +103,7 @@ import { Device } from '@firebolt-js/sdk' let supportedAudioProfiles = await Device.audio() console.log(supportedAudioProfiles) -``` +```` Value of `supportedAudioProfiles`: @@ -144,7 +151,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function audio(callback: (value) => AudioProfiles): Promise +function audio(callback: (value) => ): Promise ``` Promise resolution: @@ -220,7 +227,7 @@ Get the distributor ID for this device To get the value of `distributor` call the method like this: ```typescript -function distributor(): Promise +${method.signature} ``` Promise resolution: @@ -288,21 +295,28 @@ Get the supported HDCP profiles To get the value of `hdcp` call the method like this: ```typescript -function hdcp(): Promise +${method.signature} ``` Promise resolution: -[BooleanMap](../Types/schemas/#BooleanMap) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Getting the supported HDCP profiles JavaScript: @@ -312,7 +326,7 @@ import { Device } from '@firebolt-js/sdk' let supportedHdcpProfiles = await Device.hdcp() console.log(supportedHdcpProfiles) -``` +```` Value of `supportedHdcpProfiles`: @@ -356,7 +370,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function hdcp(callback: (value) => BooleanMap): Promise +function hdcp(callback: (value) => ): Promise ``` Promise resolution: @@ -428,21 +442,28 @@ Get the supported HDR profiles To get the value of `hdr` call the method like this: ```typescript -function hdr(): Promise +${method.signature} ``` Promise resolution: -[BooleanMap](../Types/schemas/#BooleanMap) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Getting the supported HDR profiles JavaScript: @@ -452,7 +473,7 @@ import { Device } from '@firebolt-js/sdk' let supportedHdrProfiles = await Device.hdr() console.log(supportedHdrProfiles) -``` +```` Value of `supportedHdrProfiles`: @@ -500,7 +521,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function hdr(callback: (value) => BooleanMap): Promise +function hdr(callback: (value) => ): Promise ``` Promise resolution: @@ -576,7 +597,7 @@ Get the platform back-office device identifier To get the value of `id` call the method like this: ```typescript -function id(): Promise +${method.signature} ``` Promise resolution: @@ -698,7 +719,7 @@ Get the device make To get the value of `make` call the method like this: ```typescript -function make(): Promise +${method.signature} ``` Promise resolution: @@ -766,7 +787,7 @@ Get the device model To get the value of `model` call the method like this: ```typescript -function model(): Promise +${method.signature} ``` Promise resolution: @@ -834,7 +855,7 @@ The human readable name of the device To get the value of `name` call the method like this: ```typescript -function name(): Promise +${method.signature} ``` Promise resolution: @@ -1052,15 +1073,15 @@ Get the current network status and type To get the value of `network` call the method like this: ```typescript -function network(): Promise +${method.signature} ``` Promise resolution: -| Property | Type | Description | -| -------- | ----------------------------- | ----------- | -| `state` | [NetworkState](#networkstate) | | -| `type` | [NetworkType](#networktype) | | +| Property | Type | Description | +| -------- | ---- | ----------- | +| `state` | | | +| `type` | | | Capabilities: @@ -1123,7 +1144,10 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function network(callback: (value) => object): Promise +function network(callback: (value) => | Property | Type | Description | +|----------|------|-------------| +| `${property}` | [${type}](${type.link}) | ${description} | +): Promise ``` Promise resolution: @@ -1251,7 +1275,7 @@ Get the platform ID for this device To get the value of `platform` call the method like this: ```typescript -function platform(): Promise +${method.signature} ``` Promise resolution: @@ -1319,23 +1343,28 @@ Get the current screen resolution To get the value of `screenResolution` call the method like this: ```typescript -function screenResolution(): Promise<[number, number]> +${method.signature} ``` Promise resolution: +````typescript ```typescript -type Resolution = [number, number] -``` + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Getting the screen resolution JavaScript: @@ -1345,7 +1374,7 @@ import { Device } from '@firebolt-js/sdk' let screenResolution = await Device.screenResolution() console.log(screenResolution) -``` +```` Value of `screenResolution`: @@ -1383,9 +1412,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function screenResolution( - callback: (value) => [number, number], -): Promise +function screenResolution(callback: (value) => ): Promise ``` Promise resolution: @@ -1451,7 +1478,7 @@ Get the device sku To get the value of `sku` call the method like this: ```typescript -function sku(): Promise +${method.signature} ``` Promise resolution: @@ -1519,7 +1546,7 @@ Get the device type To get the value of `type` call the method like this: ```typescript -function type(): Promise +${method.signature} ``` Promise resolution: @@ -1587,7 +1614,7 @@ Gets a unique id for the current app & device To get the value of `uid` call the method like this: ```typescript -function uid(): Promise +${method.signature} ``` Promise resolution: @@ -1655,18 +1682,18 @@ Get the SDK, OS and other version info To get the value of `version` call the method like this: ```typescript -function version(): Promise +${method.signature} ``` Promise resolution: -| Property | Type | Description | -| ---------- | ---------------------------------------------------- | ---------------------------------------------------------------- | -| `sdk` | [SemanticVersion](../Types/schemas/#SemanticVersion) | The Firebolt SDK version | -| `api` | [SemanticVersion](../Types/schemas/#SemanticVersion) | The lateset Firebolt API version supported by the curent device. | -| `firmware` | [SemanticVersion](../Types/schemas/#SemanticVersion) | The device firmware version. | -| `os` | [SemanticVersion](../Types/schemas/#SemanticVersion) | **Deprecated** Use `firmware`, instead. | -| `debug` | string | Detail version as a string, for debugging purposes | +| Property | Type | Description | +| ---------- | ------ | ---------------------------------------------------------------- | +| `sdk` | | The Firebolt SDK version | +| `api` | | The lateset Firebolt API version supported by the curent device. | +| `firmware` | | The device firmware version. | +| `os` | | **Deprecated** Use `firmware`, instead. | +| `debug` | string | Detail version as a string, for debugging purposes | Capabilities: @@ -1779,23 +1806,28 @@ Get the current video resolution To get the value of `videoResolution` call the method like this: ```typescript -function videoResolution(): Promise<[number, number]> +${method.signature} ``` Promise resolution: +````typescript ```typescript -type Resolution = [number, number] -``` + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Getting the video resolution JavaScript: @@ -1805,7 +1837,7 @@ import { Device } from '@firebolt-js/sdk' let videoResolution = await Device.videoResolution() console.log(videoResolution) -``` +```` Value of `videoResolution`: @@ -1843,7 +1875,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function videoResolution(callback: (value) => [number, number]): Promise +function videoResolution(callback: (value) => ): Promise ``` Promise resolution: @@ -1911,7 +1943,7 @@ See: [audio](#audio) ### deviceNameChanged ```typescript -function listen('deviceNameChanged', (string) => void): Promise +function listen('deviceNameChanged', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). @@ -2008,10 +2040,13 @@ See: [videoResolution](#videoresolution) The type of network that is currently active ```typescript -enum NetworkState { - CONNECTED = 'connected', - DISCONNECTED = 'disconnected', -} +NetworkState Enumeration: + +| key | value | +|-----|-------| +| CONNECTED | connected | +| DISCONNECTED | disconnected | + ``` --- @@ -2021,39 +2056,46 @@ enum NetworkState { The type of network that is currently active ```typescript -enum NetworkType { - WIFI = 'wifi', - ETHERNET = 'ethernet', - HYBRID = 'hybrid', -} +NetworkType Enumeration: + +| key | value | +|-----|-------| +| WIFI | wifi | +| ETHERNET | ethernet | +| HYBRID | hybrid | + ``` --- ### AudioProfiles +````typescript ```typescript -type AudioProfiles = { - stereo: boolean - 'dolbyDigital5.1': boolean - 'dolbyDigital7.1': boolean - 'dolbyDigital5.1+': boolean - 'dolbyDigital7.1+': boolean - dolbyAtmos: boolean -} -``` + +```` + +```` See also: -[BooleanMap](../Types/schemas/#BooleanMap) -'stereo' | 'dolbyDigital5.1' | 'dolbyDigital7.1' | 'dolbyDigital5.1+' | 'dolbyDigital7.1+' | 'dolbyAtmos' + + --- ### Resolution + + +```typescript ```typescript -type Resolution = [number, number] + +```` + ``` + + --- +``` diff --git a/apis/next/core/Discovery/index.md b/apis/next/core/Discovery/index.md index be8022d15..6e87a9425 100644 --- a/apis/next/core/Discovery/index.md +++ b/apis/next/core/Discovery/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Discovery 1.1.1-next.2 +Version Discovery 1.2.0-next.1 ## Table of Contents @@ -75,7 +75,7 @@ Apps should provide prices in the same currency presented in the app. If multipl Clear both availabilities and entitlements from the subscriber. This is equivalent of calling `Discovery.contentAccess({ availabilities: [], entitlements: []})`. This is typically called when the user signs out of an account. ```typescript -function clearContentAccess(): Promise +${method.signature} ``` Promise resolution: @@ -141,14 +141,14 @@ Response: Inform the platform of what content the user can access either by discovering it or consuming it. Availabilities determine which content is discoverable to a user, while entitlements determine if the user can currently consume that content. Content can be available but not entitled, this means that user can see the content but when they try to open it they must gain an entitlement either through purchase or subscription upgrade. In case the access changed off-device, this API should be called any time the app comes to the foreground to refresh the access. This API should also be called any time the availabilities or entitlements change within the app for any reason. Typical reasons may include the user signing into an account or upgrading a subscription. Less common cases can cause availabilities to change, such as moving to a new service location. When availabilities or entitlements are removed from the subscriber (such as when the user signs out), then an empty array should be given. To clear both, use the Discovery.clearContentAccess convenience API. ```typescript -function contentAccess(ids: ContentAccessIdentifiers): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ----- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | -| `ids` | [`ContentAccessIdentifiers`](#contentaccessidentifiers) | true | A list of identifiers that represent content that is discoverable or consumable for the subscriber | +| Param | Type | Required | Description | +| ----- | ---- | -------- | -------------------------------------------------------------------------------------------------- | +| `ids` | `` | true | A list of identifiers that represent content that is discoverable or consumable for the subscriber | Promise resolution: @@ -485,14 +485,14 @@ Response: Inform the platform of the users latest entitlements w/in this app. ```typescript -function entitlements(entitlements: Entitlement[]): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------------- | --------------- | -------- | ---------------------------- | -| `entitlements` | `Entitlement[]` | true | Array of entitlement objects | +| Param | Type | Required | Description | +| -------------- | ---- | -------- | ---------------------------- | +| `entitlements` | `` | true | Array of entitlement objects | Promise resolution: @@ -588,43 +588,43 @@ To allow the platform to pull data, use `entityInfo(callback: Function)`: ```typescript function entityInfo( - callback: (parameters: EntityInfoParameters) => Promise, + callback: (parameters: EntityInfoParameters) => Promise<>, ): Promise ``` Parameters: -| Param | Type | Required | Summary | -| ---------- | ---------- | -------- | ------------------------------------------------------------ | -| `callback` | `Function` | Yes | A callback for the platform to pull EntityInfoResult objects | +| Param | Type | Required | Summary | +| ---------- | ---------- | -------- | ------------------------------------------- | +| `callback` | `Function` | Yes | A callback for the platform to pull objects | Callback parameters: -| Param | Type | Required | Summary | -| ------------ | ---------------------- | -------- | --------------------------------------------------------------------------- | -| `parameters` | `EntityInfoParameters` | Yes | An object describing the platform's query for an `EntityInfoResult` object. | +| Param | Type | Required | Summary | +| ------------ | ---------------------- | -------- | ----------------------------------------------------------- | +| `parameters` | `EntityInfoParameters` | Yes | An object describing the platform's query for an `` object. | +````typescript ```typescript -type EntityInfoParameters = { - entityId: string - assetId?: string -} -``` + +```` + +```` Callback promise resolution: ```typescript -type EntityInfoResult = { - expires: string - entity: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. - related?: EntityInfo[] -} -``` +```typescript + +```` + +```` + -See also: [EntityInfoResult](#entityinforesult-1) #### Examples + Send entity info for a movie to the platform. JavaScript: @@ -632,54 +632,65 @@ JavaScript: ```javascript import { Discovery } from '@firebolt-js/sdk' -let success = await Discovery.entityInfo(async (parameters) => { +let success = await Discovery.entityInfo(async parameters => { console.log(parameters.entityId) console.log(parameters.assetId) return { - expires: '2025-01-01T00:00:00.000Z', - entity: { - identifiers: { - entityId: '345', - }, - entityType: 'program', - programType: 'movie', - title: 'Cool Runnings', - synopsis: - 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.', - releaseDate: '1993-01-01T00:00:00.000Z', - contentRatings: [ - { - scheme: 'US-Movie', - rating: 'PG', - }, - { - scheme: 'CA-Movie', - rating: 'G', - }, - ], - waysToWatch: [ - { - identifiers: { - assetId: '123', - }, - expires: '2025-01-01T00:00:00.000Z', - entitled: true, - entitledExpires: '2025-01-01T00:00:00.000Z', - offeringType: 'buy', - price: 2.99, - videoQuality: ['UHD'], - audioProfile: ['dolbyAtmos'], - audioLanguages: ['en'], - closedCaptions: ['en'], - subtitles: ['es'], - audioDescriptions: ['en'], - }, - ], - }, - } + "expires": "2025-01-01T00:00:00.000Z", + "entity": { + "identifiers": { + "entityId": "345" + }, + "entityType": "program", + "programType": "movie", + "title": "Cool Runnings", + "synopsis": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.", + "releaseDate": "1993-01-01T00:00:00.000Z", + "contentRatings": [ + { + "scheme": "US-Movie", + "rating": "PG" + }, + { + "scheme": "CA-Movie", + "rating": "G" + } + ], + "waysToWatch": [ + { + "identifiers": { + "assetId": "123" + }, + "expires": "2025-01-01T00:00:00.000Z", + "entitled": true, + "entitledExpires": "2025-01-01T00:00:00.000Z", + "offeringType": "buy", + "price": 2.99, + "videoQuality": [ + "UHD" + ], + "audioProfile": [ + "dolbyAtmos" + ], + "audioLanguages": [ + "en" + ], + "closedCaptions": [ + "en" + ], + "subtitles": [ + "es" + ], + "audioDescriptions": [ + "en" + ] + } + ] + } + } }) console.log(success) -``` +````
JSON-RPC: @@ -1257,36 +1268,36 @@ Push Request:
-To push data to the platform, e.g. during app launch, use `entityInfo(result: EntityInfoResult)`: +To push data to the platform, e.g. during app launch, use `entityInfo(result: )`: ```typescript -function entityInfo(result: EntityInfoResult): Promise +function entityInfo(result: ): Promise ``` Parameters: -| Param | Type | Required | Summary | -| -------- | ------------------ | -------- | --------------------------------------------------- | -| `result` | `EntityInfoResult` | Yes | The `EntityInfoResult` data to push to the platform | +| Param | Type | Required | Summary | +| -------- | ---- | -------- | ----------------------------------- | +| `result` | `` | Yes | The `` data to push to the platform | +````typescript ```typescript -type EntityInfoResult = { - expires: string - entity: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. - related?: EntityInfo[] -} -``` + +```` + +```` See also: [EntityInfo](#entityinfo-1) Promise resolution: -| Type | Summary | -| --------- | -------------------------------------- | +| Type | Summary | +| ---- | ------- | | `boolean` | Whether or not the push was successful | #### Examples + Send entity info for a movie to the platform. JavaScript: @@ -1295,49 +1306,60 @@ JavaScript: import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.entityInfo({ - expires: '2025-01-01T00:00:00.000Z', - entity: { - identifiers: { - entityId: '345', - }, - entityType: 'program', - programType: 'movie', - title: 'Cool Runnings', - synopsis: - 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.', - releaseDate: '1993-01-01T00:00:00.000Z', - contentRatings: [ - { - scheme: 'US-Movie', - rating: 'PG', - }, - { - scheme: 'CA-Movie', - rating: 'G', - }, - ], - waysToWatch: [ - { - identifiers: { - assetId: '123', - }, - expires: '2025-01-01T00:00:00.000Z', - entitled: true, - entitledExpires: '2025-01-01T00:00:00.000Z', - offeringType: 'buy', - price: 2.99, - videoQuality: ['UHD'], - audioProfile: ['dolbyAtmos'], - audioLanguages: ['en'], - closedCaptions: ['en'], - subtitles: ['es'], - audioDescriptions: ['en'], - }, - ], - }, -}) + "expires": "2025-01-01T00:00:00.000Z", + "entity": { + "identifiers": { + "entityId": "345" + }, + "entityType": "program", + "programType": "movie", + "title": "Cool Runnings", + "synopsis": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.", + "releaseDate": "1993-01-01T00:00:00.000Z", + "contentRatings": [ + { + "scheme": "US-Movie", + "rating": "PG" + }, + { + "scheme": "CA-Movie", + "rating": "G" + } + ], + "waysToWatch": [ + { + "identifiers": { + "assetId": "123" + }, + "expires": "2025-01-01T00:00:00.000Z", + "entitled": true, + "entitledExpires": "2025-01-01T00:00:00.000Z", + "offeringType": "buy", + "price": 2.99, + "videoQuality": [ + "UHD" + ], + "audioProfile": [ + "dolbyAtmos" + ], + "audioLanguages": [ + "en" + ], + "closedCaptions": [ + "en" + ], + "subtitles": [ + "es" + ], + "audioDescriptions": [ + "en" + ] + } + ] + } + }) console.log(success) -``` +```` Value of `success`: @@ -1883,15 +1905,15 @@ For the Primary Experience, the appId can be any one of: - xrn:firebolt:application-type:settings ```typescript -function launch(appId: string, intent?: NavigationIntent): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | ---------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `appId` | `string` | true | The durable app Id of the app to launch | -| `intent` | [`NavigationIntent`](../Intents/schemas/#NavigationIntent) | false | An optional `NavigationIntent` with details about what part of the app to show first, and context around how/why it was launched | +| Param | Type | Required | Description | +| -------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `appId` | `string` | true | The durable app Id of the app to launch | +| `intent` | `` | false | An optional `NavigationIntent` with details about what part of the app to show first, and context around how/why it was launched | Promise resolution: @@ -2631,21 +2653,28 @@ get the discovery policy To get the value of `policy` call the method like this: ```typescript -function policy(): Promise +${method.signature} ``` Promise resolution: -[DiscoveryPolicy](#discoverypolicy) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ---------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:discovery:policy | + #### Examples + Getting the discovery policy JavaScript: @@ -2655,7 +2684,7 @@ import { Discovery } from '@firebolt-js/sdk' let policy = await Discovery.policy() console.log(policy) -``` +```` Value of `policy`: @@ -2701,7 +2730,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function policy(callback: (value) => DiscoveryPolicy): Promise +function policy(callback: (value) => ): Promise ``` Promise resolution: @@ -2788,46 +2817,43 @@ To allow the platform to pull data, use `purchasedContent(callback: Function)`: ```typescript function purchasedContent( - callback: ( - parameters: PurchasedContentParameters, - ) => Promise, + callback: (parameters: PurchasedContentParameters) => Promise<>, ): Promise ``` Parameters: -| Param | Type | Required | Summary | -| ---------- | ---------- | -------- | ------------------------------------------------------------------ | -| `callback` | `Function` | Yes | A callback for the platform to pull PurchasedContentResult objects | +| Param | Type | Required | Summary | +| ---------- | ---------- | -------- | ------------------------------------------- | +| `callback` | `Function` | Yes | A callback for the platform to pull objects | Callback parameters: -| Param | Type | Required | Summary | -| ------------ | ---------------------------- | -------- | --------------------------------------------------------------------------------- | -| `parameters` | `PurchasedContentParameters` | Yes | An object describing the platform's query for an `PurchasedContentResult` object. | +| Param | Type | Required | Summary | +| ------------ | ---------------------------- | -------- | ----------------------------------------------------------- | +| `parameters` | `PurchasedContentParameters` | Yes | An object describing the platform's query for an `` object. | +````typescript ```typescript -type PurchasedContentParameters = { - limit: number - offeringType?: OfferingType // The offering type of the WayToWatch. - programType?: ProgramType // In the case of a program `entityType`, specifies the program type. -} -``` + +```` + +```` Callback promise resolution: ```typescript -type PurchasedContentResult = { - expires: string - totalCount: number - entries: EntityInfo[] -} -``` +```typescript + +```` + +```` + -See also: [PurchasedContentResult](#purchasedcontentresult-1) #### Examples + Inform the platform of the user's purchased content JavaScript: @@ -2835,57 +2861,68 @@ JavaScript: ```javascript import { Discovery } from '@firebolt-js/sdk' -let success = await Discovery.purchasedContent(async (parameters) => { +let success = await Discovery.purchasedContent(async parameters => { console.log(parameters.entityId) console.log(parameters.assetId) return { - totalCount: 10, - expires: '2025-01-01T00:00:00.000Z', - entries: [ - { - identifiers: { - entityId: '345', - }, - entityType: 'program', - programType: 'movie', - title: 'Cool Runnings', - synopsis: - 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.', - releaseDate: '1993-01-01T00:00:00.000Z', - contentRatings: [ - { - scheme: 'US-Movie', - rating: 'PG', - }, - { - scheme: 'CA-Movie', - rating: 'G', - }, - ], - waysToWatch: [ - { - identifiers: { - assetId: '123', - }, - expires: '2025-01-01T00:00:00.000Z', - entitled: true, - entitledExpires: '2025-01-01T00:00:00.000Z', - offeringType: 'buy', - price: 2.99, - videoQuality: ['UHD'], - audioProfile: ['dolbyAtmos'], - audioLanguages: ['en'], - closedCaptions: ['en'], - subtitles: ['es'], - audioDescriptions: ['en'], - }, - ], - }, - ], - } + "totalCount": 10, + "expires": "2025-01-01T00:00:00.000Z", + "entries": [ + { + "identifiers": { + "entityId": "345" + }, + "entityType": "program", + "programType": "movie", + "title": "Cool Runnings", + "synopsis": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.", + "releaseDate": "1993-01-01T00:00:00.000Z", + "contentRatings": [ + { + "scheme": "US-Movie", + "rating": "PG" + }, + { + "scheme": "CA-Movie", + "rating": "G" + } + ], + "waysToWatch": [ + { + "identifiers": { + "assetId": "123" + }, + "expires": "2025-01-01T00:00:00.000Z", + "entitled": true, + "entitledExpires": "2025-01-01T00:00:00.000Z", + "offeringType": "buy", + "price": 2.99, + "videoQuality": [ + "UHD" + ], + "audioProfile": [ + "dolbyAtmos" + ], + "audioLanguages": [ + "en" + ], + "closedCaptions": [ + "en" + ], + "subtitles": [ + "es" + ], + "audioDescriptions": [ + "en" + ] + } + ] + } + ] + } }) console.log(success) -``` +````
JSON-RPC: @@ -2976,36 +3013,36 @@ Push Request:
-To push data to the platform, e.g. during app launch, use `purchasedContent(result: PurchasedContentResult)`: +To push data to the platform, e.g. during app launch, use `purchasedContent(result: )`: ```typescript -function purchasedContent(result: PurchasedContentResult): Promise +function purchasedContent(result: ): Promise ``` Parameters: -| Param | Type | Required | Summary | -| -------- | ------------------------ | -------- | --------------------------------------------------------- | -| `result` | `PurchasedContentResult` | Yes | The `PurchasedContentResult` data to push to the platform | +| Param | Type | Required | Summary | +| -------- | ---- | -------- | ----------------------------------- | +| `result` | `` | Yes | The `` data to push to the platform | +````typescript ```typescript -type PurchasedContentResult = { - expires: string - totalCount: number - entries: EntityInfo[] -} -``` + +```` + +```` See also: [PurchasedContent](#purchasedcontent-1) Promise resolution: -| Type | Summary | -| --------- | -------------------------------------- | +| Type | Summary | +| ---- | ------- | | `boolean` | Whether or not the push was successful | #### Examples + Inform the platform of the user's purchased content JavaScript: @@ -3014,52 +3051,63 @@ JavaScript: import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.purchasedContent({ - totalCount: 10, - expires: '2025-01-01T00:00:00.000Z', - entries: [ - { - identifiers: { - entityId: '345', - }, - entityType: 'program', - programType: 'movie', - title: 'Cool Runnings', - synopsis: - 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.', - releaseDate: '1993-01-01T00:00:00.000Z', - contentRatings: [ - { - scheme: 'US-Movie', - rating: 'PG', - }, - { - scheme: 'CA-Movie', - rating: 'G', - }, - ], - waysToWatch: [ - { - identifiers: { - assetId: '123', - }, - expires: '2025-01-01T00:00:00.000Z', - entitled: true, - entitledExpires: '2025-01-01T00:00:00.000Z', - offeringType: 'buy', - price: 2.99, - videoQuality: ['UHD'], - audioProfile: ['dolbyAtmos'], - audioLanguages: ['en'], - closedCaptions: ['en'], - subtitles: ['es'], - audioDescriptions: ['en'], - }, - ], - }, - ], -}) + "totalCount": 10, + "expires": "2025-01-01T00:00:00.000Z", + "entries": [ + { + "identifiers": { + "entityId": "345" + }, + "entityType": "program", + "programType": "movie", + "title": "Cool Runnings", + "synopsis": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pulvinar sapien et ligula ullamcorper malesuada proin libero nunc.", + "releaseDate": "1993-01-01T00:00:00.000Z", + "contentRatings": [ + { + "scheme": "US-Movie", + "rating": "PG" + }, + { + "scheme": "CA-Movie", + "rating": "G" + } + ], + "waysToWatch": [ + { + "identifiers": { + "assetId": "123" + }, + "expires": "2025-01-01T00:00:00.000Z", + "entitled": true, + "entitledExpires": "2025-01-01T00:00:00.000Z", + "offeringType": "buy", + "price": 2.99, + "videoQuality": [ + "UHD" + ], + "audioProfile": [ + "dolbyAtmos" + ], + "audioLanguages": [ + "en" + ], + "closedCaptions": [ + "en" + ], + "subtitles": [ + "es" + ], + "audioDescriptions": [ + "en" + ] + } + ] + } + ] + }) console.log(success) -``` +```` Value of `success`: @@ -3145,14 +3193,14 @@ Response: Inform the platform that your user is signed in, for increased visibility in search & discovery. Sign-in state is used separately from what content can be access through entitlements and availabilities. Sign-in state may be used when deciding whether to choose this app to handle a user intent. For instance, if the user tries to launch something generic like playing music from an artist, only a signed-in app will be chosen. If the user wants to tune to a channel, only a signed-in app will be chosen to handle that intent. While signIn can optionally include entitlements as those typically change at signIn time, it is recommended to make a separate call to Discovery.contentAccess for entitlements. signIn is not only for when a user explicitly enters login credentials. If an app does not require any credentials from the user to consume content, such as in a free app, then the app should call signIn immediately on launch. ```typescript -function signIn(entitlements?: Entitlement[]): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------- | -| `entitlements` | `Entitlement[]` | false | Optional array of Entitlements, in case of a different user account, or a long time since last sign-in. | +| Param | Type | Required | Description | +| -------------- | ---- | -------- | ------------------------------------------------------------------------------------------------------- | +| `entitlements` | `` | false | Optional array of Entitlements, in case of a different user account, or a long time since last sign-in. | Promise resolution: @@ -3273,7 +3321,7 @@ Response: Inform the platform that your user has signed out. See `Discovery.signIn` for more details on how the sign-in state is used.signOut will NOT clear entitlements, the app should make a separate call to Discovery.clearContentAccess. Apps should also call signOut when a login token has expired and the user is now in a signed-out state. ```typescript -function signOut(): Promise +${method.signature} ``` Promise resolution: @@ -3339,12 +3387,7 @@ Response: Notify the platform that content was partially or completely watched ```typescript -function watched( - entityId: string, - progress?: number, - completed?: boolean, - watchedOn?: string, -): Promise +${method.signature} ``` Parameters: @@ -3429,22 +3472,20 @@ Response: Suggest a call-to-action for this app on the platform home screen ```typescript -function watchNext( - title: LocalizedString, - identifiers: ContentIdentifiers, - expires?: string, - images?: object, -): Promise +${method.signature} ``` Parameters: -| 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
format: date-time | -| `images` | `object` | false | A set of images for this call to action | +| Param | Type | Required | Description | +| ------------- | ----------------------- | --------------------------------------- | -------------------------------------------------------------------------------------- | ----------- | +| `title` | `` | true | The title of this call to action | +| `identifiers` | `` | 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
format: date-time | +| `images` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | false | A set of images for this call to action | Promise resolution: @@ -3591,14 +3632,16 @@ Response: ### navigateTo ```typescript -function listen('navigateTo', (NavigationIntent) => void): Promise +function listen('navigateTo', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[NavigationIntent](../Intents/schemas/#NavigationIntent) +```typescript + +``` Capabilities: @@ -3681,102 +3724,116 @@ See: [policy](#policy) ### DiscoveryPolicy +````typescript ```typescript -type DiscoveryPolicy = { - enableRecommendations: boolean // Whether or not to the user has enabled history-based recommendations - shareWatchHistory: boolean // Whether or not the user has enabled app watch history data to be shared with the platform - rememberWatchedPrograms: boolean // Whether or not the user has enabled watch history -} -``` + +```` + +```` + + --- ### Availability + + ```typescript -type Availability = { - type: 'channel-lineup' | 'program-lineup' - id: string - catalogId?: string - startTime?: string - endTime?: string -} -``` +```typescript + +```` + +```` + + --- ### PurchasedContentParameters + + +```typescript ```typescript -type PurchasedContentParameters = { - limit: number - offeringType?: OfferingType // The offering type of the WayToWatch. - programType?: ProgramType // In the case of a program `entityType`, specifies the program type. -} -``` + +```` + +```` See also: -'free' | 'subscribe' | 'buy' | 'rent' -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' + + --- ### ContentAccessIdentifiers + + ```typescript -type ContentAccessIdentifiers = { - availabilities?: Availability[] // A list of identifiers that represent what content is discoverable for the subscriber. Excluding availabilities will cause no change to the availabilities that are stored for this subscriber. Providing an empty array will clear the subscriber's availabilities - entitlements?: Entitlement[] // A list of identifiers that represent what content is consumable for the subscriber. Excluding entitlements will cause no change to the entitlements that are stored for this subscriber. Providing an empty array will clear the subscriber's entitlements -} -``` +```typescript + +```` + +```` See also: -[Availability](#availability) -[Entitlement](../Entertainment/schemas/#Entitlement) + + --- ### EntityInfoParameters + + ```typescript -type EntityInfoParameters = { - entityId: string - assetId?: string -} -``` +```typescript + +```` + +```` + + --- ### EntityInfoFederatedRequest + + ```typescript -type EntityInfoFederatedRequest = { - parameters: EntityInfoParameters - correlationId: string -} -``` +```typescript + +```` + +```` See also: -[FederatedRequest](#federatedrequest) -[EntityInfoParameters](#entityinfoparameters) + + --- ### PurchasedContentFederatedRequest + + ```typescript -type PurchasedContentFederatedRequest = { - parameters: PurchasedContentParameters - correlationId: string -} +```typescript + +```` + ``` See also: -[FederatedRequest](#federatedrequest) -[PurchasedContentParameters](#purchasedcontentparameters) + + --- +``` diff --git a/apis/next/core/Discovery/schemas/index.md b/apis/next/core/Discovery/schemas/index.md index bca1a9f15..c7d513247 100644 --- a/apis/next/core/Discovery/schemas/index.md +++ b/apis/next/core/Discovery/schemas/index.md @@ -30,32 +30,33 @@ undefined The result for an `entityInfo()` push or pull. +````typescript ```typescript -type EntityInfoResult = { - expires: string - entity: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. - related?: EntityInfo[] -} -``` + +```` + +```` See also: -[EntityInfo](../Entertainment/schemas/#EntityInfo) + --- ### PurchasedContentResult + + ```typescript -type PurchasedContentResult = { - expires: string - totalCount: number - entries: EntityInfo[] -} +```typescript + +```` + ``` See also: -[EntityInfo](../Entertainment/schemas/#EntityInfo) + --- +``` diff --git a/apis/next/core/Entertainment/schemas/index.md b/apis/next/core/Entertainment/schemas/index.md index 06573cbb3..fadfa1a48 100644 --- a/apis/next/core/Entertainment/schemas/index.md +++ b/apis/next/core/Entertainment/schemas/index.md @@ -39,12 +39,15 @@ undefined The offering type of the WayToWatch. ```typescript -enum OfferingType { - FREE = 'free', - SUBSCRIBE = 'subscribe', - BUY = 'buy', - RENT = 'rent', -} +OfferingType Enumeration: + +| key | value | +|-----|-------| +| FREE | free | +| SUBSCRIBE | subscribe | +| BUY | buy | +| RENT | rent | + ``` --- @@ -54,20 +57,23 @@ enum OfferingType { In the case of a program `entityType`, specifies the program type. ```typescript -enum ProgramType { - MOVIE = 'movie', - EPISODE = 'episode', - SEASON = 'season', - SERIES = 'series', - OTHER = 'other', - PREVIEW = 'preview', - EXTRA = 'extra', - CONCERT = 'concert', - SPORTING_EVENT = 'sportingEvent', - ADVERTISEMENT = 'advertisement', - MUSIC_VIDEO = 'musicVideo', - MINISODE = 'minisode', -} +ProgramType Enumeration: + +| key | value | +|-----|-------| +| MOVIE | movie | +| EPISODE | episode | +| SEASON | season | +| SERIES | series | +| OTHER | other | +| PREVIEW | preview | +| EXTRA | extra | +| CONCERT | concert | +| SPORTING_EVENT | sportingEvent | +| ADVERTISEMENT | advertisement | +| MUSIC_VIDEO | musicVideo | +| MINISODE | minisode | + ``` --- @@ -77,10 +83,13 @@ enum ProgramType { In the case of a music `entityType`, specifies the type of music entity. ```typescript -enum MusicType { - SONG = 'song', - ALBUM = 'album', -} +MusicType Enumeration: + +| key | value | +|-----|-------| +| SONG | song | +| ALBUM | album | + ``` --- @@ -95,27 +104,29 @@ Apps do not need to provide all ids. They only need to provide the minimum required to target a playable stream or an entity detail screen via a deep link. If an id isn't needed to get to those pages, it doesn't need to be included. +````typescript ```typescript -type ContentIdentifiers = { - assetId?: string // Identifies a particular playable asset. For example, the HD version of a particular movie separate from the UHD version. - entityId?: string // Identifies an entity, such as a Movie, TV Series or TV Episode. - seasonId?: string // The TV Season for a TV Episode. - seriesId?: string // The TV Series for a TV Episode or TV Season. - appContentData?: string // App-specific content identifiers. -} -``` + +```` + +```` + + --- ### Entitlement + + ```typescript -type Entitlement = { - entitlementId: string - startTime?: string - endTime?: string -} -``` +```typescript + +```` + +```` + + --- @@ -157,19 +168,15 @@ Ratings: `G`, `8+`, `13+`, `16+`, `18+` Ratings: `G`, `8+`, `13+`, `16+`, `18+` + +```typescript ```typescript -type ContentRating = { - scheme: - | 'CA-Movie' - | 'CA-TV' - | 'CA-Movie-Fr' - | 'CA-TV-Fr' - | 'US-Movie' - | 'US-TV' // The rating scheme. - rating: string // The content rating. - advisories?: string[] // Optional list of subratings or content advisories. -} -``` + +```` + +```` + + --- @@ -211,28 +218,17 @@ multiple WayToWatch objects. points, the `price` provided must be the lowest available price. ```typescript -type WayToWatch = { - identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to - expires?: string // Time when the WayToWatch is no longer available. - entitled?: boolean // Specify if the user is entitled to watch the entity. - entitledExpires?: string // Time when the entity is no longer entitled. - offeringType?: OfferingType // The offering type of the WayToWatch. - hasAds?: boolean // True if the streamable asset contains ads. - price?: number // For "buy" and "rent" WayToWatch, the price to buy or rent in the user's preferred currency. - videoQuality?: 'SD' | 'HD' | 'UHD'[] // List of the video qualities available via the WayToWatch. - audioProfile: AudioProfile[] // List of the audio types available via the WayToWatch. - audioLanguages?: string[] // List of audio track languages available on the WayToWatch. The first is considered the primary language. Languages are expressed as ISO 639 1/2 codes. - closedCaptions?: string[] // List of languages for which closed captions are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. - subtitles?: string[] // List of languages for which subtitles are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. - audioDescriptions?: string[] // List of languages for which audio descriptions (DVD) as available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. -} -``` +```typescript + +```` + +```` See also: -[ContentIdentifiers](#contentidentifiers) -'free' | 'subscribe' | 'buy' | 'rent' -'stereo' | 'dolbyDigital5.1' | 'dolbyDigital7.1' | 'dolbyDigital5.1+' | 'dolbyDigital7.1+' | 'dolbyAtmos' + + + --- @@ -241,7 +237,7 @@ See also: An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. Additionally, EntityInfo objects must specify a properly formed -ContentIdentifiers object, `entityType`, and `title`. The app should provide +ContentIdentifiers object, `entityType`, and `title`. The app should provide the `synopsis` property for a good user experience if the content metadata is not available another way. @@ -254,29 +250,19 @@ It is optional for the `purchasedContent` method, but recommended because the UI may use those data. ```typescript -type EntityInfo = { - identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to - title: string // Title of the entity. - entityType: 'program' | 'music' // The type of the entity, e.g. `program` or `music`. - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - musicType?: MusicType // In the case of a music `entityType`, specifies the type of music entity. - synopsis?: string // Short description of the entity. - seasonNumber?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to. - seasonCount?: number // For TV series, seasons, and episodes, the total number of seasons. - episodeNumber?: number // For TV episodes, the episode number. - episodeCount?: number // For TV seasons and episodes, the total number of episodes in the current season. - releaseDate?: string // The date that the program or entity was released or first aired. - contentRatings?: ContentRating[] // A list of ContentRating objects, describing the entity's ratings in various rating schemes. - waysToWatch?: WayToWatch[] // An array of ways a user is might watch this entity, regardless of entitlements. -} +```typescript + +```` + ``` See also: -[ContentIdentifiers](#contentidentifiers) -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' -'song' | 'album' -[ContentRating](#contentrating) -[WayToWatch](#waytowatch) + + + + + --- +``` diff --git a/apis/next/core/Intents/schemas/index.md b/apis/next/core/Intents/schemas/index.md index 96e4ebbc2..ceb248c40 100644 --- a/apis/next/core/Intents/schemas/index.md +++ b/apis/next/core/Intents/schemas/index.md @@ -53,12 +53,7 @@ undefined A Firebolt compliant representation of a user intention. ```typescript -type Intent = { - action: string - context: { - source: string - } -} + ``` --- @@ -66,36 +61,33 @@ type Intent = { ### IntentProperties ```typescript -type IntentProperties = { - action: any - data: any - context: any -} + ``` --- ### ProgramEntity +````typescript ```typescript -type ProgramEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - entityId: string -} -``` + +```` + +```` See also: -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' + --- ### Identifier + + ```typescript -type Identifier = string -``` + +```` --- @@ -103,17 +95,14 @@ type Identifier = string A Firebolt compliant representation of a user intention to navigate an app to it's search UI with a search term populated, and bring that app to the foreground if needed. +````typescript ```typescript -type SearchIntent = { - action: 'search' - data?: { - query: string - } - context: { - source: string - } -} -``` + +```` + +```` + + --- @@ -122,45 +111,45 @@ type SearchIntent = { A Firebolt compliant representation of a user intention to navigate an app to a section not covered by `home`, `entity`, `player`, or `search`, and bring that app to the foreground if needed. ```typescript -type SectionIntent = { - action: 'section' - data?: { - sectionName: string - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- ### ChannelEntity + + ```typescript -type ChannelEntity = { - entityType: 'channel' - channelType: 'streaming' | 'overTheAir' - entityId: string // ID of the channel, in the target App's scope. - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- ### MusicEntity + + ```typescript -type MusicEntity = { - entityType: 'music' - musicType: MusicType // In the case of a music `entityType`, specifies the type of music entity. - entityId: string -} -``` +```typescript + +```` + +```` See also: -'song' | 'album' + --- @@ -169,25 +158,16 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to a the video player for an abstract query to be searched for and played by the app. ```typescript -type PlayQueryIntent = { - action: 'play-query' - data: { - query: string - options?: { - programTypes?: ProgramType[] - musicTypes?: MusicType[] - } - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' -'song' | 'album' + + --- @@ -196,13 +176,13 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to it's home screen, and bring that app to the foreground if needed. ```typescript -type HomeIntent = { - action: 'home' - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- @@ -211,31 +191,30 @@ type HomeIntent = { A Firebolt compliant representation of a user intention to launch an app. ```typescript -type LaunchIntent = { - action: 'launch' - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- ### TVSeriesEntity + + ```typescript -type TVSeriesEntity = { - entityType: 'program' - programType: 'series' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- @@ -244,13 +223,13 @@ See also: A Firebolt compliant representation of a Playlist entity. ```typescript -type PlaylistEntity = { - entityType: 'playlist' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- @@ -259,87 +238,81 @@ type PlaylistEntity = { A Firebolt compliant representation of a TV Season entity. ```typescript -type TVSeasonEntity = { - entityType: 'program' - programType: 'season' - entityId: string - seriesId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### AdditionalEntity + + ```typescript -type AdditionalEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### MovieEntity + + ```typescript -type MovieEntity = { - entityType: 'program' - programType: 'movie' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### TVEpisodeEntity + + +```typescript ```typescript -type TVEpisodeEntity = { - entityType: 'program' - programType: 'episode' - entityId: string - seriesId: string - seasonId: string - assetId?: string - appContentData?: string -} -``` + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### UntypedEntity + + ```typescript -type UntypedEntity = { - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- @@ -348,54 +321,34 @@ type UntypedEntity = { A Firebolt compliant representation of a user intention to navigate an app to a specific entity page, and bring that app to the foreground if needed. ```typescript -type EntityIntent = { - action: 'entity' - data: - | MovieEntity - | TVEpisodeEntity - | TVSeriesEntity - | TVSeasonEntity - | MusicEntity - | PlaylistEntity - | AdditionalEntity - | UntypedEntity - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -[MovieEntity](#movieentity) -[TVEpisodeEntity](#tvepisodeentity) -[TVSeriesEntity](#tvseriesentity) -[TVSeasonEntity](#tvseasonentity) -[MusicEntity](#musicentity) -[PlaylistEntity](#playlistentity) -[AdditionalEntity](#additionalentity) -[UntypedEntity](#untypedentity) + + + + + + + + --- ### PlayableEntity + + ```typescript -type PlayableEntity = - | MovieEntity - | TVEpisodeEntity - | PlaylistEntity - | MusicEntity - | AdditionalEntity -``` -See also: +```` -[MovieEntity](#movieentity) -[TVEpisodeEntity](#tvepisodeentity) -[PlaylistEntity](#playlistentity) -[MusicEntity](#musicentity) -[AdditionalEntity](#additionalentity) +See also: --- @@ -403,26 +356,16 @@ See also: A Firebolt compliant representation of a user intention to 'tune' to a traditional over-the-air broadcast, or an OTT Stream from an OTT or vMVPD App. +````typescript ```typescript -type TuneIntent = { - action: 'tune' - data: { - entity: ChannelEntity - options?: { - assetId?: string // The ID of a specific 'listing', as scoped by the target App's ID-space, which the App should begin playback from. - restartCurrentProgram?: boolean // Denotes that the App should start playback at the most recent program boundary, rather than 'live.' - time?: string // ISO 8601 Date/Time where the App should begin playback from. - } - } - context: { - source: string - } -} -``` + +```` + +```` See also: -[ChannelEntity](#channelentity) + --- @@ -431,24 +374,15 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed. ```typescript -type PlayEntityIntent = { - action: 'play-entity' - data: { - entity: PlayableEntity - options?: { - playFirstId?: string - playFirstTrack?: number - } - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity + --- @@ -457,18 +391,15 @@ MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed. ```typescript -type PlaybackIntent = { - action: 'playback' - data: PlayableEntity - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity + --- @@ -477,28 +408,9 @@ MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity A Firebolt compliant representation of a user intention to navigate to a specific place in an app. ```typescript -type NavigationIntent = - | HomeIntent - | LaunchIntent - | EntityIntent - | PlaybackIntent - | SearchIntent - | SectionIntent - | TuneIntent - | PlayEntityIntent - | PlayQueryIntent -``` -See also: +```` -[HomeIntent](#homeintent) -[LaunchIntent](#launchintent) -[EntityIntent](#entityintent) -[PlaybackIntent](#playbackintent) -[SearchIntent](#searchintent) -[SectionIntent](#sectionintent) -[TuneIntent](#tuneintent) -[PlayEntityIntent](#playentityintent) -[PlayQueryIntent](#playqueryintent) +See also: --- diff --git a/apis/next/core/Internal/index.md b/apis/next/core/Internal/index.md index 2e99b0ac1..0811cce21 100644 --- a/apis/next/core/Internal/index.md +++ b/apis/next/core/Internal/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Internal 1.1.1-next.2 +Version Internal 1.2.0-next.1 ## Table of Contents @@ -18,6 +18,7 @@ Version Internal 1.1.1-next.2 - [Overview](#overview) - [Methods](#methods) - [initialize](#initialize) +- [Types](#types) ## Overview @@ -33,15 +34,15 @@ Initialize the SDK / FEE session. Parameters: -| Param | Type | Required | Description | -| --------- | ------------------------------------------------------ | -------- | -------------------------------- | -| `version` | [`SemanticVersion`](../Types/schemas/#SemanticVersion) | true | The semantic version of the SDK. | +| Param | Type | Required | Description | +| --------- | ---- | -------- | -------------------------------- | +| `version` | `` | true | The semantic version of the SDK. | Result: -| Property | Type | Description | -| --------- | ---------------------------------------------------- | -------------------------------- | -| `version` | [SemanticVersion](../Types/schemas/#SemanticVersion) | The semantic version of the FEE. | +| Property | Type | Description | +| --------- | ---- | -------------------------------- | +| `version` | | The semantic version of the FEE. | Capabilities: @@ -91,3 +92,5 @@ Response: ``` --- + +## Types diff --git a/apis/next/core/Keyboard/index.md b/apis/next/core/Keyboard/index.md index 0f9baeb2f..a2d9224cd 100644 --- a/apis/next/core/Keyboard/index.md +++ b/apis/next/core/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Keyboard 1.1.1-next.2 +Version Keyboard 1.2.0-next.1 ## Table of Contents @@ -43,15 +43,15 @@ Methods for prompting users to enter text with task-oriented UX Prompt the user for their email address with a simplified list of choices. ```typescript -function email(type: EmailUsage, message?: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | --------------------------- | -------- | --------------------------------------------------------------------------------------------- | -| `type` | [`EmailUsage`](#emailusage) | true | Why the email is being requested, e.g. sign on or sign up
values: `'signIn' \| 'signUp'` | -| `message` | `string` | false | The message to display while prompting | +| Param | Type | Required | Description | +| --------- | -------- | -------- | ---------------------------------------------------------------------------------------- | +| `type` | `` | true | Why the email is being requested, e.g. sign on or sign up values: `'signIn' \| 'signUp'` | +| `message` | `string` | false | The message to display while prompting | Promise resolution: @@ -170,7 +170,7 @@ Response: Show the password entry keyboard, with typing obfuscated from visibility ```typescript -function password(message?: string): Promise +${method.signature} ``` Parameters: @@ -244,7 +244,7 @@ Response: Show the standard platform keyboard, and return the submitted value ```typescript -function standard(message: string): Promise +${method.signature} ``` Parameters: @@ -320,10 +320,13 @@ Response: ### EmailUsage ```typescript -enum EmailUsage { - SIGN_IN = 'signIn', - SIGN_UP = 'signUp', -} +EmailUsage Enumeration: + +| key | value | +|-----|-------| +| SIGN_IN | signIn | +| SIGN_UP | signUp | + ``` --- diff --git a/apis/next/core/Lifecycle/index.md b/apis/next/core/Lifecycle/index.md index af1e19dbf..cb5dff576 100644 --- a/apis/next/core/Lifecycle/index.md +++ b/apis/next/core/Lifecycle/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Lifecycle 1.1.1-next.2 +Version Lifecycle 1.2.0-next.1 ## Table of Contents @@ -52,14 +52,14 @@ Methods and events for responding to lifecycle changes in your app Request that the platform move your app out of focus ```typescript -function close(reason: CloseReason): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | -------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | -| `reason` | [`CloseReason`](../Lifecycle/schemas/#CloseReason) | true | The reason the app is requesting to be closed
values: `'remoteButton' \| 'userExit' \| 'done' \| 'error'` | +| Param | Type | Required | Description | +| -------- | ---- | -------- | --------------------------------------------------------------------------------------------------------- | +| `reason` | `` | true | The reason the app is requesting to be closed values: `'remoteButton' \| 'userExit' \| 'done' \| 'error'` | Promise resolution: @@ -170,7 +170,7 @@ Response: Notify the platform that the app is done unloading ```typescript -function finished(): Promise +${method.signature} ``` Promise resolution: @@ -346,7 +346,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Notify the platform that the app is ready ```typescript -function ready(): Promise +${method.signature} ``` Promise resolution: @@ -412,12 +412,24 @@ Response: Get the current state of the app. This function is **synchronous**. ```typescript -function state(): LifecycleState +${method.signature} ``` Promise resolution: -[LifecycleState](../Lifecycle/schemas/#LifecycleState) +```typescript +LifecycleState Enumeration: + +| key | value | +|-----|-------| +| INITIALIZING | initializing | +| INACTIVE | inactive | +| FOREGROUND | foreground | +| BACKGROUND | background | +| UNLOADING | unloading | +| SUSPENDED | suspended | + +``` Capabilities: @@ -476,23 +488,30 @@ Response: ### background ```typescript -function listen('background', (LifecycleEvent) => void): Promise +function listen('background', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[LifecycleEvent](#lifecycleevent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -500,10 +519,10 @@ JavaScript: ```javascript import { Lifecycle } from '@firebolt-js/sdk' -Lifecycle.listen('background', (value) => { +Lifecycle.listen('background', value => { console.log(value) }) -``` +```` Value of `value`: @@ -549,23 +568,30 @@ Response: ### foreground ```typescript -function listen('foreground', (LifecycleEvent) => void): Promise +function listen('foreground', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[LifecycleEvent](#lifecycleevent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -573,10 +599,10 @@ JavaScript: ```javascript import { Lifecycle } from '@firebolt-js/sdk' -Lifecycle.listen('foreground', (value) => { +Lifecycle.listen('foreground', value => { console.log(value) }) -``` +```` Value of `value`: @@ -674,23 +700,30 @@ Response: ### inactive ```typescript -function listen('inactive', (LifecycleEvent) => void): Promise +function listen('inactive', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[LifecycleEvent](#lifecycleevent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -698,10 +731,10 @@ JavaScript: ```javascript import { Lifecycle } from '@firebolt-js/sdk' -Lifecycle.listen('inactive', (value) => { +Lifecycle.listen('inactive', value => { console.log(value) }) -``` +```` Value of `value`: @@ -747,23 +780,30 @@ Response: ### suspended ```typescript -function listen('suspended', (LifecycleEvent) => void): Promise +function listen('suspended', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[LifecycleEvent](#lifecycleevent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -771,10 +811,10 @@ JavaScript: ```javascript import { Lifecycle } from '@firebolt-js/sdk' -Lifecycle.listen('suspended', (value) => { +Lifecycle.listen('suspended', value => { console.log(value) }) -``` +```` Value of `value`: @@ -820,23 +860,30 @@ Response: ### unloading ```typescript -function listen('unloading', (LifecycleEvent) => void): Promise +function listen('unloading', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[LifecycleEvent](#lifecycleevent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -844,10 +891,10 @@ JavaScript: ```javascript import { Lifecycle } from '@firebolt-js/sdk' -Lifecycle.listen('unloading', (value) => { +Lifecycle.listen('unloading', value => { console.log(value) }) -``` +```` Value of `value`: @@ -896,16 +943,16 @@ Response: A an object describing the previous and current states +````typescript ```typescript -type LifecycleEvent = { - state: LifecycleState // The application lifecycle state - previous: LifecycleState // The application lifecycle state - source?: 'voice' | 'remote' // The source of the lifecycle change. -} + +```` + ``` See also: -'initializing' | 'inactive' | 'foreground' | 'background' | 'unloading' | 'suspended' + --- +``` diff --git a/apis/next/core/Lifecycle/schemas/index.md b/apis/next/core/Lifecycle/schemas/index.md index ff0d7d117..2dd405600 100644 --- a/apis/next/core/Lifecycle/schemas/index.md +++ b/apis/next/core/Lifecycle/schemas/index.md @@ -31,12 +31,15 @@ undefined The application close reason ```typescript -enum CloseReason { - REMOTE_BUTTON = 'remoteButton', - USER_EXIT = 'userExit', - DONE = 'done', - ERROR = 'error', -} +CloseReason Enumeration: + +| key | value | +|-----|-------| +| REMOTE_BUTTON | remoteButton | +| USER_EXIT | userExit | +| DONE | done | +| ERROR | error | + ``` --- @@ -46,14 +49,17 @@ enum CloseReason { The application lifecycle state ```typescript -enum LifecycleState { - INITIALIZING = 'initializing', - INACTIVE = 'inactive', - FOREGROUND = 'foreground', - BACKGROUND = 'background', - UNLOADING = 'unloading', - SUSPENDED = 'suspended', -} +LifecycleState Enumeration: + +| key | value | +|-----|-------| +| INITIALIZING | initializing | +| INACTIVE | inactive | +| FOREGROUND | foreground | +| BACKGROUND | background | +| UNLOADING | unloading | +| SUSPENDED | suspended | + ``` --- diff --git a/apis/next/core/Localization/index.md b/apis/next/core/Localization/index.md index ad3f7ed01..8985246c1 100644 --- a/apis/next/core/Localization/index.md +++ b/apis/next/core/Localization/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Localization 1.1.1-next.2 +Version Localization 1.2.0-next.1 ## Table of Contents @@ -57,13 +57,16 @@ Methods for accessessing location and language preferences Get any platform-specific localization information, in an Map ```typescript -function additionalInfo(): Promise +${method.signature} ``` Promise resolution: ```typescript -object +| Property | Type | Description | +|----------|------|-------------| +| `${property}` | ${type} | | + ``` Capabilities: @@ -126,13 +129,13 @@ Get the ISO 3166-1 alpha-2 code for the country device is located in To get the value of `countryCode` call the method like this: ```typescript -function countryCode(): Promise +${method.signature} ``` Promise resolution: ```typescript -type CountryCode = string + ``` Capabilities: @@ -232,7 +235,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function countryCode(callback: (value) => string): Promise +function countryCode(callback: (value) => ): Promise ``` Promise resolution: @@ -344,13 +347,13 @@ Get the ISO 639 1/2 code for the preferred language To get the value of `language` call the method like this: ```typescript -function language(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Language = string + ``` Capabilities: @@ -450,7 +453,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function language(callback: (value) => string): Promise +function language(callback: (value) => ): Promise ``` Promise resolution: @@ -560,23 +563,28 @@ Response: Get the approximate latitude and longitude coordinates of the device location ```typescript -function latlon(): Promise<[number, number]> +${method.signature} ``` Promise resolution: +````typescript ```typescript -type LatLon = [number, number] -``` + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:localization:location | + #### Examples + Default Example JavaScript: @@ -586,7 +594,7 @@ import { Localization } from '@firebolt-js/sdk' let latlong = await Localization.latlon() console.log(latlong) -``` +```` Value of `latlong`: @@ -682,13 +690,13 @@ Get the _full_ BCP 47 code, including script, region, variant, etc., for the pre To get the value of `locale` call the method like this: ```typescript -function locale(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Locale = string + ``` Capabilities: @@ -788,7 +796,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function locale(callback: (value) => string): Promise +function locale(callback: (value) => ): Promise ``` Promise resolution: @@ -900,13 +908,13 @@ Get the locality/city the device is located in To get the value of `locality` call the method like this: ```typescript -function locality(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Locality = string + ``` Capabilities: @@ -1006,7 +1014,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function locality(callback: (value) => string): Promise +function locality(callback: (value) => ): Promise ``` Promise resolution: @@ -1174,7 +1182,7 @@ Get the postal code the device is located in To get the value of `postalCode` call the method like this: ```typescript -function postalCode(): Promise +${method.signature} ``` Promise resolution: @@ -1392,13 +1400,13 @@ A prioritized list of ISO 639 1/2 codes for the preferred audio languages on thi To get the value of `preferredAudioLanguages` call the method like this: ```typescript -function preferredAudioLanguages(): Promise +${method.signature} ``` Promise resolution: ```typescript -string[] + ``` Capabilities: @@ -1498,7 +1506,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function preferredAudioLanguages(callback: (value) => string[]): Promise +function preferredAudioLanguages(callback: (value) => ): Promise ``` Promise resolution: @@ -1633,8 +1641,14 @@ See: [preferredAudioLanguages](#preferredaudiolanguages) ### LatLon +````typescript ```typescript -type LatLon = [number, number] + +```` + ``` + + --- +``` diff --git a/apis/next/core/Localization/schemas/index.md b/apis/next/core/Localization/schemas/index.md index fb923df24..c393caa87 100644 --- a/apis/next/core/Localization/schemas/index.md +++ b/apis/next/core/Localization/schemas/index.md @@ -33,7 +33,7 @@ undefined ### ISO639_2Language ```typescript -type ISO639_2Language = string + ``` --- @@ -41,7 +41,7 @@ type ISO639_2Language = string ### Locality ```typescript -type Locality = string + ``` --- @@ -49,7 +49,7 @@ type Locality = string ### CountryCode ```typescript -type CountryCode = string + ``` --- @@ -57,7 +57,7 @@ type CountryCode = string ### Language ```typescript -type Language = string + ``` --- @@ -65,7 +65,7 @@ type Language = string ### Locale ```typescript -type Locale = string + ``` --- @@ -73,7 +73,7 @@ type Locale = string ### TimeZone ```typescript -type TimeZone = string + ``` --- diff --git a/apis/next/core/Metrics/index.md b/apis/next/core/Metrics/index.md index 871c3cdb9..4fc625caa 100644 --- a/apis/next/core/Metrics/index.md +++ b/apis/next/core/Metrics/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Metrics 1.1.1-next.2 +Version Metrics 1.2.0-next.1 ## Table of Contents @@ -60,11 +60,7 @@ Methods for sending metrics Inform the platform of something not covered by other Metrics APIs. ```typescript -function action( - category: 'user' | 'app', - type: string, - parameters?: object, -): Promise +${method.signature} ``` Parameters: @@ -73,7 +69,7 @@ Parameters: | ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `category` | `string` | true | The category of action being logged. Must be 'user' for user-initated actions or 'app' for all other actions
values: `'user' \| 'app'` | | `type` | `string` | true | A short, indexible identifier for the action, e.g. 'SignIn Prompt Displayed'
maxLength: 256 | -| `parameters` | `object` | false | | +| `parameters` | `` | false | | Promise resolution: @@ -141,24 +137,18 @@ Response: Inform the platform of an error that has occured in your app. ```typescript -function error( - type: ErrorType, - code: string, - description: string, - visible: boolean, - parameters?: object, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------- | ------------------------- | -------- | -------------------------------------------------------------------------------------------------- | -| `type` | [`ErrorType`](#errortype) | true | The type of error
values: `'network' \| 'media' \| 'restriction' \| 'entitlement' \| 'other'` | -| `code` | `string` | true | an app-specific error code | -| `description` | `string` | true | A short description of the error | -| `visible` | `boolean` | true | Whether or not this error was visible to the user. | -| `parameters` | `object` | false | Optional additional parameters to be logged with the error | +| Param | Type | Required | Description | +| ------------- | --------- | -------- | --------------------------------------------------------------------------------------------- | +| `type` | `` | true | The type of error values: `'network' \| 'media' \| 'restriction' \| 'entitlement' \| 'other'` | +| `code` | `string` | true | an app-specific error code | +| `description` | `string` | true | A short description of the error | +| `visible` | `boolean` | true | Whether or not this error was visible to the user. | +| `parameters` | `` | false | Optional additional parameters to be logged with the error | Promise resolution: @@ -234,7 +224,7 @@ Response: Called when playback has stopped because the end of the media was reached. ```typescript -function mediaEnded(entityId: string): Promise +${method.signature} ``` Parameters: @@ -308,7 +298,7 @@ Response: Called when setting the URL of a media asset to play, in order to infer load time. ```typescript -function mediaLoadStart(entityId: string): Promise +${method.signature} ``` Parameters: @@ -382,7 +372,7 @@ Response: Called when media playback will pause due to an intentional pause operation. ```typescript -function mediaPause(entityId: string): Promise +${method.signature} ``` Parameters: @@ -456,7 +446,7 @@ Response: Called when media playback should start due to autoplay, user-initiated play, or unpausing. ```typescript -function mediaPlay(entityId: string): Promise +${method.signature} ``` Parameters: @@ -530,7 +520,7 @@ Response: Called when media playback actually starts due to autoplay, user-initiated play, unpausing, or recovering from a buffering interuption. ```typescript -function mediaPlaying(entityId: string): Promise +${method.signature} ``` Parameters: @@ -604,18 +594,15 @@ Response: Called every 60 seconds as media playback progresses. ```typescript -function mediaProgress( - entityId: string, - progress: MediaPosition, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ---------- | --------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entityId` | `string` | true | The entityId of the media. | -| `progress` | [`MediaPosition`](#mediaposition) | true | Progress of playback, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | +| Param | Type | Required | Description | +| ---------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entityId` | `string` | true | The entityId of the media. | +| `progress` | `` | true | Progress of playback, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | Promise resolution: @@ -683,7 +670,7 @@ Response: Called when the playback rate of media is changed. ```typescript -function mediaRateChange(entityId: string, rate: number): Promise +${method.signature} ``` Parameters: @@ -759,13 +746,7 @@ Response: Called when the playback rendition (e.g. bitrate, dimensions, profile, etc) is changed. ```typescript -function mediaRenditionChange( - entityId: string, - bitrate: number, - width: number, - height: number, - profile?: string, -): Promise +${method.signature} ``` Parameters: @@ -853,18 +834,15 @@ Response: Called when a seek is completed during media playback. ```typescript -function mediaSeeked( - entityId: string, - position: MediaPosition, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ---------- | --------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entityId` | `string` | true | The entityId of the media. | -| `position` | [`MediaPosition`](#mediaposition) | true | Resulting position of the seek operation, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | +| Param | Type | Required | Description | +| ---------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entityId` | `string` | true | The entityId of the media. | +| `position` | `` | true | Resulting position of the seek operation, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | Promise resolution: @@ -932,15 +910,15 @@ Response: Called when a seek is initiated during media playback. ```typescript -function mediaSeeking(entityId: string, target: MediaPosition): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ---------- | --------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `entityId` | `string` | true | The entityId of the media. | -| `target` | [`MediaPosition`](#mediaposition) | true | Target destination of the seek, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | +| Param | Type | Required | Description | +| ---------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `entityId` | `string` | true | The entityId of the media. | +| `target` | `` | true | Target destination of the seek, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. | Promise resolution: @@ -1008,7 +986,7 @@ Response: Called when media playback will halt due to a network, buffer, or other unintentional constraint. ```typescript -function mediaWaiting(entityId: string): Promise +${method.signature} ``` Parameters: @@ -1082,7 +1060,7 @@ Response: Inform the platform that your user has navigated to a page or view. ```typescript -function page(pageId: string): Promise +${method.signature} ``` Parameters: @@ -1374,7 +1352,7 @@ Response: Inform the platform that your user has started content. ```typescript -function startContent(entityId?: string): Promise +${method.signature} ``` Parameters: @@ -1490,7 +1468,7 @@ Response: Inform the platform that your user has stopped content. ```typescript -function stopContent(entityId?: string): Promise +${method.signature} ``` Parameters: @@ -1606,13 +1584,16 @@ Response: ### ErrorType ```typescript -enum ErrorType { - NETWORK = 'network', - MEDIA = 'media', - RESTRICTION = 'restriction', - ENTITLEMENT = 'entitlement', - OTHER = 'other', -} +ErrorType Enumeration: + +| key | value | +|-----|-------| +| NETWORK | network | +| MEDIA | media | +| RESTRICTION | restriction | +| ENTITLEMENT | entitlement | +| OTHER | other | + ``` --- @@ -1622,7 +1603,7 @@ enum ErrorType { Represents a position inside playback content, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. ```typescript -type MediaPosition = void | number | number + ``` --- diff --git a/apis/next/core/Parameters/index.md b/apis/next/core/Parameters/index.md index 6aeac30b8..3847ca0d6 100644 --- a/apis/next/core/Parameters/index.md +++ b/apis/next/core/Parameters/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Parameters 1.1.1-next.2 +Version Parameters 1.2.0-next.1 ## Table of Contents @@ -41,21 +41,28 @@ Methods for getting initialization parameters for an app cold launch. Returns any initialization parameters for the app, e.g. initialial `NavigationIntent`. ```typescript -function initialization(): Promise +${method.signature} ``` Promise resolution: -[AppInitialization](#appinitialization) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | --------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:lifecycle:state | + #### Examples + Default Example JavaScript: @@ -65,7 +72,7 @@ import { Parameters } from '@firebolt-js/sdk' let init = await Parameters.initialization() console.log(init) -``` +```` Value of `init`: @@ -136,22 +143,17 @@ Response: ### AppInitialization +````typescript ```typescript -type AppInitialization = { - us_privacy?: string // The IAB US Privacy string. - lmt?: number // The IAB limit ad tracking opt out value. - discovery?: { - navigateTo?: NavigationIntent // A Firebolt compliant representation of a user intention to navigate to a specific place in an app. - } - secondScreen?: { - launchRequest?: SecondScreenEvent // An a message notification from a second screen device - } -} + +```` + ``` See also: -HomeIntent | LaunchIntent | EntityIntent | PlaybackIntent | SearchIntent | SectionIntent | TuneIntent | PlayEntityIntent | PlayQueryIntent -[SecondScreenEvent](../SecondScreen/schemas/#SecondScreenEvent) + + --- +``` diff --git a/apis/next/core/Profile/index.md b/apis/next/core/Profile/index.md index f9e170b93..070a231ad 100644 --- a/apis/next/core/Profile/index.md +++ b/apis/next/core/Profile/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version Profile 1.1.1-next.2 +Version Profile 1.2.0-next.1 ## Table of Contents @@ -21,6 +21,7 @@ Version Profile 1.1.1-next.2 - [approveContentRating](#approvecontentrating) - [approvePurchase](#approvepurchase) - [flags](#flags) +- [Types](#types) ## Usage @@ -41,7 +42,7 @@ Methods for getting information about the current user/account profile Verifies that the current profile should have access to mature/adult content. ```typescript -function approveContentRating(): Promise +${method.signature} ``` Promise resolution: @@ -107,7 +108,7 @@ Response: Verifies that the current profile should have access to making purchases. ```typescript -function approvePurchase(): Promise +${method.signature} ``` Promise resolution: @@ -173,25 +174,28 @@ Response: Get a map of profile flags for the current session. ```typescript -function flags(): Promise +${method.signature} ``` Promise resolution: +````typescript ```typescript -type FlatMap = { - [property: string]: string | number | boolean -} -``` + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:profile:flags | + #### Examples + Default Example JavaScript: @@ -201,7 +205,7 @@ import { Profile } from '@firebolt-js/sdk' let flags = await Profile.flags() console.log(flags) -``` +```` Value of `flags`: @@ -239,3 +243,5 @@ Response: --- + +## Types diff --git a/apis/next/core/SecondScreen/index.md b/apis/next/core/SecondScreen/index.md index 9bed1838d..b489acb40 100644 --- a/apis/next/core/SecondScreen/index.md +++ b/apis/next/core/SecondScreen/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecondScreen 1.1.1-next.2 +Version SecondScreen 1.2.0-next.1 ## Table of Contents @@ -27,6 +27,7 @@ Version SecondScreen 1.1.1-next.2 - [closeRequest](#closerequest) - [friendlyNameChanged](#friendlynamechanged) - [launchRequest](#launchrequest) +- [Types](#types) ## Usage @@ -47,7 +48,7 @@ Methods for communicating with second screen devices Get the broadcasted id for the device ```typescript -function device(type?: string): Promise +${method.signature} ``` Parameters: @@ -121,7 +122,7 @@ Get the broadcasted friendly name for the device To get the value of `friendlyName` call the method like this: ```typescript -function friendlyName(): Promise +${method.signature} ``` Promise resolution: @@ -359,21 +360,28 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Get the supported second screen discovery protocols ```typescript -function protocols(): Promise +${method.signature} ``` Promise resolution: -[BooleanMap](../Types/schemas/#BooleanMap) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:device:info | + #### Examples + Default Example JavaScript: @@ -383,7 +391,7 @@ import { SecondScreen } from '@firebolt-js/sdk' let protocols = await SecondScreen.protocols() console.log(protocols) -``` +```` Value of `protocols`: @@ -427,23 +435,30 @@ Response: ### closeRequest ```typescript -function listen('closeRequest', (SecondScreenEvent) => void): Promise +function listen('closeRequest', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[SecondScreenEvent](../SecondScreen/schemas/#SecondScreenEvent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:protocol:dial | + #### Examples + Default Example JavaScript: @@ -451,10 +466,10 @@ JavaScript: ```javascript import { SecondScreen } from '@firebolt-js/sdk' -SecondScreen.listen('closeRequest', (closeRequestEvent) => { +SecondScreen.listen('closeRequest', closeRequestEvent => { console.log(closeRequestEvent) }) -``` +```` Value of `closeRequestEvent`: @@ -504,23 +519,30 @@ See: [friendlyName](#friendlyname) ### launchRequest ```typescript -function listen('launchRequest', (SecondScreenEvent) => void): Promise +function listen('launchRequest', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[SecondScreenEvent](../SecondScreen/schemas/#SecondScreenEvent) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:protocol:dial | + #### Examples + Default Example JavaScript: @@ -528,10 +550,10 @@ JavaScript: ```javascript import { SecondScreen } from '@firebolt-js/sdk' -SecondScreen.listen('launchRequest', (launchRequestEvent) => { +SecondScreen.listen('launchRequest', launchRequestEvent => { console.log(launchRequestEvent) }) -``` +```` Value of `launchRequestEvent`: @@ -575,3 +597,5 @@ Response: --- + +## Types diff --git a/apis/next/core/SecondScreen/schemas/index.md b/apis/next/core/SecondScreen/schemas/index.md index f4d9b5127..892a2b11b 100644 --- a/apis/next/core/SecondScreen/schemas/index.md +++ b/apis/next/core/SecondScreen/schemas/index.md @@ -29,12 +29,14 @@ undefined An a message notification from a second screen device +````typescript ```typescript -type SecondScreenEvent = { - type: 'dial' - version?: string - data?: string -} + +```` + ``` + + --- +``` diff --git a/apis/next/core/SecureStorage/index.md b/apis/next/core/SecureStorage/index.md index 4df885733..50be5325f 100644 --- a/apis/next/core/SecureStorage/index.md +++ b/apis/next/core/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: core --- -Version SecureStorage 1.1.1-next.2 +Version SecureStorage 1.2.0-next.1 ## Table of Contents @@ -45,14 +45,14 @@ A module for storing and retrieving secure data owned by the app Clears all the secure data values ```typescript -function clear(scope: StorageScope): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | --------------------------------------------------------------- | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the key/value
values: `'device' \| 'account'` | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ---------------------------------------------------------- | +| `scope` | `` | true | The scope of the key/value values: `'device' \| 'account'` | Promise resolution: @@ -119,20 +119,20 @@ Response: Get stored value by key ```typescript -function get(scope: StorageScope, key: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | --------------------------------------------------------------- | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the key/value
values: `'device' \| 'account'` | -| `key` | `string` | true | Key to get | +| Param | Type | Required | Description | +| ------- | -------- | -------- | ---------------------------------------------------------- | +| `scope` | `` | true | The scope of the key/value values: `'device' \| 'account'` | +| `key` | `string` | true | Key to get | Promise resolution: ```typescript -string | null + ``` Capabilities: @@ -240,15 +240,15 @@ Response: Remove a secure data value ```typescript -function remove(scope: StorageScope, key: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | -------------------------------------------------------------- | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the data key
values: `'device' \| 'account'` | -| `key` | `string` | true | Key to remove | +| Param | Type | Required | Description | +| ------- | -------- | -------- | --------------------------------------------------------- | +| `scope` | `` | true | The scope of the data key values: `'device' \| 'account'` | +| `key` | `string` | true | Key to remove | Promise resolution: @@ -361,22 +361,17 @@ Response: Set or update a secure data value ```typescript -function set( - scope: StorageScope, - key: string, - value: string, - options?: StorageOptions, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | ----------------------------------- | -------- | -------------------------------------------------------------- | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the data key
values: `'device' \| 'account'` | -| `key` | `string` | true | Key to set | -| `value` | `string` | true | Value to set | -| `options` | [`StorageOptions`](#storageoptions) | false | Optional parameters to set | +| Param | Type | Required | Description | +| --------- | -------- | -------- | --------------------------------------------------------- | +| `scope` | `` | true | The scope of the data key values: `'device' \| 'account'` | +| `key` | `string` | true | Key to set | +| `value` | `string` | true | Value to set | +| `options` | `` | false | Optional parameters to set | Promise resolution: @@ -506,20 +501,27 @@ Response: The scope of the data ```typescript -enum StorageScope { - DEVICE = 'device', - ACCOUNT = 'account', -} +StorageScope Enumeration: + +| key | value | +|-----|-------| +| DEVICE | device | +| ACCOUNT | account | + ``` --- ### StorageOptions +````typescript ```typescript -type StorageOptions = { - ttl: number // Seconds from set time before the data expires and is removed -} + +```` + ``` + + --- +``` diff --git a/apis/next/core/Types/schemas/index.md b/apis/next/core/Types/schemas/index.md index 9b7e85f7e..8f9d2f7ab 100644 --- a/apis/next/core/Types/schemas/index.md +++ b/apis/next/core/Types/schemas/index.md @@ -33,38 +33,46 @@ undefined ### AudioProfile ```typescript -enum AudioProfile { - STEREO = 'stereo', - DOLBY_DIGITAL_5_1 = 'dolbyDigital5.1', - DOLBY_DIGITAL_7_1 = 'dolbyDigital7.1', - DOLBY_DIGITAL_5_1_PLUS = 'dolbyDigital5.1+', - DOLBY_DIGITAL_7_1_PLUS = 'dolbyDigital7.1+', - DOLBY_ATMOS = 'dolbyAtmos', -} +AudioProfile Enumeration: + +| key | value | +|-----|-------| +| STEREO | stereo | +| DOLBY_DIGITAL_5_1 | dolbyDigital5.1 | +| DOLBY_DIGITAL_7_1 | dolbyDigital7.1 | +| DOLBY_DIGITAL_5_1_PLUS | dolbyDigital5.1+ | +| DOLBY_DIGITAL_7_1_PLUS | dolbyDigital7.1+ | +| DOLBY_ATMOS | dolbyAtmos | + ``` --- ### BooleanMap +````typescript ```typescript -type BooleanMap = { - [property: string]: boolean -} -``` + +```` + +```` + + --- ### SemanticVersion + + ```typescript -type SemanticVersion = { - major: number - minor: number - patch: number - readable: string -} -``` +```typescript + +```` + +```` + + --- @@ -73,17 +81,15 @@ type SemanticVersion = { Localized string supports either a simple `string` or a Map of language codes to strings. When using a simple `string`, the current preferred langauge from `Localization.langauge()` is assumed. ```typescript -type LocalizedString = string | object -``` + +```` --- ### FlatMap ```typescript -type FlatMap = { - [property: string]: string | number | boolean -} + ``` --- @@ -93,7 +99,7 @@ type FlatMap = { Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error. ```typescript -type Timeout = number + ``` --- diff --git a/apis/next/manage/Accessibility/schemas/index.md b/apis/next/manage/Accessibility/schemas/index.md index f105fe92e..e617c7027 100644 --- a/apis/next/manage/Accessibility/schemas/index.md +++ b/apis/next/manage/Accessibility/schemas/index.md @@ -38,7 +38,7 @@ undefined ### FontFamily ```typescript -type FontFamily = string + ``` --- @@ -46,38 +46,40 @@ type FontFamily = string ### VoiceSpeed ```typescript -type VoiceSpeed = number + ``` --- ### VoiceGuidanceSettings +````typescript ```typescript -type VoiceGuidanceSettings = { - enabled: boolean // Whether or not voice guidance should be enabled by default - speed: VoiceSpeed -} -``` + +```` + +```` See also: -number + --- ### FontSize + + ```typescript -type FontSize = number -``` + +```` --- ### Color ```typescript -type Color = string + ``` --- @@ -85,7 +87,7 @@ type Color = string ### FontEdge ```typescript -type FontEdge = string + ``` --- @@ -93,7 +95,7 @@ type FontEdge = string ### Opacity ```typescript -type Opacity = number + ``` --- @@ -101,7 +103,7 @@ type Opacity = number ### HorizontalAlignment ```typescript -type HorizontalAlignment = string + ``` --- @@ -109,7 +111,7 @@ type HorizontalAlignment = string ### VerticalAlignment ```typescript -type VerticalAlignment = string + ``` --- @@ -118,37 +120,31 @@ type VerticalAlignment = string 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/next/manage/Account/index.md b/apis/next/manage/Account/index.md index a4c3a63d8..e89a29001 100644 --- a/apis/next/manage/Account/index.md +++ b/apis/next/manage/Account/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Account 1.1.1-next.2 +Version Account 1.2.0-next.1 ## Table of Contents @@ -42,15 +42,15 @@ A module for querying about the device account. Used by a distributor to push Session token to firebolt. ```typescript -function session(token: string, expiresIn: number): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ----------- | -------- | -------- | --------------- | -| `token` | `string` | true | | -| `expiresIn` | `number` | true |
minumum: 1 | +| Param | Type | Required | Description | +| ----------- | ---- | -------- | ----------- | +| `token` | `` | true | | +| `expiresIn` | `` | true | minumum: 1 | Promise resolution: @@ -123,7 +123,7 @@ Response: Encoded token provided by the Distributor for Device Authentication. ```typescript -type Token = string + ``` --- @@ -133,7 +133,7 @@ type Token = string Number of secs before the token expires ```typescript -type Expiry = number + ``` --- diff --git a/apis/next/manage/AcknowledgeChallenge/index.md b/apis/next/manage/AcknowledgeChallenge/index.md index 9b8d97ee0..8ab6eaee8 100644 --- a/apis/next/manage/AcknowledgeChallenge/index.md +++ b/apis/next/manage/AcknowledgeChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AcknowledgeChallenge 1.1.1-next.2 +Version AcknowledgeChallenge 1.2.0-next.1 ## Table of Contents @@ -54,15 +54,18 @@ Internal API for Challenge Provider to send back error. Parameters: -| Param | Type | Required | Description | -| --------------- | -------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `error` | `object` | true | | +| Param | Type | Required | Description | +| --------------- | ----------------------- | -------------- | ----------- | ----------- | +| `correlationId` | `string` | true | | +| `error` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | true | | Result: ```typescript -null + ``` Capabilities: @@ -115,7 +118,7 @@ Internal API for Challenge Provider to request focus for UX purposes. Result: ```typescript -null + ``` Capabilities: @@ -161,15 +164,15 @@ Internal API for Challenge Provider to send back response. Parameters: -| Param | Type | Required | Description | -| --------------- | ----------------------------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `result` | [`GrantResult`](#grantresult) | true | | +| Param | Type | Required | Description | +| --------------- | -------- | -------- | ----------- | +| `correlationId` | `string` | true | | +| `result` | `` | true | | Result: ```typescript -null + ``` Capabilities: @@ -305,16 +308,23 @@ Parameters: Result: -[ChallengeProviderRequest](#challengeproviderrequest) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| -------- | ------------------------------------------------------ | +| Role | Capability | +| --------------------- | -------------------------- | | provides | xrn:firebolt:capability:usergrant:acknowledgechallenge | + #### Examples + Default Example JSON-RPC: @@ -323,14 +333,14 @@ Request: ```json { - "jsonrpc": "2.0", - "id": 1, - "method": "AcknowledgeChallenge.onRequestChallenge", - "params": { - "listen": true - } + "jsonrpc": "2.0", + "id": 1, + "method": "AcknowledgeChallenge.onRequestChallenge", + "params": { + "listen": true + } } -``` +```` Response: @@ -369,39 +379,6 @@ Usage: AcknowledgeChallenge.provide('xrn:firebolt:capability:usergrant:acknowledgechallenge', provider: ChallengeProvider | object) ``` -#### challenge - -Registers as a provider for when the user should be challenged in order to confirm access to a capability - -```typescript -function challenge( - parameters?: Challenge, - session?: FocusableProviderSession, -): Promise -``` - -Provider methods always have two arguments: - -| Param | Type | Required | Summary | -| ------------ | -------------------------- | -------- | ------- | -| `parameters` | `Challenge` | false | | -| `session` | `FocusableProviderSession` | false | | - -| Parameters Property | Type | Required | Summary | -| ------------------- | ------------------------------------------- | -------- | ------------------------------------------------------------- | -| `capability` | `string` | true | The capability that is being requested by the user to approve | -| `requestor` | [`ChallengeRequestor`](#challengerequestor) | true | | - -```typescript -type Challenge = object -``` - -Promise resolution: - -| Property | Type | Description | -| --------- | ------- | ----------- | --- | -| `granted` | boolean | void | | - #### Examples **Register your app to provide the `xrn:firebolt:capability:usergrant:acknowledgechallenge` capability.** @@ -460,7 +437,7 @@ Event Response: { "id": 1, "result": { - "correlationId": "abc", + "correlationId": undefined, "parameters": { "capability": "xrn:firebolt:capability:localization::postal-code", "requestor": { @@ -481,7 +458,7 @@ Request: "id": 2, "method": "AcknowledgeChallenge.challengeResponse", "params": { - "correlationId": "abc", + "correlationId": undefined, "result": { "granted": true } @@ -504,52 +481,64 @@ Response: ### GrantResult +````typescript ```typescript -type GrantResult = { - granted: boolean | void -} -``` + +```` + +```` + + --- ### ChallengeRequestor + + ```typescript -type ChallengeRequestor = { - id: string // The id of the app that requested the challenge - name: string // The name of the app that requested the challenge -} -``` +```typescript + +```` + +```` + + --- ### Challenge + + +```typescript ```typescript -type Challenge = { - capability: string // The capability that is being requested by the user to approve - requestor: ChallengeRequestor -} -``` + +```` + +```` See also: -[ChallengeRequestor](#challengerequestor) + --- ### ChallengeProviderRequest + + ```typescript -type ChallengeProviderRequest = { - parameters: Challenge - correlationId: string // The id that was passed in to the event that triggered a provider method to be called -} +```typescript + +```` + ``` See also: -[ProviderRequest](../Types/schemas/#ProviderRequest) -[Challenge](#challenge-1) + + --- +``` diff --git a/apis/next/manage/Advertising/index.md b/apis/next/manage/Advertising/index.md index 382c187ef..725d591a2 100644 --- a/apis/next/manage/Advertising/index.md +++ b/apis/next/manage/Advertising/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Advertising 1.1.1-next.2 +Version Advertising 1.2.0-next.1 ## Table of Contents @@ -24,6 +24,7 @@ Version Advertising 1.1.1-next.2 - [skipRestriction](#skiprestriction) - [Events](#events) - [skipRestrictionChanged](#skiprestrictionchanged) +- [Types](#types) ## Usage @@ -154,7 +155,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Resets a user's identifier in the ad platform so that the advertising id that apps get will be a new value ```typescript -function resetIdentifier(): Promise +${method.signature} ``` Promise resolution: @@ -222,12 +223,22 @@ Set the value for AdPolicy.skipRestriction To get the value of `skipRestriction` call the method like this: ```typescript -function skipRestriction(): Promise +${method.signature} ``` Promise resolution: -[SkipRestriction](../Advertising/schemas/#SkipRestriction) +```typescript +SkipRestriction Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| ADS_UNWATCHED | adsUnwatched | +| ADS_ALL | adsAll | +| ALL | all | + +``` Capabilities: @@ -326,19 +337,20 @@ Response: To set the value of `skipRestriction` call the method like this: ```typescript -function skipRestriction(value: SkipRestriction): Promise +function skipRestriction(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | -| `value` | [`SkipRestriction`](../Advertising/schemas/#SkipRestriction) | true |
values: `'none' \| 'adsUnwatched' \| 'adsAll' \| 'all'` | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------------------------- | +| `value` | `` | true | values: `'none' \| 'adsUnwatched' \| 'adsAll' \| 'all'` | Promise resolution: ```typescript -null + ``` #### Examples @@ -436,7 +448,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function skipRestriction(callback: (value) => SkipRestriction): Promise +function skipRestriction(callback: (value) => ): Promise ``` Promise resolution: @@ -546,3 +558,5 @@ Response: ### skipRestrictionChanged See: [skipRestriction](#skiprestriction) + +## Types diff --git a/apis/next/manage/Advertising/schemas/index.md b/apis/next/manage/Advertising/schemas/index.md index 43986460f..37636ea10 100644 --- a/apis/next/manage/Advertising/schemas/index.md +++ b/apis/next/manage/Advertising/schemas/index.md @@ -41,12 +41,15 @@ Applies to fast-forward/rewind (e.g. trick mode), seeking over an entire opportu Namespace: `xrn:advertising:policy:skipRestriction:` ```typescript -enum SkipRestriction { - NONE = 'none', - ADS_UNWATCHED = 'adsUnwatched', - ADS_ALL = 'adsAll', - ALL = 'all', -} +SkipRestriction Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| ADS_UNWATCHED | adsUnwatched | +| ADS_ALL | adsAll | +| ALL | all | + ``` --- diff --git a/apis/next/manage/AudioDescriptions/index.md b/apis/next/manage/AudioDescriptions/index.md index b666ead50..5f8a378ec 100644 --- a/apis/next/manage/AudioDescriptions/index.md +++ b/apis/next/manage/AudioDescriptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version AudioDescriptions 1.1.1-next.2 +Version AudioDescriptions 1.2.0-next.1 ## Table of Contents @@ -23,6 +23,7 @@ Version AudioDescriptions 1.1.1-next.2 - [once](#once) - [Events](#events) - [enabledChanged](#enabledchanged) +- [Types](#types) ## Usage @@ -45,7 +46,7 @@ Whether or not audio-descriptions are enabled. To get the value of `enabled` call the method like this: ```typescript -function enabled(): Promise +${method.signature} ``` Promise resolution: @@ -151,7 +152,8 @@ Response: To set the value of `enabled` call the method like this: ```typescript -function enabled(value: boolean): Promise +function enabled(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -163,7 +165,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -481,3 +483,5 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio ### enabledChanged See: [enabled](#enabled) + +## Types diff --git a/apis/next/manage/Capabilities/schemas/index.md b/apis/next/manage/Capabilities/schemas/index.md index 76afb6da9..0a2db5bb4 100644 --- a/apis/next/manage/Capabilities/schemas/index.md +++ b/apis/next/manage/Capabilities/schemas/index.md @@ -35,11 +35,14 @@ undefined Role provides access level for the app for a given capability. ```typescript -enum Role { - USE = 'use', - MANAGE = 'manage', - PROVIDE = 'provide', -} +Role Enumeration: + +| key | value | +|-----|-------| +| USE | use | +| MANAGE | manage | +| PROVIDE | provide | + ``` --- @@ -49,14 +52,17 @@ enum Role { Reasons why a Capability might not be invokable ```typescript -enum DenyReason { - UNPERMITTED = 'unpermitted', - UNSUPPORTED = 'unsupported', - DISABLED = 'disabled', - UNAVAILABLE = 'unavailable', - GRANT_DENIED = 'grantDenied', - UNGRANTED = 'ungranted', -} +DenyReason Enumeration: + +| key | value | +|-----|-------| +| UNPERMITTED | unpermitted | +| UNSUPPORTED | unsupported | +| DISABLED | disabled | +| UNAVAILABLE | unavailable | +| GRANT_DENIED | grantDenied | +| UNGRANTED | ungranted | + ``` --- @@ -66,7 +72,7 @@ enum DenyReason { A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. ```typescript -type Capability = string + ``` --- @@ -74,41 +80,24 @@ type Capability = string ### CapPermissionStatus ```typescript -type CapPermissionStatus = { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void -} + ``` --- ### CapabilityInfo +````typescript ```typescript -type CapabilityInfo = { - capability?: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. - supported: boolean // Provides info whether the capability is supported - available: boolean // Provides info whether the capability is available - use: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - manage: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - provide: { - permitted?: boolean // Provides info whether the capability is permitted - granted?: boolean | void - } - details?: DenyReason[] -} -``` + +```` + +```` See also: -string -'unpermitted' | 'unsupported' | 'disabled' | 'unavailable' | 'grantDenied' | 'ungranted' + + --- @@ -117,15 +106,16 @@ string A capability combined with a Role, which an app may be permitted (by a distributor) or granted (by an end user). ```typescript -type Permission = { - role?: Role // Role provides access level for the app for a given capability. - capability: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. -} +```typescript + +```` + ``` See also: -'use' | 'manage' | 'provide' -string + + --- +``` diff --git a/apis/next/manage/ClosedCaptions/index.md b/apis/next/manage/ClosedCaptions/index.md index 6d913aba2..01f241a0b 100644 --- a/apis/next/manage/ClosedCaptions/index.md +++ b/apis/next/manage/ClosedCaptions/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version ClosedCaptions 1.1.1-next.2 +Version ClosedCaptions 1.2.0-next.1 ## Table of Contents @@ -49,6 +49,7 @@ Version ClosedCaptions 1.1.1-next.2 - [textAlignVerticalChanged](#textalignverticalchanged) - [windowColorChanged](#windowcolorchanged) - [windowOpacityChanged](#windowopacitychanged) +- [Types](#types) ## Usage @@ -71,13 +72,13 @@ The preferred background color for displaying closed-captions, . To get the value of `backgroundColor` call the method like this: ```typescript -function backgroundColor(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Color = string + ``` Capabilities: @@ -219,19 +220,20 @@ Response: To set the value of `backgroundColor` call the method like this: ```typescript -function backgroundColor(value: string): Promise +function backgroundColor(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -373,7 +375,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function backgroundColor(callback: (value) => string): Promise +function backgroundColor(callback: (value) => ): Promise ``` Promise resolution: @@ -531,13 +533,13 @@ The preferred opacity for displaying closed-captions backgrounds. To get the value of `backgroundOpacity` call the method like this: ```typescript -function backgroundOpacity(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Opacity = number + ``` Capabilities: @@ -679,19 +681,20 @@ Response: To set the value of `backgroundOpacity` call the method like this: ```typescript -function backgroundOpacity(value: number): Promise +function backgroundOpacity(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `number` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -833,7 +836,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function backgroundOpacity(callback: (value) => number): Promise +function backgroundOpacity(callback: (value) => ): Promise ``` Promise resolution: @@ -991,7 +994,7 @@ Whether or not closed-captions are enabled. To get the value of `enabled` call the method like this: ```typescript -function enabled(): Promise +${method.signature} ``` Promise resolution: @@ -1097,7 +1100,8 @@ Response: To set the value of `enabled` call the method like this: ```typescript -function enabled(value: boolean): Promise +function enabled(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1109,7 +1113,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1319,13 +1323,13 @@ The preferred font color for displaying closed-captions. To get the value of `fontColor` call the method like this: ```typescript -function fontColor(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Color = string + ``` Capabilities: @@ -1467,19 +1471,20 @@ Response: To set the value of `fontColor` call the method like this: ```typescript -function fontColor(value: string): Promise +function fontColor(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -1621,7 +1626,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontColor(callback: (value) => string): Promise +function fontColor(callback: (value) => ): Promise ``` Promise resolution: @@ -1779,13 +1784,23 @@ The preferred font edge style for displaying closed-captions. To get the value of `fontEdge` call the method like this: ```typescript -function fontEdge(): Promise +${method.signature} ``` Promise resolution: ```typescript -type FontEdge = string +FontEdge Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| RAISED | raised | +| DEPRESSED | depressed | +| UNIFORM | uniform | +| DROP_SHADOW_LEFT | drop_shadow_left | +| DROP_SHADOW_RIGHT | drop_shadow_right | + ``` Capabilities: @@ -1927,19 +1942,20 @@ Response: To set the value of `fontEdge` call the method like this: ```typescript -function fontEdge(value: string): Promise +function fontEdge(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -2081,7 +2097,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontEdge(callback: (value) => string): Promise +function fontEdge(callback: (value) => ): Promise ``` Promise resolution: @@ -2239,13 +2255,13 @@ The preferred font edge color for displaying closed-captions. To get the value of `fontEdgeColor` call the method like this: ```typescript -function fontEdgeColor(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Color = string + ``` Capabilities: @@ -2387,19 +2403,20 @@ Response: To set the value of `fontEdgeColor` call the method like this: ```typescript -function fontEdgeColor(value: string): Promise +function fontEdgeColor(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -2541,7 +2558,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontEdgeColor(callback: (value) => string): Promise +function fontEdgeColor(callback: (value) => ): Promise ``` Promise resolution: @@ -2699,13 +2716,24 @@ The preferred font family for displaying closed-captions. To get the value of `fontFamily` call the method like this: ```typescript -function fontFamily(): Promise +${method.signature} ``` Promise resolution: ```typescript -type FontFamily = string +FontFamily Enumeration: + +| key | value | +|-----|-------| +| MONOSPACED_SERIF | monospaced_serif | +| PROPORTIONAL_SERIF | proportional_serif | +| MONOSPACED_SANSERIF | monospaced_sanserif | +| PROPORTIONAL_SANSERIF | proportional_sanserif | +| SMALLCAPS | smallcaps | +| CURSIVE | cursive | +| CASUAL | casual | + ``` Capabilities: @@ -2847,19 +2875,20 @@ Response: To set the value of `fontFamily` call the method like this: ```typescript -function fontFamily(value: string): Promise +function fontFamily(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -3001,7 +3030,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontFamily(callback: (value) => string): Promise +function fontFamily(callback: (value) => ): Promise ``` Promise resolution: @@ -3159,13 +3188,13 @@ The preferred opacity for displaying closed-captions characters. To get the value of `fontOpacity` call the method like this: ```typescript -function fontOpacity(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Opacity = number + ``` Capabilities: @@ -3307,19 +3336,20 @@ Response: To set the value of `fontOpacity` call the method like this: ```typescript -function fontOpacity(value: number): Promise +function fontOpacity(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `number` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -3461,7 +3491,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontOpacity(callback: (value) => number): Promise +function fontOpacity(callback: (value) => ): Promise ``` Promise resolution: @@ -3619,13 +3649,13 @@ The preferred font size for displaying closed-captions. To get the value of `fontSize` call the method like this: ```typescript -function fontSize(): Promise +${method.signature} ``` Promise resolution: ```typescript -type FontSize = number + ``` Capabilities: @@ -3767,19 +3797,20 @@ Response: To set the value of `fontSize` call the method like this: ```typescript -function fontSize(value: number): Promise +function fontSize(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `number` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -3921,7 +3952,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function fontSize(callback: (value) => number): Promise +function fontSize(callback: (value) => ): Promise ``` Promise resolution: @@ -4189,13 +4220,13 @@ A prioritized list of ISO 639-2/B codes for the preferred closed captions langua To get the value of `preferredLanguages` call the method like this: ```typescript -function preferredLanguages(): Promise +${method.signature} ``` Promise resolution: ```typescript -string[] + ``` Capabilities: @@ -4295,19 +4326,20 @@ Response: To set the value of `preferredLanguages` call the method like this: ```typescript -function preferredLanguages(value: string[]): Promise +function preferredLanguages(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | ---------- | -------- | ---------------------------------------------------------------- | -| `value` | `string[]` | true | the preferred closed captions languages
pattern: ^[a-z]{3}$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------------------------------------------------------- | +| `value` | `` | true | the preferred closed captions languages pattern: ^[a-z]{3}$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -4405,7 +4437,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function preferredLanguages(callback: (value) => string[]): Promise +function preferredLanguages(callback: (value) => ): Promise ``` Promise resolution: @@ -4517,13 +4549,13 @@ The preferred horizontal alignment for displaying closed-captions characters. To get the value of `textAlign` call the method like this: ```typescript -function textAlign(): Promise +${method.signature} ``` Promise resolution: ```typescript -type HorizontalAlignment = string + ``` Capabilities: @@ -4665,19 +4697,20 @@ Response: To set the value of `textAlign` call the method like this: ```typescript -function textAlign(value: string): Promise +function textAlign(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -4819,7 +4852,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function textAlign(callback: (value) => string): Promise +function textAlign(callback: (value) => ): Promise ``` Promise resolution: @@ -4977,13 +5010,13 @@ The preferred horizontal alignment for displaying closed-captions characters. To get the value of `textAlignVertical` call the method like this: ```typescript -function textAlignVertical(): Promise +${method.signature} ``` Promise resolution: ```typescript -type VerticalAlignment = string + ``` Capabilities: @@ -5125,19 +5158,20 @@ Response: To set the value of `textAlignVertical` call the method like this: ```typescript -function textAlignVertical(value: string): Promise +function textAlignVertical(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -5279,7 +5313,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function textAlignVertical(callback: (value) => string): Promise +function textAlignVertical(callback: (value) => ): Promise ``` Promise resolution: @@ -5437,13 +5471,13 @@ The preferred window color for displaying closed-captions, . To get the value of `windowColor` call the method like this: ```typescript -function windowColor(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Color = string + ``` Capabilities: @@ -5585,19 +5619,20 @@ Response: To set the value of `windowColor` call the method like this: ```typescript -function windowColor(value: string): Promise +function windowColor(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `string` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -5739,7 +5774,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function windowColor(callback: (value) => string): Promise +function windowColor(callback: (value) => ): Promise ``` Promise resolution: @@ -5897,13 +5932,13 @@ The preferred window opacity for displaying closed-captions backgrounds. To get the value of `windowOpacity` call the method like this: ```typescript -function windowOpacity(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Opacity = number + ``` Capabilities: @@ -6045,19 +6080,20 @@ Response: To set the value of `windowOpacity` call the method like this: ```typescript -function windowOpacity(value: number): Promise +function windowOpacity(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `value` | `number` | true | | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ----------- | +| `value` | `` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -6199,7 +6235,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function windowOpacity(callback: (value) => number): Promise +function windowOpacity(callback: (value) => ): Promise ``` Promise resolution: @@ -6407,3 +6443,5 @@ See: [windowColor](#windowcolor) ### windowOpacityChanged See: [windowOpacity](#windowopacity) + +## Types diff --git a/apis/next/manage/Device/index.md b/apis/next/manage/Device/index.md index 6df0d75e9..2d22aee03 100644 --- a/apis/next/manage/Device/index.md +++ b/apis/next/manage/Device/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Device 1.1.1-next.2 +Version Device 1.2.0-next.1 ## Table of Contents @@ -25,6 +25,7 @@ Version Device 1.1.1-next.2 - [Events](#events) - [deviceNameChanged](#devicenamechanged) - [nameChanged](#namechanged) +- [Types](#types) ## Usage @@ -101,7 +102,7 @@ The human readable name of the device To get the value of `name` call the method like this: ```typescript -function name(): Promise +${method.signature} ``` Promise resolution: @@ -207,7 +208,8 @@ Response: To set the value of `name` call the method like this: ```typescript -function name(value: string): Promise +function name(| `value` | [`string`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -219,7 +221,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -483,11 +485,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Used by a distributor to push provision info to firebolt. ```typescript -function provision( - accountId: string, - deviceId: string, - distributorId?: string, -): Promise +${method.signature} ``` Parameters: @@ -614,7 +612,7 @@ Response: ### deviceNameChanged ```typescript -function listen('deviceNameChanged', (string) => void): Promise +function listen('deviceNameChanged', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). @@ -683,3 +681,5 @@ Response: ### nameChanged See: [name](#name) + +## Types diff --git a/apis/next/manage/Discovery/index.md b/apis/next/manage/Discovery/index.md index b1ca98333..e5ec4a779 100644 --- a/apis/next/manage/Discovery/index.md +++ b/apis/next/manage/Discovery/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Discovery 1.1.1-next.2 +Version Discovery 1.2.0-next.1 ## Table of Contents @@ -24,6 +24,7 @@ Version Discovery 1.1.1-next.2 - [Events](#events) - [signIn](#signin) - [signOut](#signout) +- [Types](#types) ## Usage @@ -166,7 +167,7 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio ### signIn ```typescript -function listen('signIn', (object) => void): Promise +function listen('signIn', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). @@ -239,7 +240,7 @@ Response: ### signOut ```typescript -function listen('signOut', (object) => void): Promise +function listen('signOut', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). @@ -308,3 +309,5 @@ Response: --- + +## Types diff --git a/apis/next/manage/Discovery/schemas/index.md b/apis/next/manage/Discovery/schemas/index.md index 215c2f047..e8aafdc24 100644 --- a/apis/next/manage/Discovery/schemas/index.md +++ b/apis/next/manage/Discovery/schemas/index.md @@ -30,32 +30,33 @@ undefined The result for an `entityInfo()` push or pull. +````typescript ```typescript -type EntityInfoResult = { - expires: string - entity: EntityInfo // An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. - related?: EntityInfo[] -} -``` + +```` + +```` See also: -[EntityInfo](../Entertainment/schemas/#EntityInfo) + --- ### PurchasedContentResult + + ```typescript -type PurchasedContentResult = { - expires: string - totalCount: number - entries: EntityInfo[] -} +```typescript + +```` + ``` See also: -[EntityInfo](../Entertainment/schemas/#EntityInfo) + --- +``` diff --git a/apis/next/manage/Entertainment/schemas/index.md b/apis/next/manage/Entertainment/schemas/index.md index 5f032fae4..71b5a0b7f 100644 --- a/apis/next/manage/Entertainment/schemas/index.md +++ b/apis/next/manage/Entertainment/schemas/index.md @@ -39,12 +39,15 @@ undefined The offering type of the WayToWatch. ```typescript -enum OfferingType { - FREE = 'free', - SUBSCRIBE = 'subscribe', - BUY = 'buy', - RENT = 'rent', -} +OfferingType Enumeration: + +| key | value | +|-----|-------| +| FREE | free | +| SUBSCRIBE | subscribe | +| BUY | buy | +| RENT | rent | + ``` --- @@ -54,20 +57,23 @@ enum OfferingType { In the case of a program `entityType`, specifies the program type. ```typescript -enum ProgramType { - MOVIE = 'movie', - EPISODE = 'episode', - SEASON = 'season', - SERIES = 'series', - OTHER = 'other', - PREVIEW = 'preview', - EXTRA = 'extra', - CONCERT = 'concert', - SPORTING_EVENT = 'sportingEvent', - ADVERTISEMENT = 'advertisement', - MUSIC_VIDEO = 'musicVideo', - MINISODE = 'minisode', -} +ProgramType Enumeration: + +| key | value | +|-----|-------| +| MOVIE | movie | +| EPISODE | episode | +| SEASON | season | +| SERIES | series | +| OTHER | other | +| PREVIEW | preview | +| EXTRA | extra | +| CONCERT | concert | +| SPORTING_EVENT | sportingEvent | +| ADVERTISEMENT | advertisement | +| MUSIC_VIDEO | musicVideo | +| MINISODE | minisode | + ``` --- @@ -77,10 +83,13 @@ enum ProgramType { In the case of a music `entityType`, specifies the type of music entity. ```typescript -enum MusicType { - SONG = 'song', - ALBUM = 'album', -} +MusicType Enumeration: + +| key | value | +|-----|-------| +| SONG | song | +| ALBUM | album | + ``` --- @@ -95,27 +104,29 @@ Apps do not need to provide all ids. They only need to provide the minimum required to target a playable stream or an entity detail screen via a deep link. If an id isn't needed to get to those pages, it doesn't need to be included. +````typescript ```typescript -type ContentIdentifiers = { - assetId?: string // Identifies a particular playable asset. For example, the HD version of a particular movie separate from the UHD version. - entityId?: string // Identifies an entity, such as a Movie, TV Series or TV Episode. - seasonId?: string // The TV Season for a TV Episode. - seriesId?: string // The TV Series for a TV Episode or TV Season. - appContentData?: string // App-specific content identifiers. -} -``` + +```` + +```` + + --- ### Entitlement + + ```typescript -type Entitlement = { - entitlementId: string - startTime?: string - endTime?: string -} -``` +```typescript + +```` + +```` + + --- @@ -157,19 +168,15 @@ Ratings: `G`, `8+`, `13+`, `16+`, `18+` Ratings: `G`, `8+`, `13+`, `16+`, `18+` + +```typescript ```typescript -type ContentRating = { - scheme: - | 'CA-Movie' - | 'CA-TV' - | 'CA-Movie-Fr' - | 'CA-TV-Fr' - | 'US-Movie' - | 'US-TV' // The rating scheme. - rating: string // The content rating. - advisories?: string[] // Optional list of subratings or content advisories. -} -``` + +```` + +```` + + --- @@ -211,28 +218,17 @@ multiple WayToWatch objects. points, the `price` provided must be the lowest available price. ```typescript -type WayToWatch = { - identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to - expires?: string // Time when the WayToWatch is no longer available. - entitled?: boolean // Specify if the user is entitled to watch the entity. - entitledExpires?: string // Time when the entity is no longer entitled. - offeringType?: OfferingType // The offering type of the WayToWatch. - hasAds?: boolean // True if the streamable asset contains ads. - price?: number // For "buy" and "rent" WayToWatch, the price to buy or rent in the user's preferred currency. - videoQuality?: 'SD' | 'HD' | 'UHD'[] // List of the video qualities available via the WayToWatch. - audioProfile: AudioProfile[] // List of the audio types available via the WayToWatch. - audioLanguages?: string[] // List of audio track languages available on the WayToWatch. The first is considered the primary language. Languages are expressed as ISO 639 1/2 codes. - closedCaptions?: string[] // List of languages for which closed captions are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. - subtitles?: string[] // List of languages for which subtitles are available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. - audioDescriptions?: string[] // List of languages for which audio descriptions (DVD) as available on the WayToWatch. Languages are expressed as ISO 639 1/2 codes. -} -``` +```typescript + +```` + +```` See also: -[ContentIdentifiers](#contentidentifiers) -'free' | 'subscribe' | 'buy' | 'rent' -'stereo' | 'dolbyDigital5.1' | 'dolbyDigital7.1' | 'dolbyDigital5.1+' | 'dolbyDigital7.1+' | 'dolbyAtmos' + + + --- @@ -241,7 +237,7 @@ See also: An EntityInfo object represents an "entity" on the platform. Currently, only entities of type `program` are supported. `programType` must be supplied to identify the program type. Additionally, EntityInfo objects must specify a properly formed -ContentIdentifiers object, `entityType`, and `title`. The app should provide +ContentIdentifiers object, `entityType`, and `title`. The app should provide the `synopsis` property for a good user experience if the content metadata is not available another way. @@ -254,29 +250,19 @@ It is optional for the `purchasedContent` method, but recommended because the UI may use those data. ```typescript -type EntityInfo = { - identifiers: ContentIdentifiers // The ContentIdentifiers object is how the app identifies an entity or asset to - title: string // Title of the entity. - entityType: 'program' | 'music' // The type of the entity, e.g. `program` or `music`. - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - musicType?: MusicType // In the case of a music `entityType`, specifies the type of music entity. - synopsis?: string // Short description of the entity. - seasonNumber?: number // For TV seasons, the season number. For TV episodes, the season that the episode belongs to. - seasonCount?: number // For TV series, seasons, and episodes, the total number of seasons. - episodeNumber?: number // For TV episodes, the episode number. - episodeCount?: number // For TV seasons and episodes, the total number of episodes in the current season. - releaseDate?: string // The date that the program or entity was released or first aired. - contentRatings?: ContentRating[] // A list of ContentRating objects, describing the entity's ratings in various rating schemes. - waysToWatch?: WayToWatch[] // An array of ways a user is might watch this entity, regardless of entitlements. -} +```typescript + +```` + ``` See also: -[ContentIdentifiers](#contentidentifiers) -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' -'song' | 'album' -[ContentRating](#contentrating) -[WayToWatch](#waytowatch) + + + + + --- +``` diff --git a/apis/next/manage/HDMIInput/index.md b/apis/next/manage/HDMIInput/index.md index 5c2dd311c..61fd6a8ec 100644 --- a/apis/next/manage/HDMIInput/index.md +++ b/apis/next/manage/HDMIInput/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version HDMIInput 1.1.1-next.2 +Version HDMIInput 1.2.0-next.1 ## Table of Contents @@ -36,13 +36,13 @@ Version HDMIInput 1.1.1-next.2 - [signalChanged](#signalchanged) - [Types](#types) - [EDIDVersion](#edidversion-1) - - [HDMIPortId](#hdmiportid) - - [ConnectionChangedInfo](#connectionchangedinfo) - [HDMISignalStatus](#hdmisignalstatus) + - [HDMIPortId](#hdmiportid) + - [SignalChangedInfo](#signalchangedinfo) - [AutoLowLatencyModeSignalChangedInfo](#autolowlatencymodesignalchangedinfo) - [HDMIInputPort](#hdmiinputport) - [AutoLowLatencyModeCapableChangedInfo](#autolowlatencymodecapablechangedinfo) - - [SignalChangedInfo](#signalchangedinfo) + - [ConnectionChangedInfo](#connectionchangedinfo) ## Usage @@ -65,14 +65,14 @@ Property for each port auto low latency mode setting. To get the value of `autoLowLatencyModeCapable` call the method like this: ```typescript -function autoLowLatencyModeCapable(port: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------ | -------- | -------- | -------------------------- | -| `port` | `string` | true |
pattern: ^HDMI[0-9]+$ | +| Param | Type | Required | Description | +| ------ | ---- | -------- | --------------------- | +| `port` | `` | true | pattern: ^HDMI[0-9]+$ | Promise resolution: @@ -181,20 +181,22 @@ Response: To set the value of `autoLowLatencyModeCapable` call the method like this: ```typescript -function autoLowLatencyModeCapable(port: string, value: boolean): Promise +function autoLowLatencyModeCapable(| `port` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, | `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | --------- | -------- | -------------------------- | -| `port` | `string` | true |
pattern: ^HDMI[0-9]+$ | -| `value` | `boolean` | true | | +| Param | Type | Required | Description | +| ------- | --------- | -------- | --------------------- | +| `port` | `` | true | pattern: ^HDMI[0-9]+$ | +| `value` | `boolean` | true | | Promise resolution: ```typescript -null + ``` #### Examples @@ -294,9 +296,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function autoLowLatencyModeCapable( - callback: (value) => AutoLowLatencyModeCapableChangedInfo, -): Promise +function autoLowLatencyModeCapable(callback: (value) => ): Promise ``` Promise resolution: @@ -418,7 +418,7 @@ Response: Closes the given HDMI Port if it is the current active source for HDMI Input. If there was no active source, then there would no action taken on the device. ```typescript -function close(): Promise +${method.signature} ``` Promise resolution: @@ -486,18 +486,27 @@ Property for each port's active EDID version. To get the value of `edidVersion` call the method like this: ```typescript -function edidVersion(port: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------ | -------- | -------- | -------------------------- | -| `port` | `string` | true |
pattern: ^HDMI[0-9]+$ | +| Param | Type | Required | Description | +| ------ | ---- | -------- | --------------------- | +| `port` | `` | true | pattern: ^HDMI[0-9]+$ | Promise resolution: -[EDIDVersion](#edidversion-1) +```typescript +EDIDVersion Enumeration: + +| key | value | +|-----|-------| +| V1_4 | 1.4 | +| V2_0 | 2.0 | +| UNKNOWN | unknown | + +``` Capabilities: @@ -600,20 +609,22 @@ Response: To set the value of `edidVersion` call the method like this: ```typescript -function edidVersion(port: string, value: EDIDVersion): Promise +function edidVersion(| `port` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, | `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | ------------------------------------------ | -| `port` | `string` | true |
pattern: ^HDMI[0-9]+$ | -| `value` | [`EDIDVersion`](#edidversion-1) | true |
values: `'1.4' \| '2.0' \| 'unknown'` | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------- | +| `port` | `` | true | pattern: ^HDMI[0-9]+$ | +| `value` | `` | true | values: `'1.4' \| '2.0' \| 'unknown'` | Promise resolution: ```typescript -null + ``` #### Examples @@ -713,17 +724,15 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function edidVersion( - port: string, - callback: (value) => EDIDVersion, -): Promise +function edidVersion(| `port` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +, callback: (value) => ): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------ | -------- | -------- | -------------------------- | -| `port` | `string` | true |
pattern: ^HDMI[0-9]+$ | +| Param | Type | Required | Description | +| ------ | ---- | -------- | --------------------- | +| `port` | `` | true | pattern: ^HDMI[0-9]+$ | Promise resolution: @@ -890,7 +899,7 @@ Property for the low latency mode setting. To get the value of `lowLatencyMode` call the method like this: ```typescript -function lowLatencyMode(): Promise +${method.signature} ``` Promise resolution: @@ -996,7 +1005,8 @@ Response: To set the value of `lowLatencyMode` call the method like this: ```typescript -function lowLatencyMode(value: boolean): Promise +function lowLatencyMode(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1008,7 +1018,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1272,14 +1282,14 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Opens the HDMI Port allowing it to be the active source device. Incase there is a different HDMI portId already set as the active source, this call would stop the older portId before opening the given portId. ```typescript -function open(portId: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | -------- | -------- | -------------------------- | -| `portId` | `string` | true |
pattern: ^HDMI[0-9]+$ | +| Param | Type | Required | Description | +| -------- | ---- | -------- | --------------------- | +| `portId` | `` | true | pattern: ^HDMI[0-9]+$ | Promise resolution: @@ -1346,27 +1356,34 @@ Response: Retrieve a specific HDMI input port. ```typescript -function port(portId: string): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | -------- | -------- | -------------------------- | -| `portId` | `string` | true |
pattern: ^HDMI[0-9]+$ | +| Param | Type | Required | Description | +| -------- | ---- | -------- | --------------------- | +| `portId` | `` | true | pattern: ^HDMI[0-9]+$ | Promise resolution: -[HDMIInputPort](#hdmiinputport) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:inputs:hdmi | + #### Examples + Default Example JavaScript: @@ -1374,9 +1391,9 @@ JavaScript: ```javascript import { HDMIInput } from '@firebolt-js/manage-sdk' -let port = await HDMIInput.port('HDMI1') +let port = await HDMIInput.port("HDMI1") console.log(port) -``` +```` Value of `port`: @@ -1436,13 +1453,13 @@ Response: Retrieve a list of HDMI input ports. ```typescript -function ports(): Promise +${method.signature} ``` Promise resolution: ```typescript -HDMIInputPort[] + ``` Capabilities: @@ -1528,23 +1545,30 @@ See: [autoLowLatencyModeCapable](#autolowlatencymodecapable) ### autoLowLatencyModeSignalChanged ```typescript -function listen('autoLowLatencyModeSignalChanged', (AutoLowLatencyModeSignalChangedInfo) => void): Promise +function listen('autoLowLatencyModeSignalChanged', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[AutoLowLatencyModeSignalChangedInfo](#autolowlatencymodesignalchangedinfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:inputs:hdmi | + #### Examples + Default Example JavaScript: @@ -1552,10 +1576,10 @@ JavaScript: ```javascript import { HDMIInput } from '@firebolt-js/manage-sdk' -HDMIInput.listen('autoLowLatencyModeSignalChanged', (info) => { +HDMIInput.listen('autoLowLatencyModeSignalChanged', info => { console.log(info) }) -``` +```` Value of `info`: @@ -1601,23 +1625,30 @@ Response: ### connectionChanged ```typescript -function listen('connectionChanged', (ConnectionChangedInfo) => void): Promise +function listen('connectionChanged', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[ConnectionChangedInfo](#connectionchangedinfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:inputs:hdmi | + #### Examples + Default Example JavaScript: @@ -1625,10 +1656,10 @@ JavaScript: ```javascript import { HDMIInput } from '@firebolt-js/manage-sdk' -HDMIInput.listen('connectionChanged', (info) => { +HDMIInput.listen('connectionChanged', info => { console.log(info) }) -``` +```` Value of `info`: @@ -1682,23 +1713,30 @@ See: [lowLatencyMode](#lowlatencymode) ### signalChanged ```typescript -function listen('signalChanged', (SignalChangedInfo) => void): Promise +function listen('signalChanged', () => void): Promise ``` See also: [listen()](#listen), [once()](#listen), [clear()](#listen). Event value: -[SignalChangedInfo](#signalchangedinfo) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ----------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:inputs:hdmi | + #### Examples + Default Example JavaScript: @@ -1706,10 +1744,10 @@ JavaScript: ```javascript import { HDMIInput } from '@firebolt-js/manage-sdk' -HDMIInput.listen('signalChanged', (info) => { +HDMIInput.listen('signalChanged', info => { console.log(info) }) -``` +```` Value of `info`: @@ -1757,98 +1795,126 @@ Response: ### EDIDVersion ```typescript -enum EDIDVersion { - V1_4 = '1.4', - V2_0 = '2.0', - UNKNOWN = 'unknown', -} +EDIDVersion Enumeration: + +| key | value | +|-----|-------| +| V1_4 | 1.4 | +| V2_0 | 2.0 | +| UNKNOWN | unknown | + ``` --- -### HDMIPortId +### HDMISignalStatus ```typescript -type HDMIPortId = string +HDMISignalStatus Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| STABLE | stable | +| UNSTABLE | unstable | +| UNSUPPORTED | unsupported | +| UNKNOWN | unknown | + ``` --- -### ConnectionChangedInfo +### HDMIPortId ```typescript -type ConnectionChangedInfo = { - port?: string - connected?: boolean -} + ``` --- -### HDMISignalStatus +### SignalChangedInfo +````typescript ```typescript -enum HDMISignalStatus { - NONE = 'none', - STABLE = 'stable', - UNSTABLE = 'unstable', - UNSUPPORTED = 'unsupported', - UNKNOWN = 'unknown', -} -``` + +```` + +```` + +See also: + + + --- ### AutoLowLatencyModeSignalChangedInfo + + ```typescript -type AutoLowLatencyModeSignalChangedInfo = { - port?: string - autoLowLatencyModeSignalled?: boolean -} -``` +```typescript + +```` + +```` + +See also: + + --- ### HDMIInputPort + + +```typescript ```typescript -type HDMIInputPort = { - port: string - connected: boolean - signal: 'none' | 'stable' | 'unstable' | 'unsupported' | 'unknown' - arcCapable: boolean - arcConnected: boolean - edidVersion: EDIDVersion - autoLowLatencyModeCapable: boolean - autoLowLatencyModeSignalled: boolean -} -``` + +```` + +```` See also: -'1.4' | '2.0' | 'unknown' + + + --- ### AutoLowLatencyModeCapableChangedInfo + + ```typescript -type AutoLowLatencyModeCapableChangedInfo = { - port: string - enabled: boolean -} -``` +```typescript + +```` + +```` + +See also: + + --- -### SignalChangedInfo +### ConnectionChangedInfo + + ```typescript -type SignalChangedInfo = { - port: string - signal: 'none' | 'stable' | 'unstable' | 'unsupported' | 'unknown' -} +```typescript + +```` + ``` +See also: + + + --- +``` diff --git a/apis/next/manage/Intents/schemas/index.md b/apis/next/manage/Intents/schemas/index.md index a5bc5b103..9c52b6da3 100644 --- a/apis/next/manage/Intents/schemas/index.md +++ b/apis/next/manage/Intents/schemas/index.md @@ -53,12 +53,7 @@ undefined A Firebolt compliant representation of a user intention. ```typescript -type Intent = { - action: string - context: { - source: string - } -} + ``` --- @@ -66,36 +61,33 @@ type Intent = { ### IntentProperties ```typescript -type IntentProperties = { - action: any - data: any - context: any -} + ``` --- ### ProgramEntity +````typescript ```typescript -type ProgramEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - entityId: string -} -``` + +```` + +```` See also: -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' + --- ### Identifier + + ```typescript -type Identifier = string -``` + +```` --- @@ -103,17 +95,14 @@ type Identifier = string A Firebolt compliant representation of a user intention to navigate an app to it's search UI with a search term populated, and bring that app to the foreground if needed. +````typescript ```typescript -type SearchIntent = { - action: 'search' - data?: { - query: string - } - context: { - source: string - } -} -``` + +```` + +```` + + --- @@ -122,45 +111,45 @@ type SearchIntent = { A Firebolt compliant representation of a user intention to navigate an app to a section not covered by `home`, `entity`, `player`, or `search`, and bring that app to the foreground if needed. ```typescript -type SectionIntent = { - action: 'section' - data?: { - sectionName: string - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- ### ChannelEntity + + ```typescript -type ChannelEntity = { - entityType: 'channel' - channelType: 'streaming' | 'overTheAir' - entityId: string // ID of the channel, in the target App's scope. - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- ### MusicEntity + + ```typescript -type MusicEntity = { - entityType: 'music' - musicType: MusicType // In the case of a music `entityType`, specifies the type of music entity. - entityId: string -} -``` +```typescript + +```` + +```` See also: -'song' | 'album' + --- @@ -169,25 +158,16 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to a the video player for an abstract query to be searched for and played by the app. ```typescript -type PlayQueryIntent = { - action: 'play-query' - data: { - query: string - options?: { - programTypes?: ProgramType[] - musicTypes?: MusicType[] - } - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -'movie' | 'episode' | 'season' | 'series' | 'other' | 'preview' | 'extra' | 'concert' | 'sportingEvent' | 'advertisement' | 'musicVideo' | 'minisode' -'song' | 'album' + + --- @@ -196,13 +176,13 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to it's home screen, and bring that app to the foreground if needed. ```typescript -type HomeIntent = { - action: 'home' - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- @@ -211,31 +191,30 @@ type HomeIntent = { A Firebolt compliant representation of a user intention to launch an app. ```typescript -type LaunchIntent = { - action: 'launch' - context: { - source: string - } -} -``` +```typescript + +```` + +```` + + --- ### TVSeriesEntity + + ```typescript -type TVSeriesEntity = { - entityType: 'program' - programType: 'series' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- @@ -244,13 +223,13 @@ See also: A Firebolt compliant representation of a Playlist entity. ```typescript -type PlaylistEntity = { - entityType: 'playlist' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- @@ -259,87 +238,81 @@ type PlaylistEntity = { A Firebolt compliant representation of a TV Season entity. ```typescript -type TVSeasonEntity = { - entityType: 'program' - programType: 'season' - entityId: string - seriesId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### AdditionalEntity + + ```typescript -type AdditionalEntity = { - entityType: 'program' - programType: ProgramType // In the case of a program `entityType`, specifies the program type. - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### MovieEntity + + ```typescript -type MovieEntity = { - entityType: 'program' - programType: 'movie' - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### TVEpisodeEntity + + +```typescript ```typescript -type TVEpisodeEntity = { - entityType: 'program' - programType: 'episode' - entityId: string - seriesId: string - seasonId: string - assetId?: string - appContentData?: string -} -``` + +```` + +```` See also: -[ProgramEntity](#programentity) + --- ### UntypedEntity + + ```typescript -type UntypedEntity = { - entityId: string - assetId?: string - appContentData?: string -} -``` +```typescript + +```` + +```` + + --- @@ -348,54 +321,34 @@ type UntypedEntity = { A Firebolt compliant representation of a user intention to navigate an app to a specific entity page, and bring that app to the foreground if needed. ```typescript -type EntityIntent = { - action: 'entity' - data: - | MovieEntity - | TVEpisodeEntity - | TVSeriesEntity - | TVSeasonEntity - | MusicEntity - | PlaylistEntity - | AdditionalEntity - | UntypedEntity - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -[MovieEntity](#movieentity) -[TVEpisodeEntity](#tvepisodeentity) -[TVSeriesEntity](#tvseriesentity) -[TVSeasonEntity](#tvseasonentity) -[MusicEntity](#musicentity) -[PlaylistEntity](#playlistentity) -[AdditionalEntity](#additionalentity) -[UntypedEntity](#untypedentity) + + + + + + + + --- ### PlayableEntity + + ```typescript -type PlayableEntity = - | MovieEntity - | TVEpisodeEntity - | PlaylistEntity - | MusicEntity - | AdditionalEntity -``` -See also: +```` -[MovieEntity](#movieentity) -[TVEpisodeEntity](#tvepisodeentity) -[PlaylistEntity](#playlistentity) -[MusicEntity](#musicentity) -[AdditionalEntity](#additionalentity) +See also: --- @@ -403,26 +356,16 @@ See also: A Firebolt compliant representation of a user intention to 'tune' to a traditional over-the-air broadcast, or an OTT Stream from an OTT or vMVPD App. +````typescript ```typescript -type TuneIntent = { - action: 'tune' - data: { - entity: ChannelEntity - options?: { - assetId?: string // The ID of a specific 'listing', as scoped by the target App's ID-space, which the App should begin playback from. - restartCurrentProgram?: boolean // Denotes that the App should start playback at the most recent program boundary, rather than 'live.' - time?: string // ISO 8601 Date/Time where the App should begin playback from. - } - } - context: { - source: string - } -} -``` + +```` + +```` See also: -[ChannelEntity](#channelentity) + --- @@ -431,24 +374,15 @@ See also: A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed. ```typescript -type PlayEntityIntent = { - action: 'play-entity' - data: { - entity: PlayableEntity - options?: { - playFirstId?: string - playFirstTrack?: number - } - } - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity + --- @@ -457,18 +391,15 @@ MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed. ```typescript -type PlaybackIntent = { - action: 'playback' - data: PlayableEntity - context: { - source: string - } -} -``` +```typescript + +```` + +```` See also: -MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity + --- @@ -477,28 +408,9 @@ MovieEntity | TVEpisodeEntity | PlaylistEntity | MusicEntity | AdditionalEntity A Firebolt compliant representation of a user intention to navigate to a specific place in an app. ```typescript -type NavigationIntent = - | HomeIntent - | LaunchIntent - | EntityIntent - | PlaybackIntent - | SearchIntent - | SectionIntent - | TuneIntent - | PlayEntityIntent - | PlayQueryIntent -``` -See also: +```` -[HomeIntent](#homeintent) -[LaunchIntent](#launchintent) -[EntityIntent](#entityintent) -[PlaybackIntent](#playbackintent) -[SearchIntent](#searchintent) -[SectionIntent](#sectionintent) -[TuneIntent](#tuneintent) -[PlayEntityIntent](#playentityintent) -[PlayQueryIntent](#playqueryintent) +See also: --- diff --git a/apis/next/manage/Keyboard/index.md b/apis/next/manage/Keyboard/index.md index 76d663a82..31bc3a4f7 100644 --- a/apis/next/manage/Keyboard/index.md +++ b/apis/next/manage/Keyboard/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Keyboard 1.1.1-next.2 +Version Keyboard 1.2.0-next.1 ## Table of Contents @@ -61,15 +61,18 @@ Internal API for Email Provider to send back error. Parameters: -| Param | Type | Required | Description | -| --------------- | -------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `error` | `object` | true | | +| Param | Type | Required | Description | +| --------------- | ----------------------- | -------------- | ----------- | ----------- | +| `correlationId` | `string` | true | | +| `error` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | true | | Result: ```typescript -null + ``` Capabilities: @@ -122,7 +125,7 @@ Internal API for Email Provider to request focus for UX purposes. Result: ```typescript -null + ``` Capabilities: @@ -168,15 +171,15 @@ Internal API for Email Provider to send back response. Parameters: -| Param | Type | Required | Description | -| --------------- | ----------------------------------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `result` | [`KeyboardResult`](#keyboardresult) | true | | +| Param | Type | Required | Description | +| --------------- | -------- | -------- | ----------- | +| `correlationId` | `string` | true | | +| `result` | `` | true | | Result: ```typescript -null + ``` Capabilities: @@ -227,15 +230,18 @@ Internal API for Password Provider to send back error. Parameters: -| Param | Type | Required | Description | -| --------------- | -------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `error` | `object` | true | | +| Param | Type | Required | Description | +| --------------- | ----------------------- | -------------- | ----------- | ----------- | +| `correlationId` | `string` | true | | +| `error` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | true | | Result: ```typescript -null + ``` Capabilities: @@ -288,7 +294,7 @@ Internal API for Password Provider to request focus for UX purposes. Result: ```typescript -null + ``` Capabilities: @@ -334,15 +340,15 @@ Internal API for Password Provider to send back response. Parameters: -| Param | Type | Required | Description | -| --------------- | ----------------------------------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `result` | [`KeyboardResult`](#keyboardresult) | true | | +| Param | Type | Required | Description | +| --------------- | -------- | -------- | ----------- | +| `correlationId` | `string` | true | | +| `result` | `` | true | | Result: ```typescript -null + ``` Capabilities: @@ -410,15 +416,18 @@ Internal API for Standard Provider to send back error. Parameters: -| Param | Type | Required | Description | -| --------------- | -------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `error` | `object` | true | | +| Param | Type | Required | Description | +| --------------- | ----------------------- | -------------- | ----------- | ----------- | +| `correlationId` | `string` | true | | +| `error` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | true | | Result: ```typescript -null + ``` Capabilities: @@ -471,7 +480,7 @@ Internal API for Standard Provider to request focus for UX purposes. Result: ```typescript -null + ``` Capabilities: @@ -517,15 +526,15 @@ Internal API for Standard Provider to send back response. Parameters: -| Param | Type | Required | Description | -| --------------- | ----------------------------------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `result` | [`KeyboardResult`](#keyboardresult) | true | | +| Param | Type | Required | Description | +| --------------- | -------- | -------- | ----------- | +| `correlationId` | `string` | true | | +| `result` | `` | true | | Result: ```typescript -null + ``` Capabilities: @@ -584,16 +593,23 @@ Parameters: Result: -[KeyboardProviderRequest](#keyboardproviderrequest) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| -------- | -------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | provides | xrn:firebolt:capability:input:keyboard | + #### Examples + Default Example JSON-RPC: @@ -602,14 +618,14 @@ Request: ```json { - "jsonrpc": "2.0", - "id": 1, - "method": "Keyboard.onRequestEmail", - "params": { - "listen": true - } + "jsonrpc": "2.0", + "id": 1, + "method": "Keyboard.onRequestEmail", + "params": { + "listen": true + } } -``` +```` Response: @@ -642,16 +658,23 @@ Parameters: Result: -[KeyboardProviderRequest](#keyboardproviderrequest) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| -------- | -------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | provides | xrn:firebolt:capability:input:keyboard | + #### Examples + Default Example JSON-RPC: @@ -660,14 +683,14 @@ Request: ```json { - "jsonrpc": "2.0", - "id": 1, - "method": "Keyboard.onRequestPassword", - "params": { - "listen": true - } + "jsonrpc": "2.0", + "id": 1, + "method": "Keyboard.onRequestPassword", + "params": { + "listen": true + } } -``` +```` Response: @@ -700,16 +723,23 @@ Parameters: Result: -[KeyboardProviderRequest](#keyboardproviderrequest) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| -------- | -------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | provides | xrn:firebolt:capability:input:keyboard | + #### Examples + Default Example JSON-RPC: @@ -718,14 +748,14 @@ Request: ```json { - "jsonrpc": "2.0", - "id": 1, - "method": "Keyboard.onRequestStandard", - "params": { - "listen": true - } + "jsonrpc": "2.0", + "id": 1, + "method": "Keyboard.onRequestStandard", + "params": { + "listen": true + } } -``` +```` Response: @@ -760,111 +790,6 @@ Usage: Keyboard.provide('xrn:firebolt:capability:input:keyboard', provider: KeyboardInputProvider | object) ``` -#### standard - -Registers as a provider for when the user should be shown a standard keyboard. - -```typescript -function standard( - parameters?: KeyboardParameters, - session?: FocusableProviderSession, -): Promise -``` - -Provider methods always have two arguments: - -| Param | Type | Required | Summary | -| ------------ | ------------------------------------------- | -------- | ------- | -| `parameters` | [`KeyboardParameters`](#keyboardparameters) | false | | -| `session` | `FocusableProviderSession` | false | | - -| Parameters Property | Type | Required | Summary | -| ------------------- | -------- | -------- | --------------------------------------------------------------------------- | -| `message` | `string` | true | The message to display to the user so the user knows what they are entering | - -```typescript -type KeyboardParameters = { - message: string // The message to display to the user so the user knows what they are entering -} -``` - -Promise resolution: - -| Property | Type | Description | -| ---------- | ------- | ---------------------------------------------------------------------------------------- | -| `text` | string | The text the user entered into the keyboard | -| `canceled` | boolean | Whether the user canceled entering text before they were finished typing on the keyboard | - -#### password - -Registers as a provider for when the user should be shown a password keyboard, with dots for each character entered. - -```typescript -function password( - parameters?: KeyboardParameters, - session?: FocusableProviderSession, -): Promise -``` - -Provider methods always have two arguments: - -| Param | Type | Required | Summary | -| ------------ | ------------------------------------------- | -------- | ------- | -| `parameters` | [`KeyboardParameters`](#keyboardparameters) | false | | -| `session` | `FocusableProviderSession` | false | | - -| Parameters Property | Type | Required | Summary | -| ------------------- | -------- | -------- | --------------------------------------------------------------------------- | -| `message` | `string` | true | The message to display to the user so the user knows what they are entering | - -```typescript -type KeyboardParameters = { - message: string // The message to display to the user so the user knows what they are entering -} -``` - -Promise resolution: - -| Property | Type | Description | -| ---------- | ------- | ---------------------------------------------------------------------------------------- | -| `text` | string | The text the user entered into the keyboard | -| `canceled` | boolean | Whether the user canceled entering text before they were finished typing on the keyboard | - -#### email - -Registers as a provider for when the user should be shown a keyboard optimized for email address entry. - -```typescript -function email( - parameters?: KeyboardParameters, - session?: FocusableProviderSession, -): Promise -``` - -Provider methods always have two arguments: - -| Param | Type | Required | Summary | -| ------------ | ------------------------------------------- | -------- | ------- | -| `parameters` | [`KeyboardParameters`](#keyboardparameters) | false | | -| `session` | `FocusableProviderSession` | false | | - -| Parameters Property | Type | Required | Summary | -| ------------------- | -------- | -------- | --------------------------------------------------------------------------- | -| `message` | `string` | true | The message to display to the user so the user knows what they are entering | - -```typescript -type KeyboardParameters = { - message: string // The message to display to the user so the user knows what they are entering -} -``` - -Promise resolution: - -| Property | Type | Description | -| ---------- | ------- | ---------------------------------------------------------------------------------------- | -| `text` | string | The text the user entered into the keyboard | -| `canceled` | boolean | Whether the user canceled entering text before they were finished typing on the keyboard | - #### Examples **Register your app to provide the `xrn:firebolt:capability:input:keyboard` capability.** @@ -974,7 +899,7 @@ Event Response: { "id": 1, "result": { - "correlationId": "abc", + "correlationId": undefined, "parameters": { "message": "Enter your user name." } @@ -991,7 +916,7 @@ Request: "id": 4, "method": "Keyboard.standardResponse", "params": { - "correlationId": "abc", + "correlationId": undefined, "result": { "text": "username" } @@ -1016,7 +941,7 @@ Event Response: { "id": 2, "result": { - "correlationId": "abc", + "correlationId": undefined, "parameters": { "message": "Enter your user name." } @@ -1033,7 +958,7 @@ Request: "id": 5, "method": "Keyboard.passwordResponse", "params": { - "correlationId": "abc", + "correlationId": undefined, "result": { "text": "password" } @@ -1058,7 +983,7 @@ Event Response: { "id": 3, "result": { - "correlationId": "abc", + "correlationId": undefined, "parameters": { "message": "Enter your user name." } @@ -1075,7 +1000,7 @@ Request: "id": 6, "method": "Keyboard.emailResponse", "params": { - "correlationId": "abc", + "correlationId": undefined, "result": { "text": "email@address.com" } @@ -1098,36 +1023,46 @@ Response: ### KeyboardResult +````typescript ```typescript -type KeyboardResult = { - text: string // The text the user entered into the keyboard - canceled?: boolean // Whether the user canceled entering text before they were finished typing on the keyboard -} -``` + +```` + +```` + + --- ### KeyboardParameters + + ```typescript -type KeyboardParameters = { - message: string // The message to display to the user so the user knows what they are entering -} -``` +```typescript + +```` + +```` + + --- ### KeyboardProviderRequest + + ```typescript -type KeyboardProviderRequest = { - correlationId: string // An id to correlate the provider response with this request - parameters: KeyboardParameters -} +```typescript + +```` + ``` See also: -[KeyboardParameters](#keyboardparameters) + --- +``` diff --git a/apis/next/manage/Lifecycle/schemas/index.md b/apis/next/manage/Lifecycle/schemas/index.md index 8ef33e75d..abe5825d8 100644 --- a/apis/next/manage/Lifecycle/schemas/index.md +++ b/apis/next/manage/Lifecycle/schemas/index.md @@ -31,12 +31,15 @@ undefined The application close reason ```typescript -enum CloseReason { - REMOTE_BUTTON = 'remoteButton', - USER_EXIT = 'userExit', - DONE = 'done', - ERROR = 'error', -} +CloseReason Enumeration: + +| key | value | +|-----|-------| +| REMOTE_BUTTON | remoteButton | +| USER_EXIT | userExit | +| DONE | done | +| ERROR | error | + ``` --- @@ -46,14 +49,17 @@ enum CloseReason { The application lifecycle state ```typescript -enum LifecycleState { - INITIALIZING = 'initializing', - INACTIVE = 'inactive', - FOREGROUND = 'foreground', - BACKGROUND = 'background', - UNLOADING = 'unloading', - SUSPENDED = 'suspended', -} +LifecycleState Enumeration: + +| key | value | +|-----|-------| +| INITIALIZING | initializing | +| INACTIVE | inactive | +| FOREGROUND | foreground | +| BACKGROUND | background | +| UNLOADING | unloading | +| SUSPENDED | suspended | + ``` --- diff --git a/apis/next/manage/Localization/index.md b/apis/next/manage/Localization/index.md index b826d16cc..77a3019f7 100644 --- a/apis/next/manage/Localization/index.md +++ b/apis/next/manage/Localization/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Localization 1.1.1-next.2 +Version Localization 1.2.0-next.1 ## Table of Contents @@ -38,6 +38,7 @@ Version Localization 1.1.1-next.2 - [postalCodeChanged](#postalcodechanged) - [preferredAudioLanguagesChanged](#preferredaudiolanguageschanged) - [timeZoneChanged](#timezonechanged) +- [Types](#types) ## Usage @@ -58,7 +59,7 @@ Methods for accessessing location and language preferences Add any platform-specific localization information in key/value pair ```typescript -function addAdditionalInfo(key: string, value: string): Promise +${method.signature} ``` Parameters: @@ -134,13 +135,16 @@ Response: Get any platform-specific localization information, in an Map ```typescript -function additionalInfo(): Promise +${method.signature} ``` Promise resolution: ```typescript -object +| Property | Type | Description | +|----------|------|-------------| +| `${property}` | ${type} | | + ``` Capabilities: @@ -203,13 +207,13 @@ Get the ISO 3166-1 alpha-2 code for the country device is located in To get the value of `countryCode` call the method like this: ```typescript -function countryCode(): Promise +${method.signature} ``` Promise resolution: ```typescript -type CountryCode = string + ``` Capabilities: @@ -309,19 +313,20 @@ Response: To set the value of `countryCode` call the method like this: ```typescript -function countryCode(value: string): Promise +function countryCode(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ------------------------------------------------ | -| `value` | `string` | true | the device country code
pattern: ^[A-Z]{2}$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------------- | +| `value` | `` | true | the device country code pattern: ^[A-Z]{2}$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -419,7 +424,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function countryCode(callback: (value) => string): Promise +function countryCode(callback: (value) => ): Promise ``` Promise resolution: @@ -531,13 +536,13 @@ Get the ISO 639 1/2 code for the preferred language To get the value of `language` call the method like this: ```typescript -function language(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Language = string + ``` Capabilities: @@ -637,19 +642,20 @@ Response: To set the value of `language` call the method like this: ```typescript -function language(value: string): Promise +function language(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------------------------------------------- | -| `value` | `string` | true | the device language
pattern: ^[A-Za-z]{2}$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------------ | +| `value` | `` | true | the device language pattern: ^[A-Za-z]{2}$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -747,7 +753,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function language(callback: (value) => string): Promise +function language(callback: (value) => ): Promise ``` Promise resolution: @@ -913,13 +919,13 @@ Get the _full_ BCP 47 code, including script, region, variant, etc., for the pre To get the value of `locale` call the method like this: ```typescript -function locale(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Locale = string + ``` Capabilities: @@ -1019,19 +1025,20 @@ Response: To set the value of `locale` call the method like this: ```typescript -function locale(value: string): Promise +function locale(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ------------------------------------------------------------ | -| `value` | `string` | true | the device locale
pattern: ^[a-zA-Z]+([a-zA-Z0-9\-]\*)$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------------------------- | +| `value` | `` | true | the device locale pattern: ^[a-zA-Z]+([a-zA-Z0-9\-]\*)$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -1129,7 +1136,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function locale(callback: (value) => string): Promise +function locale(callback: (value) => ): Promise ``` Promise resolution: @@ -1241,13 +1248,13 @@ Get the locality/city the device is located in To get the value of `locality` call the method like this: ```typescript -function locality(): Promise +${method.signature} ``` Promise resolution: ```typescript -type Locality = string + ``` Capabilities: @@ -1347,19 +1354,20 @@ Response: To set the value of `locality` call the method like this: ```typescript -function locality(value: string): Promise +function locality(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | --------------- | -| `value` | `string` | true | the device city | +| Param | Type | Required | Description | +| ------- | ---- | -------- | --------------- | +| `value` | `` | true | the device city | Promise resolution: ```typescript -null + ``` #### Examples @@ -1457,7 +1465,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function locality(callback: (value) => string): Promise +function locality(callback: (value) => ): Promise ``` Promise resolution: @@ -1625,7 +1633,7 @@ Get the postal code the device is located in To get the value of `postalCode` call the method like this: ```typescript -function postalCode(): Promise +${method.signature} ``` Promise resolution: @@ -1731,7 +1739,8 @@ Response: To set the value of `postalCode` call the method like this: ```typescript -function postalCode(value: string): Promise +function postalCode(| `value` | [`string`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1743,7 +1752,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1953,13 +1962,13 @@ A prioritized list of ISO 639 1/2 codes for the preferred audio languages on thi To get the value of `preferredAudioLanguages` call the method like this: ```typescript -function preferredAudioLanguages(): Promise +${method.signature} ``` Promise resolution: ```typescript -string[] + ``` Capabilities: @@ -2059,19 +2068,20 @@ Response: To set the value of `preferredAudioLanguages` call the method like this: ```typescript -function preferredAudioLanguages(value: string[]): Promise +function preferredAudioLanguages(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | ---------- | -------- | ------------------------------------------------------ | -| `value` | `string[]` | true | the preferred audio languages
pattern: ^[a-z]{3}$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------------------------- | +| `value` | `` | true | the preferred audio languages pattern: ^[a-z]{3}$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -2169,7 +2179,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function preferredAudioLanguages(callback: (value) => string[]): Promise +function preferredAudioLanguages(callback: (value) => ): Promise ``` Promise resolution: @@ -2279,7 +2289,7 @@ Response: Remove any platform-specific localization information from map ```typescript -function removeAdditionalInfo(key: string): Promise +${method.signature} ``` Parameters: @@ -2355,13 +2365,13 @@ Set the IANA timezone for the device To get the value of `timeZone` call the method like this: ```typescript -function timeZone(): Promise +${method.signature} ``` Promise resolution: ```typescript -type TimeZone = string + ``` Capabilities: @@ -2461,19 +2471,20 @@ Response: To set the value of `timeZone` call the method like this: ```typescript -function timeZone(value: string): Promise +function timeZone(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ------- | -------- | -------- | ----------------------------------- | -| `value` | `string` | true |
pattern: ^[-+_/ A-Za-z 0-9]\*$ | +| Param | Type | Required | Description | +| ------- | ---- | -------- | ------------------------------ | +| `value` | `` | true | pattern: ^[-+_/ A-Za-z 0-9]\*$ | Promise resolution: ```typescript -null + ``` #### Examples @@ -2571,7 +2582,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function timeZone(callback: (value) => string): Promise +function timeZone(callback: (value) => ): Promise ``` Promise resolution: @@ -2705,3 +2716,5 @@ See: [preferredAudioLanguages](#preferredaudiolanguages) ### timeZoneChanged See: [timeZone](#timezone) + +## Types diff --git a/apis/next/manage/Localization/schemas/index.md b/apis/next/manage/Localization/schemas/index.md index 42335a9ec..0fdf98175 100644 --- a/apis/next/manage/Localization/schemas/index.md +++ b/apis/next/manage/Localization/schemas/index.md @@ -33,7 +33,7 @@ undefined ### ISO639_2Language ```typescript -type ISO639_2Language = string + ``` --- @@ -41,7 +41,7 @@ type ISO639_2Language = string ### Locality ```typescript -type Locality = string + ``` --- @@ -49,7 +49,7 @@ type Locality = string ### CountryCode ```typescript -type CountryCode = string + ``` --- @@ -57,7 +57,7 @@ type CountryCode = string ### Language ```typescript -type Language = string + ``` --- @@ -65,7 +65,7 @@ type Language = string ### Locale ```typescript -type Locale = string + ``` --- @@ -73,7 +73,7 @@ type Locale = string ### TimeZone ```typescript -type TimeZone = string + ``` --- diff --git a/apis/next/manage/Metrics/index.md b/apis/next/manage/Metrics/index.md index 9a9d34b46..46dad565c 100644 --- a/apis/next/manage/Metrics/index.md +++ b/apis/next/manage/Metrics/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Metrics 1.1.1-next.2 +Version Metrics 1.2.0-next.1 ## Table of Contents @@ -42,20 +42,20 @@ Methods for sending metrics Inform the platform of 1st party distributor metrics. ```typescript -function event(schema: string, data: EventObject): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| -------- | ------------------------------- | -------- | -------------------------------------------------- | -| `schema` | `string` | true | The schema URI of the metric type
format: uri | -| `data` | [`EventObject`](#eventobject-1) | true | A JSON payload conforming the the provided schema | +| Param | Type | Required | Description | +| -------- | -------- | -------- | -------------------------------------------------- | +| `schema` | `string` | true | The schema URI of the metric type
format: uri | +| `data` | `` | true | A JSON payload conforming the the provided schema | Promise resolution: ```typescript -null + ``` Capabilities: @@ -122,26 +122,24 @@ Response: ### EventObjectPrimitives ```typescript -type EventObjectPrimitives = string | number | number | boolean | null + ``` --- ### EventObject +````typescript ```typescript -type EventObject = { - [property: string]: - | EventObjectPrimitives - | EventObjectPrimitives - | EventObject[] - | EventObject -} + +```` + ``` See also: -string | number | number | boolean | null -[EventObject](#eventobject-1) + + --- +``` diff --git a/apis/next/manage/PinChallenge/index.md b/apis/next/manage/PinChallenge/index.md index 87983534f..0302f9667 100644 --- a/apis/next/manage/PinChallenge/index.md +++ b/apis/next/manage/PinChallenge/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version PinChallenge 1.1.1-next.2 +Version PinChallenge 1.2.0-next.1 ## Table of Contents @@ -55,15 +55,18 @@ Internal API for Challenge Provider to send back error. Parameters: -| Param | Type | Required | Description | -| --------------- | -------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `error` | `object` | true | | +| Param | Type | Required | Description | +| --------------- | ----------------------- | -------------- | ----------- | ----------- | +| `correlationId` | `string` | true | | +| `error` | [` | Property | Type | Description | +| ---------- | ------ | ------------- | +| `${property}` | [${type}](${type.link}) | ${description} | +| `](#) | true | | Result: ```typescript -null + ``` Capabilities: @@ -116,7 +119,7 @@ Internal API for Challenge Provider to request focus for UX purposes. Result: ```typescript -null + ``` Capabilities: @@ -162,15 +165,15 @@ Internal API for Challenge Provider to send back response. Parameters: -| Param | Type | Required | Description | -| --------------- | ------------------------------------------- | -------- | ----------- | -| `correlationId` | `string` | true | | -| `result` | [`PinChallengeResult`](#pinchallengeresult) | true | | +| Param | Type | Required | Description | +| --------------- | -------- | -------- | ----------- | +| `correlationId` | `string` | true | | +| `result` | `` | true | | Result: ```typescript -null + ``` Capabilities: @@ -309,16 +312,23 @@ Parameters: Result: -[PinChallengeProviderRequest](#pinchallengeproviderrequest) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| -------- | ---------------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | provides | xrn:firebolt:capability:usergrant:pinchallenge | + #### Examples + Default Example JSON-RPC: @@ -327,14 +337,14 @@ Request: ```json { - "jsonrpc": "2.0", - "id": 1, - "method": "PinChallenge.onRequestChallenge", - "params": { - "listen": true - } + "jsonrpc": "2.0", + "id": 1, + "method": "PinChallenge.onRequestChallenge", + "params": { + "listen": true + } } -``` +```` Response: @@ -374,41 +384,6 @@ Usage: PinChallenge.provide('xrn:firebolt:capability:usergrant:pinchallenge', provider: ChallengeProvider | object) ``` -#### challenge - -Registers as a provider for when the user should be challenged in order to confirm access to a capability through a pin prompt - -```typescript -function challenge( - parameters?: PinChallenge, - session?: FocusableProviderSession, -): Promise -``` - -Provider methods always have two arguments: - -| Param | Type | Required | Summary | -| ------------ | -------------------------- | -------- | ------- | -| `parameters` | `PinChallenge` | false | | -| `session` | `FocusableProviderSession` | false | | - -| Parameters Property | Type | Required | Summary | -| ------------------- | ------------------------------------------- | ---------- | ----------------------------------------------- | ------------------------------------------------------------------------------- | -| `pinSpace` | `'purchase' | 'content'` | true | The pin space that this challenge is for
values: `'purchase' \| 'content'` | -| `capability` | `string` | false | The capability that is gated by a pin challenge | -| `requestor` | [`ChallengeRequestor`](#challengerequestor) | true | | - -```typescript -type PinChallenge = object -``` - -Promise resolution: - -| Property | Type | Description | -| --------- | --------------- | --------------------- | --------------------- | ------------ | ----------- | ------------------------------------------------- | -| `granted` | boolean | void | | -| `reason` | 'noPinRequired' | 'noPinRequiredWindow' | 'exceededPinFailures' | 'correctPin' | 'cancelled' | The reason for the result of challenging the user | - #### Examples **Register your app to provide the `xrn:firebolt:capability:usergrant:pinchallenge` capability.** @@ -468,7 +443,7 @@ Event Response: { "id": 1, "result": { - "correlationId": "abc", + "correlationId": undefined, "parameters": { "capability": "xrn:firebolt:capability:commerce::purchase", "requestor": { @@ -490,7 +465,7 @@ Request: "id": 2, "method": "PinChallenge.challengeResponse", "params": { - "correlationId": "abc", + "correlationId": undefined, "result": { "granted": true, "reason": "correctPin" @@ -517,71 +492,82 @@ Response: The reason for the result of challenging the user ```typescript -enum ResultReason { - NO_PIN_REQUIRED = 'noPinRequired', - NO_PIN_REQUIRED_WINDOW = 'noPinRequiredWindow', - EXCEEDED_PIN_FAILURES = 'exceededPinFailures', - CORRECT_PIN = 'correctPin', - CANCELLED = 'cancelled', -} +ResultReason Enumeration: + +| key | value | +|-----|-------| +| NO_PIN_REQUIRED | noPinRequired | +| NO_PIN_REQUIRED_WINDOW | noPinRequiredWindow | +| EXCEEDED_PIN_FAILURES | exceededPinFailures | +| CORRECT_PIN | correctPin | +| CANCELLED | cancelled | + ``` --- ### ChallengeRequestor +````typescript ```typescript -type ChallengeRequestor = { - id: string // The id of the app that requested the challenge - name: string // The name of the app that requested the challenge -} -``` + +```` + +```` + + --- ### PinChallengeResult + + ```typescript -type PinChallengeResult = { - granted: boolean | void - reason: ResultReason // The reason for the result of challenging the user -} -``` +```typescript + +```` + +```` See also: -'noPinRequired' | 'noPinRequiredWindow' | 'exceededPinFailures' | 'correctPin' | 'cancelled' + --- ### PinChallenge + + ```typescript -type PinChallenge = { - pinSpace: 'purchase' | 'content' // The pin space that this challenge is for - capability?: string // The capability that is gated by a pin challenge - requestor: ChallengeRequestor -} -``` +```typescript + +```` + +```` See also: -[ChallengeRequestor](#challengerequestor) + --- ### PinChallengeProviderRequest + + ```typescript -type PinChallengeProviderRequest = { - parameters: PinChallenge - correlationId: string // The id that was passed in to the event that triggered a provider method to be called -} +```typescript + +```` + ``` See also: -[ProviderRequest](../Types/schemas/#ProviderRequest) -[PinChallenge](#pinchallenge-1) + + --- +``` diff --git a/apis/next/manage/Privacy/index.md b/apis/next/manage/Privacy/index.md index 1e3fb42eb..a40a63278 100644 --- a/apis/next/manage/Privacy/index.md +++ b/apis/next/manage/Privacy/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Privacy 1.1.1-next.2 +Version Privacy 1.2.0-next.1 ## Table of Contents @@ -70,7 +70,7 @@ Whether the user allows their automatic content recognition data to be collected To get the value of `allowACRCollection` call the method like this: ```typescript -function allowACRCollection(): Promise +${method.signature} ``` Promise resolution: @@ -176,7 +176,8 @@ Response: To set the value of `allowACRCollection` call the method like this: ```typescript -function allowACRCollection(value: boolean): Promise +function allowACRCollection(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -188,7 +189,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -398,7 +399,7 @@ Whether the user allows ads to be targeted to the user while watching content in To get the value of `allowAppContentAdTargeting` call the method like this: ```typescript -function allowAppContentAdTargeting(): Promise +${method.signature} ``` Promise resolution: @@ -504,7 +505,8 @@ Response: To set the value of `allowAppContentAdTargeting` call the method like this: ```typescript -function allowAppContentAdTargeting(value: boolean): Promise +function allowAppContentAdTargeting(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -516,7 +518,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -728,7 +730,7 @@ Whether the user allows data from their camera to be used for Product Analytics To get the value of `allowCameraAnalytics` call the method like this: ```typescript -function allowCameraAnalytics(): Promise +${method.signature} ``` Promise resolution: @@ -834,7 +836,8 @@ Response: To set the value of `allowCameraAnalytics` call the method like this: ```typescript -function allowCameraAnalytics(value: boolean): Promise +function allowCameraAnalytics(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -846,7 +849,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1056,7 +1059,7 @@ Whether the user allows their usage data to be used for personalization and reco To get the value of `allowPersonalization` call the method like this: ```typescript -function allowPersonalization(): Promise +${method.signature} ``` Promise resolution: @@ -1162,7 +1165,8 @@ Response: To set the value of `allowPersonalization` call the method like this: ```typescript -function allowPersonalization(value: boolean): Promise +function allowPersonalization(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1174,7 +1178,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1384,7 +1388,7 @@ Whether the user allows ads to be targeted to the user while browsing in the pri To get the value of `allowPrimaryBrowseAdTargeting` call the method like this: ```typescript -function allowPrimaryBrowseAdTargeting(): Promise +${method.signature} ``` Promise resolution: @@ -1490,7 +1494,8 @@ Response: To set the value of `allowPrimaryBrowseAdTargeting` call the method like this: ```typescript -function allowPrimaryBrowseAdTargeting(value: boolean): Promise +function allowPrimaryBrowseAdTargeting(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1502,7 +1507,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -1714,7 +1719,7 @@ Whether the user allows ads to be targeted to the user while watching content in To get the value of `allowPrimaryContentAdTargeting` call the method like this: ```typescript -function allowPrimaryContentAdTargeting(): Promise +${method.signature} ``` Promise resolution: @@ -1820,7 +1825,8 @@ Response: To set the value of `allowPrimaryContentAdTargeting` call the method like this: ```typescript -function allowPrimaryContentAdTargeting(value: boolean): Promise +function allowPrimaryContentAdTargeting(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -1832,7 +1838,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -2044,7 +2050,7 @@ Whether the user allows their usage data can be used for analytics about the pro To get the value of `allowProductAnalytics` call the method like this: ```typescript -function allowProductAnalytics(): Promise +${method.signature} ``` Promise resolution: @@ -2150,7 +2156,8 @@ Response: To set the value of `allowProductAnalytics` call the method like this: ```typescript -function allowProductAnalytics(value: boolean): Promise +function allowProductAnalytics(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -2162,7 +2169,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -2372,7 +2379,7 @@ Whether the user allows their personal data to be included in diagnostic telemet To get the value of `allowRemoteDiagnostics` call the method like this: ```typescript -function allowRemoteDiagnostics(): Promise +${method.signature} ``` Promise resolution: @@ -2478,7 +2485,8 @@ Response: To set the value of `allowRemoteDiagnostics` call the method like this: ```typescript -function allowRemoteDiagnostics(value: boolean): Promise +function allowRemoteDiagnostics(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -2490,7 +2498,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -2700,7 +2708,7 @@ Whether the user allows resume points for content to show in the main experience To get the value of `allowResumePoints` call the method like this: ```typescript -function allowResumePoints(): Promise +${method.signature} ``` Promise resolution: @@ -2806,7 +2814,8 @@ Response: To set the value of `allowResumePoints` call the method like this: ```typescript -function allowResumePoints(value: boolean): Promise +function allowResumePoints(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -2818,7 +2827,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -3028,7 +3037,7 @@ Whether the user allows their usage data to be used for personalization and reco To get the value of `allowUnentitledPersonalization` call the method like this: ```typescript -function allowUnentitledPersonalization(): Promise +${method.signature} ``` Promise resolution: @@ -3134,7 +3143,8 @@ Response: To set the value of `allowUnentitledPersonalization` call the method like this: ```typescript -function allowUnentitledPersonalization(value: boolean): Promise +function allowUnentitledPersonalization(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -3146,7 +3156,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -3358,7 +3368,7 @@ Whether the user allows resume points for content from unentitled providers to s To get the value of `allowUnentitledResumePoints` call the method like this: ```typescript -function allowUnentitledResumePoints(): Promise +${method.signature} ``` Promise resolution: @@ -3464,7 +3474,8 @@ Response: To set the value of `allowUnentitledResumePoints` call the method like this: ```typescript -function allowUnentitledResumePoints(value: boolean): Promise +function allowUnentitledResumePoints(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -3476,7 +3487,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -3688,7 +3699,7 @@ Whether the user allows their watch history from all sources to show in the main To get the value of `allowWatchHistory` call the method like this: ```typescript -function allowWatchHistory(): Promise +${method.signature} ``` Promise resolution: @@ -3794,7 +3805,8 @@ Response: To set the value of `allowWatchHistory` call the method like this: ```typescript -function allowWatchHistory(value: boolean): Promise +function allowWatchHistory(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -3806,7 +3818,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -4124,21 +4136,28 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio Gets the allowed value for all privacy settings ```typescript -function settings(): Promise +${method.signature} ``` Promise resolution: -[PrivacySettings](#privacysettings) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ---------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:privacy:settings | + #### Examples + Default Example JavaScript: @@ -4148,7 +4167,7 @@ import { Privacy } from '@firebolt-js/manage-sdk' let settings = await Privacy.settings() console.log(settings) -``` +```` Value of `settings`: @@ -4263,21 +4282,14 @@ See: [allowWatchHistory](#allowwatchhistory) ### PrivacySettings +````typescript ```typescript -type PrivacySettings = { - allowACRCollection: boolean - allowResumePoints: boolean - allowAppContentAdTargeting: boolean - allowCameraAnalytics: boolean - allowPersonalization: boolean - allowPrimaryBrowseAdTargeting: boolean - allowPrimaryContentAdTargeting: boolean - allowProductAnalytics: boolean - allowRemoteDiagnostics: boolean - allowUnentitledPersonalization: boolean - allowUnentitledResumePoints: boolean - allowWatchHistory: boolean -} + +```` + ``` + + --- +``` diff --git a/apis/next/manage/SecondScreen/schemas/index.md b/apis/next/manage/SecondScreen/schemas/index.md index 0c3e06cdb..6ec042f32 100644 --- a/apis/next/manage/SecondScreen/schemas/index.md +++ b/apis/next/manage/SecondScreen/schemas/index.md @@ -29,12 +29,14 @@ undefined An a message notification from a second screen device +````typescript ```typescript -type SecondScreenEvent = { - type: 'dial' - version?: string - data?: string -} + +```` + ``` + + --- +``` diff --git a/apis/next/manage/SecureStorage/index.md b/apis/next/manage/SecureStorage/index.md index d52d45bdd..a1a51d9c9 100644 --- a/apis/next/manage/SecureStorage/index.md +++ b/apis/next/manage/SecureStorage/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version SecureStorage 1.1.1-next.2 +Version SecureStorage 1.2.0-next.1 ## Table of Contents @@ -44,15 +44,15 @@ A module for storing and retrieving secure data owned by the app Clears all the secure data values for a specific app ```typescript -function clearForApp(appId: string, scope: StorageScope): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | --------------------------------------------------------------- | -| `appId` | `string` | true | appId for which values are removed | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the key/value
values: `'device' \| 'account'` | +| Param | Type | Required | Description | +| ------- | -------- | -------- | ---------------------------------------------------------- | +| `appId` | `string` | true | appId for which values are removed | +| `scope` | `` | true | The scope of the key/value values: `'device' \| 'account'` | Promise resolution: @@ -120,20 +120,16 @@ Response: Removes single data value for a specific app. ```typescript -function removeForApp( - appId: string, - scope: StorageScope, - key: string, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------- | ------------------------------- | -------- | --------------------------------------------------------------- | -| `appId` | `string` | true | appId for which values are removed | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the key/value
values: `'device' \| 'account'` | -| `key` | `string` | true | Key to remove | +| Param | Type | Required | Description | +| ------- | -------- | -------- | ---------------------------------------------------------- | +| `appId` | `string` | true | appId for which values are removed | +| `scope` | `` | true | The scope of the key/value values: `'device' \| 'account'` | +| `key` | `string` | true | Key to remove | Promise resolution: @@ -206,24 +202,18 @@ Response: Set or update a secure data value for a specific app. ```typescript -function setForApp( - appId: string, - scope: StorageScope, - key: string, - value: string, - options?: StorageOptions, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| --------- | ----------------------------------- | -------- | -------------------------------------------------------------- | -| `appId` | `string` | true | appId for which value is being set | -| `scope` | [`StorageScope`](#storagescope) | true | The scope of the data key
values: `'device' \| 'account'` | -| `key` | `string` | true | Key to set | -| `value` | `string` | true | Value to set | -| `options` | [`StorageOptions`](#storageoptions) | false | Optional parameters to set | +| Param | Type | Required | Description | +| --------- | -------- | -------- | --------------------------------------------------------- | +| `appId` | `string` | true | appId for which value is being set | +| `scope` | `` | true | The scope of the data key values: `'device' \| 'account'` | +| `key` | `string` | true | Key to set | +| `value` | `string` | true | Value to set | +| `options` | `` | false | Optional parameters to set | Promise resolution: @@ -359,20 +349,27 @@ Response: The scope of the data ```typescript -enum StorageScope { - DEVICE = 'device', - ACCOUNT = 'account', -} +StorageScope Enumeration: + +| key | value | +|-----|-------| +| DEVICE | device | +| ACCOUNT | account | + ``` --- ### StorageOptions +````typescript ```typescript -type StorageOptions = { - ttl: number // Seconds from set time before the data expires and is removed -} + +```` + ``` + + --- +``` diff --git a/apis/next/manage/Types/schemas/index.md b/apis/next/manage/Types/schemas/index.md index 26b8be85e..0d6773468 100644 --- a/apis/next/manage/Types/schemas/index.md +++ b/apis/next/manage/Types/schemas/index.md @@ -33,38 +33,46 @@ undefined ### AudioProfile ```typescript -enum AudioProfile { - STEREO = 'stereo', - DOLBY_DIGITAL_5_1 = 'dolbyDigital5.1', - DOLBY_DIGITAL_7_1 = 'dolbyDigital7.1', - DOLBY_DIGITAL_5_1_PLUS = 'dolbyDigital5.1+', - DOLBY_DIGITAL_7_1_PLUS = 'dolbyDigital7.1+', - DOLBY_ATMOS = 'dolbyAtmos', -} +AudioProfile Enumeration: + +| key | value | +|-----|-------| +| STEREO | stereo | +| DOLBY_DIGITAL_5_1 | dolbyDigital5.1 | +| DOLBY_DIGITAL_7_1 | dolbyDigital7.1 | +| DOLBY_DIGITAL_5_1_PLUS | dolbyDigital5.1+ | +| DOLBY_DIGITAL_7_1_PLUS | dolbyDigital7.1+ | +| DOLBY_ATMOS | dolbyAtmos | + ``` --- ### BooleanMap +````typescript ```typescript -type BooleanMap = { - [property: string]: boolean -} -``` + +```` + +```` + + --- ### SemanticVersion + + ```typescript -type SemanticVersion = { - major: number - minor: number - patch: number - readable: string -} -``` +```typescript + +```` + +```` + + --- @@ -73,17 +81,15 @@ type SemanticVersion = { Localized string supports either a simple `string` or a Map of language codes to strings. When using a simple `string`, the current preferred langauge from `Localization.langauge()` is assumed. ```typescript -type LocalizedString = string | object -``` + +```` --- ### FlatMap ```typescript -type FlatMap = { - [property: string]: string | number | boolean -} + ``` --- @@ -93,7 +99,7 @@ type FlatMap = { Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error. ```typescript -type Timeout = number + ``` --- diff --git a/apis/next/manage/UserGrants/index.md b/apis/next/manage/UserGrants/index.md index dfaa5eb15..019821434 100644 --- a/apis/next/manage/UserGrants/index.md +++ b/apis/next/manage/UserGrants/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version UserGrants 1.1.1-next.2 +Version UserGrants 1.2.0-next.1 ## Table of Contents @@ -26,10 +26,10 @@ Version UserGrants 1.1.1-next.2 - [grant](#grant) - [request](#request) - [Types](#types) - - [AppInfo](#appinfo) + - [GrantState](#grantstate) - [GrantModificationOptions](#grantmodificationoptions) - [RequestOptions](#requestoptions) - - [GrantState](#grantstate) + - [AppInfo](#appinfo) - [GrantInfo](#grantinfo) ## Usage @@ -51,7 +51,7 @@ A module for managing grants given by the user Get all granted and denied user grants for the given app ```typescript -function app(appId: string): Promise +${method.signature} ``` Parameters: @@ -63,7 +63,7 @@ Parameters: Promise resolution: ```typescript -object[] + ``` Capabilities: @@ -169,19 +169,19 @@ Response: Get all granted and denied user grants for the given capability ```typescript -function capability(capability: Capability): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | Promise resolution: ```typescript -object[] + ``` Capabilities: @@ -259,20 +259,16 @@ Response: Clears the grant for a given capability, to a specific app if appropriate. Calling this results in a persisted Denied Grant that lasts for the duration of the Grant Policy lifespan. ```typescript -function clear( - role: Role, - capability: Capability, - options?: object, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `role` | [`Role`](../Capabilities/schemas/#Role) | true |
values: `'use' \| 'manage' \| 'provide'` | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | -| `options` | `object` | false | | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `role` | `` | true | values: `'use' \| 'manage' \| 'provide'` | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| `options` | `` | false | | Promise resolution: @@ -347,20 +343,16 @@ Response: Denies a given capability, to a specific app if appropriate. Calling this results in a persisted Denied Grant that lasts for the duration of the Grant Policy lifespan. ```typescript -function deny( - role: Role, - capability: Capability, - options?: object, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `role` | [`Role`](../Capabilities/schemas/#Role) | true |
values: `'use' \| 'manage' \| 'provide'` | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | -| `options` | `object` | false | | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `role` | `` | true | values: `'use' \| 'manage' \| 'provide'` | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| `options` | `` | false | | Promise resolution: @@ -435,13 +427,13 @@ Response: Get all granted and denied user grants for the device ```typescript -function device(): Promise +${method.signature} ``` Promise resolution: ```typescript -object[] + ``` Capabilities: @@ -515,20 +507,16 @@ Response: Grants a given capability to a specific app, if appropriate. Calling this results in a persisted active grant that lasts for the duration of the grant policy lifespan. ```typescript -function grant( - role: Role, - capability: Capability, - options?: object, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------------------- | -------- | ---------------------------------------------------------------------- | -| `role` | [`Role`](../Capabilities/schemas/#Role) | true |
values: `'use' \| 'manage' \| 'provide'` | -| `capability` | [`Capability`](../Capabilities/schemas/#Capability) | true |
pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | -| `options` | `object` | false | | +| Param | Type | Required | Description | +| ------------ | ---- | -------- | ----------------------------------------------------------------- | +| `role` | `` | true | values: `'use' \| 'manage' \| 'provide'` | +| `capability` | `` | true | pattern: ^xrn:firebolt:capability:([a-z0-9\-]+)((:[a-z0-9\-]+)?)$ | +| `options` | `` | false | | Promise resolution: @@ -603,25 +591,21 @@ Response: Requests Firebolt to carry out a set of user grants for a given application such that the user grant provider is notified or an existing user grant is reused. ```typescript -function request( - appId: string, - permissions: Permission[], - options?: RequestOptions, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------- | ----------------------------------- | -------- | --------------- | -| `appId` | `string` | true | | -| `permissions` | `Permission[]` | true | | -| `options` | [`RequestOptions`](#requestoptions) | false | Request options | +| Param | Type | Required | Description | +| ------------- | -------- | -------- | --------------- | +| `appId` | `string` | true | | +| `permissions` | `` | true | | +| `options` | `` | false | Request options | Promise resolution: ```typescript -object[] + ``` Capabilities: @@ -803,15 +787,18 @@ Response: ## Types -### AppInfo +### GrantState -Information about an app that a grant was for +The state the grant is in ```typescript -type AppInfo = { - id: string - title?: string -} +GrantState Enumeration: + +| key | value | +|-----|-------| +| GRANTED | granted | +| DENIED | denied | + ``` --- @@ -820,34 +807,44 @@ type AppInfo = { Options when modifying any grant +````typescript ```typescript -type GrantModificationOptions = { - appId?: string -} -``` + +```` + +```` + + --- ### RequestOptions + + +```typescript ```typescript -type RequestOptions = { - force?: boolean // Whether to force for user grant even if the previous decision stored -} -``` + +```` + +```` + + --- -### GrantState +### AppInfo -The state the grant is in +Information about an app that a grant was for ```typescript -enum GrantState { - GRANTED = 'granted', - DENIED = 'denied', -} -``` +```typescript + +```` + +```` + + --- @@ -856,22 +853,18 @@ enum GrantState { Information about a grant given by a user ```typescript -type GrantInfo = { - app?: { - id: string - title?: string - } - state: 'granted' | 'denied' // The state the grant is in - capability: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform. - role: Role // Role provides access level for the app for a given capability. - lifespan: 'once' | 'forever' | 'appActive' | 'powerActive' | 'seconds' - expires?: string -} +```typescript + +```` + ``` See also: -string -'use' | 'manage' | 'provide' + + + + --- +``` diff --git a/apis/next/manage/VoiceGuidance/index.md b/apis/next/manage/VoiceGuidance/index.md index 3d3efb2d9..7c4ed28c5 100644 --- a/apis/next/manage/VoiceGuidance/index.md +++ b/apis/next/manage/VoiceGuidance/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version VoiceGuidance 1.1.1-next.2 +Version VoiceGuidance 1.2.0-next.1 ## Table of Contents @@ -25,6 +25,7 @@ Version VoiceGuidance 1.1.1-next.2 - [Events](#events) - [enabledChanged](#enabledchanged) - [speedChanged](#speedchanged) +- [Types](#types) ## Usage @@ -47,7 +48,7 @@ Whether or not voice-guidance is enabled. To get the value of `enabled` call the method like this: ```typescript -function enabled(): Promise +${method.signature} ``` Promise resolution: @@ -153,7 +154,8 @@ Response: To set the value of `enabled` call the method like this: ```typescript -function enabled(value: boolean): Promise +function enabled(| `value` | [`boolean`](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: @@ -165,7 +167,7 @@ Parameters: Promise resolution: ```typescript -null + ``` #### Examples @@ -485,12 +487,14 @@ The speed at which voice guidance speech will be read back to the user. To get the value of `speed` call the method like this: ```typescript -function speed(): Promise +${method.signature} ``` Promise resolution: -[VoiceSpeed](../Accessibility/schemas/#VoiceSpeed) +```typescript + +``` Capabilities: @@ -589,20 +593,21 @@ Response: To set the value of `speed` call the method like this: ```typescript -function speed(value: VoiceSpeed): Promise +function speed(| `value` | [``](${method.param.link}) | ${method.param.required} | ${method.param.summary} ${method.param.constraints} | +): Promise ``` Parameters: -| Param | Type | Required | Description | -| ---------- | ---------------------------------------------------- | -------- | ----------------- | -| `value` | [`VoiceSpeed`](../Accessibility/schemas/#VoiceSpeed) | true |
minumum: 0.5 | +| Param | Type | Required | Description | +| ---------- | ---- | -------- | ------------ | +| `value` | `` | true | minumum: 0.5 | | maximum: 2 | Promise resolution: ```typescript -null + ``` #### Examples @@ -700,7 +705,7 @@ Response: To subscribe to notifications when the value changes, call the method like this: ```typescript -function speed(callback: (value) => VoiceSpeed): Promise +function speed(callback: (value) => ): Promise ``` Promise resolution: @@ -814,3 +819,5 @@ See: [enabled](#enabled) ### speedChanged See: [speed](#speed) + +## Types diff --git a/apis/next/manage/Wifi/index.md b/apis/next/manage/Wifi/index.md index 7ee6a9e59..dc6bb2de3 100644 --- a/apis/next/manage/Wifi/index.md +++ b/apis/next/manage/Wifi/index.md @@ -10,7 +10,7 @@ sdk: manage --- -Version Wifi 1.1.1-next.2 +Version Wifi 1.2.0-next.1 ## Table of Contents @@ -49,33 +49,36 @@ A module for providing support for Wifi. Connect the device to the specified SSID. ```typescript -function connect( - ssid?: string, - passphrase?: string, - security?: WifiSecurityMode, -): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------ | --------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssid` | `string` | false | | -| `passphrase` | `string` | false | | -| `security` | [`WifiSecurityMode`](#wifisecuritymode) | false |
values: `'none' \| 'wep64' \| 'wep128' \| 'wpaPskTkip' \| 'wpaPskAes' \| 'wpa2PskTkip' \| 'wpa2PskAes' \| 'wpaEnterpriseTkip' \| 'wpaEnterpriseAes' \| 'wpa2EnterpriseTkip' \| 'wpa2EnterpriseAes' \| 'wpa2Psk' \| 'wpa2Enterprise' \| 'wpa3PskAes' \| 'wpa3Sae'` | +| Param | Type | Required | Description | +| ------------ | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ssid` | `string` | false | | +| `passphrase` | `string` | false | | +| `security` | `` | false | values: `'none' \| 'wep64' \| 'wep128' \| 'wpaPskTkip' \| 'wpaPskAes' \| 'wpa2PskTkip' \| 'wpa2PskAes' \| 'wpaEnterpriseTkip' \| 'wpaEnterpriseAes' \| 'wpa2EnterpriseTkip' \| 'wpa2EnterpriseAes' \| 'wpa2Psk' \| 'wpa2Enterprise' \| 'wpa3PskAes' \| 'wpa3Sae'` | Promise resolution: -[AccessPoint](#accesspoint) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:protocol:wifi | + #### Examples + Connect to a wpa2Psk Wifi with password JavaScript: @@ -83,9 +86,9 @@ JavaScript: ```javascript import { Wifi } from '@firebolt-js/manage-sdk' -let connectedWifi = await Wifi.connect('DND', 'gargoyle', 'wpa2Psk') +let connectedWifi = await Wifi.connect("DND", "gargoyle", "wpa2Psk") console.log(connectedWifi) -``` +```` Value of `connectedWifi`: @@ -195,7 +198,7 @@ Response: Disconnect the device if connected via WIFI. ```typescript -function disconnect(): Promise +${method.signature} ``` Promise resolution: @@ -261,28 +264,35 @@ Response: Scan available wifi networks in the location. ```typescript -function scan(timeout?: Timeout): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ------------- | -------------------------------------- | -------- | --------------- | -| `timeout` | [`Timeout`](../Types/schemas/#Timeout) | false |
minumum: 0 | +| Param | Type | Required | Description | +| ------------- | ---- | -------- | ----------- | +| `timeout` | `` | false | minumum: 0 | | maximum: 9999 | Promise resolution: -[AccessPointList](#accesspointlist) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:protocol:wifi | + #### Examples + Successful Wifi List JavaScript: @@ -292,7 +302,7 @@ import { Wifi } from '@firebolt-js/manage-sdk' let list = await Wifi.scan(30) console.log(list) -``` +```` Value of `list`: @@ -376,27 +386,34 @@ Response: Connect to WPS ```typescript -function wps(security?: WPSSecurityPin): Promise +${method.signature} ``` Parameters: -| Param | Type | Required | Description | -| ---------- | ----------------------------------- | -------- | --------------------------------------------------------- | -| `security` | [`WPSSecurityPin`](#wpssecuritypin) | false |
values: `'pushButton' \| 'pin' \| 'manufacturerPin'` | +| Param | Type | Required | Description | +| ---------- | ---- | -------- | ---------------------------------------------------- | +| `security` | `` | false | values: `'pushButton' \| 'pin' \| 'manufacturerPin'` | Promise resolution: -[AccessPoint](#accesspoint) +````typescript +```typescript + +```` + +```` Capabilities: -| Role | Capability | -| ---- | ------------------------------------- | +| Role | Capability | +| --------------------- | -------------------------- | | uses | xrn:firebolt:capability:protocol:wifi | + #### Examples + Connect to a WPS Wifi router JavaScript: @@ -404,9 +421,9 @@ JavaScript: ```javascript import { Wifi } from '@firebolt-js/manage-sdk' -let connectedWifi = await Wifi.wps('pushButton') +let connectedWifi = await Wifi.wps("pushButton") console.log(connectedWifi) -``` +```` Value of `connectedWifi`: @@ -460,23 +477,26 @@ Response: Security Mode supported for Wifi ```typescript -enum WifiSecurityMode { - NONE = 'none', - WEP_64 = 'wep64', - WEP_128 = 'wep128', - WPA_PSK_TKIP = 'wpaPskTkip', - WPA_PSK_AES = 'wpaPskAes', - WPA_2PSK_TKIP = 'wpa2PskTkip', - WPA_2PSK_AES = 'wpa2PskAes', - WPA_ENTERPRISE_TKIP = 'wpaEnterpriseTkip', - WPA_ENTERPRISE_AES = 'wpaEnterpriseAes', - WPA_2ENTERPRISE_TKIP = 'wpa2EnterpriseTkip', - WPA_2ENTERPRISE_AES = 'wpa2EnterpriseAes', - WPA_2PSK = 'wpa2Psk', - WPA_2ENTERPRISE = 'wpa2Enterprise', - WPA_3PSK_AES = 'wpa3PskAes', - WPA_3SAE = 'wpa3Sae', -} +WifiSecurityMode Enumeration: + +| key | value | +|-----|-------| +| NONE | none | +| WEP_64 | wep64 | +| WEP_128 | wep128 | +| WPA_PSK_TKIP | wpaPskTkip | +| WPA_PSK_AES | wpaPskAes | +| WPA_2PSK_TKIP | wpa2PskTkip | +| WPA_2PSK_AES | wpa2PskAes | +| WPA_ENTERPRISE_TKIP | wpaEnterpriseTkip | +| WPA_ENTERPRISE_AES | wpaEnterpriseAes | +| WPA_2ENTERPRISE_TKIP | wpa2EnterpriseTkip | +| WPA_2ENTERPRISE_AES | wpa2EnterpriseAes | +| WPA_2PSK | wpa2Psk | +| WPA_2ENTERPRISE | wpa2Enterprise | +| WPA_3PSK_AES | wpa3PskAes | +| WPA_3SAE | wpa3Sae | + ``` --- @@ -486,11 +506,14 @@ enum WifiSecurityMode { Security pin type for WPS(Wifi Protected Setup). ```typescript -enum WPSSecurityPin { - PUSH_BUTTON = 'pushButton', - PIN = 'pin', - MANUFACTURER_PIN = 'manufacturerPin', -} +WPSSecurityPin Enumeration: + +| key | value | +|-----|-------| +| PUSH_BUTTON | pushButton | +| PIN | pin | +| MANUFACTURER_PIN | manufacturerPin | + ``` --- @@ -500,7 +523,7 @@ enum WPSSecurityPin { Strength of Wifi signal, value is negative based on RSSI specification. ```typescript -type WifiSignalStrength = number + ``` --- @@ -510,7 +533,7 @@ type WifiSignalStrength = number Wifi Frequency in Ghz, example 2.4Ghz and 5Ghz. ```typescript -type WifiFrequency = number + ``` --- @@ -519,20 +542,18 @@ type WifiFrequency = number Properties of a scanned wifi list item. +````typescript ```typescript -type AccessPoint = { - ssid?: string // Name of the wifi. - securityMode?: WifiSecurityMode // Security Mode supported for Wifi - signalStrength?: WifiSignalStrength // Strength of Wifi signal, value is negative based on RSSI specification. - frequency?: WifiFrequency // Wifi Frequency in Ghz, example 2.4Ghz and 5Ghz. -} -``` + +```` + +```` See also: -'none' | 'wep64' | 'wep128' | 'wpaPskTkip' | 'wpaPskAes' | 'wpa2PskTkip' | 'wpa2PskAes' | 'wpaEnterpriseTkip' | 'wpaEnterpriseAes' | 'wpa2EnterpriseTkip' | 'wpa2EnterpriseAes' | 'wpa2Psk' | 'wpa2Enterprise' | 'wpa3PskAes' | 'wpa3Sae' -number -number + + + --- @@ -541,13 +562,15 @@ number List of scanned Wifi networks available near the device. ```typescript -type AccessPointList = { - list?: AccessPoint[] -} +```typescript + +```` + ``` See also: -[AccessPoint](#accesspoint) + --- +``` diff --git a/requirements/next/specifications/firebolt-open-rpc.json b/requirements/next/specifications/firebolt-open-rpc.json index 4f9111041..7acd98667 100644 --- a/requirements/next/specifications/firebolt-open-rpc.json +++ b/requirements/next/specifications/firebolt-open-rpc.json @@ -2,7 +2,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.1.1-next.2", + "version": "1.2.0-next.1", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -9583,7 +9583,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Prompt the user for their email address with a simplified list of choices.", @@ -9656,7 +9657,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Show the password entry keyboard, with typing obfuscated from visibility", @@ -9700,7 +9702,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Show the standard platform keyboard, and return the submitted value", diff --git a/requirements/next/specifications/firebolt-specification.json b/requirements/next/specifications/firebolt-specification.json index 32e86facd..f33eb5651 100644 --- a/requirements/next/specifications/firebolt-specification.json +++ b/requirements/next/specifications/firebolt-specification.json @@ -912,7 +912,7 @@ "openrpc": "1.2.4", "info": { "title": "Firebolt JSON-RPC API", - "version": "1.1.1-next.2", + "version": "1.2.0-next.1", "x-module-descriptions": { "Internal": "Internal methods for SDK / FEE integration", "Accessibility": "The `Accessibility` module provides access to the user/device settings for closed captioning and voice guidance.\n\nApps **SHOULD** attempt o respect these settings, rather than manage and persist seprate settings, which would be different per-app.", @@ -10493,7 +10493,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Prompt the user for their email address with a simplified list of choices.", @@ -10566,7 +10567,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Show the password entry keyboard, with typing obfuscated from visibility", @@ -10610,7 +10612,8 @@ "name": "capabilities", "x-uses": [ "xrn:firebolt:capability:input:keyboard" - ] + ], + "x-allow-focus": true } ], "summary": "Show the standard platform keyboard, and return the submitted value",