--- title: "Discovery" slug: "170-core-discovery" updated: 2026-01-05T19:54:40Z published: 2026-01-05T19:54:40Z canonical: "docs.developer.comcast.com/170-core-discovery" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.developer.comcast.com/llms.txt > Use this file to discover all available pages before exploring further. # Discovery **Discovery Module 1.7.0 | Core SDK** ## Usage To use the Discovery module, you can import it into your project from the Firebolt SDK: ``` import { Discovery } from '@firebolt-js/sdk' ``` ## Overview Your App likely wants to integrate with the Platform's discovery capabilities. For example to add a "Watch Next" tile that links to your app from the platform's home screen. Getting access to this information requires to connect to lower level APIs made available by the platform. Since implementations differ between operators and platforms, the Firebolt SDK offers a Discovery module, that exposes a generic, agnostic interface to the developer. Under the hood, an underlaying transport layer will then take care of calling the right APIs for the actual platform implementation that your App is running on. The Discovery plugin is used to *send* information to the Platform. ### Localization Apps should provide all user-facing strings in the device's language, as specified by the Firebolt `Localization.language` property. Apps should provide prices in the same currency presented in the app. If multiple currencies are supported in the app, the app should provide prices in the user's current default currency. ## Methods ### clearContentAccess 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. ``` function clearContentAccess(): Promise ``` Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:content-access | #### Examples Clear subscriber's availabilities and entitlements JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.clearContentAccess() console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.clearContentAccess", "params": {} } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` --- ### contentAccess 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. ``` function contentAccess(ids: ContentAccessIdentifiers): Promise ``` Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `ids` | [`ContentAccessIdentifiers`](/docs/170-core-discovery#contentaccessidentifiers) | true | A list of identifiers that represent content that is discoverable or consumable for the subscriber | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:content-access | #### Examples Update subscriber's availabilities JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.contentAccess({ availabilities: [ { type: 'channel-lineup', id: 'partner.com/availability/123', startTime: '2021-04-23T18:25:43.511Z', endTime: '2021-04-23T18:25:43.511Z', }, { type: 'channel-lineup', id: 'partner.com/availability/456', startTime: '2021-04-23T18:25:43.511Z', endTime: '2021-04-23T18:25:43.511Z', }, ], }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.contentAccess", "params": { "ids": { "availabilities": [ { "type": "channel-lineup", "id": "partner.com/availability/123", "startTime": "2021-04-23T18:25:43.511Z", "endTime": "2021-04-23T18:25:43.511Z" }, { "type": "channel-lineup", "id": "partner.com/availability/456", "startTime": "2021-04-23T18:25:43.511Z", "endTime": "2021-04-23T18:25:43.511Z" } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` Update subscriber's availabilities and entitlements JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.contentAccess({ availabilities: [ { type: 'channel-lineup', id: 'partner.com/availability/123', startTime: '2021-04-23T18:25:43.511Z', endTime: '2021-04-23T18:25:43.511Z', }, { type: 'channel-lineup', id: 'partner.com/availability/456', startTime: '2021-04-23T18:25:43.511Z', endTime: '2021-04-23T18:25:43.511Z', }, ], entitlements: [ { entitlementId: '123', startTime: '2025-01-01T00:00:00.000Z', endTime: '2025-01-01T00:00:00.000Z', }, ], }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.contentAccess", "params": { "ids": { "availabilities": [ { "type": "channel-lineup", "id": "partner.com/availability/123", "startTime": "2021-04-23T18:25:43.511Z", "endTime": "2021-04-23T18:25:43.511Z" }, { "type": "channel-lineup", "id": "partner.com/availability/456", "startTime": "2021-04-23T18:25:43.511Z", "endTime": "2021-04-23T18:25:43.511Z" } ], "entitlements": [ { "entitlementId": "123", "startTime": "2025-01-01T00:00:00.000Z", "endTime": "2025-01-01T00:00:00.000Z" } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` Update subscriber's entitlements JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.contentAccess({ entitlements: [ { entitlementId: '123', startTime: '2025-01-01T00:00:00.000Z', endTime: '2025-01-01T00:00:00.000Z', }, ], }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.contentAccess", "params": { "ids": { "entitlements": [ { "entitlementId": "123", "startTime": "2025-01-01T00:00:00.000Z", "endTime": "2025-01-01T00:00:00.000Z" } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` Clear a subscriber's entitlements JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.contentAccess({ entitlements: [] }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.contentAccess", "params": { "ids": { "entitlements": [] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` Clear a subscriber's availabilities JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.contentAccess({ availabilities: [] }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.contentAccess", "params": { "ids": { "availabilities": [] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` --- ### entitlements [Deprecated] This method is deprecated as of since version 0.10.0. Please use `Discovery.contentAccess()` as a replacement. ``` function entitlements(entitlements: Entitlement[]): Promise ``` --- ### entityInfo Provide information about a program entity and its available watchable assets, such as entitlement status and price, via either a push or pull call flow. Includes information about the program entity and its relevant associated entities, such as extras, previews, and, in the case of TV series, seasons and episodes. See the `EntityInfo` and `WayToWatch` data structures below for more information. The app only needs to implement Pull support for `entityInfo` at this time. To allow the platform to pull data, use `entityInfo(callback: Function)`: ``` function entityInfo( callback: (parameters: EntityInfoParameters) => Promise, ): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `callback` | `Function` | Yes | A callback for the platform to pull EntityInfoResult objects | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `parameters` | `EntityInfoParameters` | Yes | An object describing the platform's query for an `EntityInfoResult` object. | ``` type EntityInfoParameters = { entityId: string assetId?: string } ``` Callback promise resolution: ``` 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: [EntityInfoResult](/docs/170-core-discovery#entityinforesult-1) #### Examples Send entity info for a movie to the platform. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' 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'], }, ], }, } }) console.log(success) ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onPullEntityInfo", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "correlationId": "xyz", "parameters": { "entityId": "345" } } } ``` Push Request: ``` { "jsonrpc": "2.0", "id": 2, "method": "Discovery.entityInfo", "params": { "correlationId": "TBD", "result": { "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"] } ] } } } } ``` Send entity info for a movie with a trailer to the platform. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' 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'], }, ], }, related: [ { identifiers: { entityId: '345', }, entityType: 'program', programType: 'preview', title: 'Cool Runnings Trailer', waysToWatch: [ { identifiers: { assetId: '123111', entityId: '345', }, entitled: true, videoQuality: ['HD'], audioProfile: ['dolbyAtmos'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, ], } }) console.log(success) ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onPullEntityInfo", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "correlationId": "xyz", "parameters": { "entityId": "345" } } } ``` Push Request: ``` { "jsonrpc": "2.0", "id": 2, "method": "Discovery.entityInfo", "params": { "correlationId": "TBD", "result": { "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"] } ] }, "related": [ { "identifiers": { "entityId": "345" }, "entityType": "program", "programType": "preview", "title": "Cool Runnings Trailer", "waysToWatch": [ { "identifiers": { "assetId": "123111", "entityId": "345" }, "entitled": true, "videoQuality": ["HD"], "audioProfile": ["dolbyAtmos"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] } ] } } } ``` Send entity info for a TV Series with seasons and episodes to the platform. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' 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: '98765', }, entityType: 'program', programType: 'series', title: 'Perfect Strangers', 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: '1986-01-01T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], }, related: [ { identifiers: { entityId: '111', seriesId: '98765', }, entityType: 'program', programType: 'season', seasonNumber: 1, title: 'Perfect Strangers Season 3', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '556', entityId: '111', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, { identifiers: { entityId: '111', seriesId: '98765', }, entityType: 'program', programType: 'episode', seasonNumber: 1, episodeNumber: 1, title: "Knock Knock, Who's There?", 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: '1986-03-25T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '556', entityId: '111', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, { identifiers: { entityId: '112', seriesId: '98765', }, entityType: 'program', programType: 'episode', seasonNumber: 1, episodeNumber: 2, title: 'Picture This', 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: '1986-04-01T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '557', entityId: '112', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, ], } }) console.log(success) ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onPullEntityInfo", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "correlationId": "xyz", "parameters": { "entityId": "345" } } } ``` Push Request: ``` { "jsonrpc": "2.0", "id": 2, "method": "Discovery.entityInfo", "params": { "correlationId": "TBD", "result": { "expires": "2025-01-01T00:00:00.000Z", "entity": { "identifiers": { "entityId": "98765" }, "entityType": "program", "programType": "series", "title": "Perfect Strangers", "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": "1986-01-01T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ] }, "related": [ { "identifiers": { "entityId": "111", "seriesId": "98765" }, "entityType": "program", "programType": "season", "seasonNumber": 1, "title": "Perfect Strangers Season 3", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "556", "entityId": "111", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] }, { "identifiers": { "entityId": "111", "seriesId": "98765" }, "entityType": "program", "programType": "episode", "seasonNumber": 1, "episodeNumber": 1, "title": "Knock Knock, Who's There?", "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": "1986-03-25T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "556", "entityId": "111", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] }, { "identifiers": { "entityId": "112", "seriesId": "98765" }, "entityType": "program", "programType": "episode", "seasonNumber": 1, "episodeNumber": 2, "title": "Picture This", "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": "1986-04-01T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "557", "entityId": "112", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] } ] } } } ``` To push data to the platform, e.g. during app launch, use `entityInfo(result: EntityInfoResult)`: ``` function entityInfo(result: EntityInfoResult): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `result` | `EntityInfoResult` | Yes | The `EntityInfoResult` data to push to the platform | ``` 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](/docs/170-core-discovery#entityinfo-1) Promise resolution: | Type | Summary | | --- | --- | | `boolean` | Whether or not the push was successful | #### Examples Send entity info for a movie to the platform. 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'], }, ], }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.entityInfo", "params": { "correlationId": null, "result": { "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"] } ] } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Send entity info for a movie with a trailer to the platform. 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'], }, ], }, related: [ { identifiers: { entityId: '345', }, entityType: 'program', programType: 'preview', title: 'Cool Runnings Trailer', waysToWatch: [ { identifiers: { assetId: '123111', entityId: '345', }, entitled: true, videoQuality: ['HD'], audioProfile: ['dolbyAtmos'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, ], }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.entityInfo", "params": { "correlationId": null, "result": { "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"] } ] }, "related": [ { "identifiers": { "entityId": "345" }, "entityType": "program", "programType": "preview", "title": "Cool Runnings Trailer", "waysToWatch": [ { "identifiers": { "assetId": "123111", "entityId": "345" }, "entitled": true, "videoQuality": ["HD"], "audioProfile": ["dolbyAtmos"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Send entity info for a TV Series with seasons and episodes to the platform. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.entityInfo({ expires: '2025-01-01T00:00:00.000Z', entity: { identifiers: { entityId: '98765', }, entityType: 'program', programType: 'series', title: 'Perfect Strangers', 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: '1986-01-01T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], }, related: [ { identifiers: { entityId: '111', seriesId: '98765', }, entityType: 'program', programType: 'season', seasonNumber: 1, title: 'Perfect Strangers Season 3', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '556', entityId: '111', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, { identifiers: { entityId: '111', seriesId: '98765', }, entityType: 'program', programType: 'episode', seasonNumber: 1, episodeNumber: 1, title: "Knock Knock, Who's There?", 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: '1986-03-25T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '556', entityId: '111', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, { identifiers: { entityId: '112', seriesId: '98765', }, entityType: 'program', programType: 'episode', seasonNumber: 1, episodeNumber: 2, title: 'Picture This', 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: '1986-04-01T00:00:00.000Z', contentRatings: [ { scheme: 'US-TV', rating: 'TV-PG', }, ], waysToWatch: [ { identifiers: { assetId: '557', entityId: '112', seriesId: '98765', }, entitled: true, offeringType: 'free', videoQuality: ['SD'], audioProfile: ['stereo'], audioLanguages: ['en'], closedCaptions: ['en'], }, ], }, ], }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.entityInfo", "params": { "correlationId": null, "result": { "expires": "2025-01-01T00:00:00.000Z", "entity": { "identifiers": { "entityId": "98765" }, "entityType": "program", "programType": "series", "title": "Perfect Strangers", "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": "1986-01-01T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ] }, "related": [ { "identifiers": { "entityId": "111", "seriesId": "98765" }, "entityType": "program", "programType": "season", "seasonNumber": 1, "title": "Perfect Strangers Season 3", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "556", "entityId": "111", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] }, { "identifiers": { "entityId": "111", "seriesId": "98765" }, "entityType": "program", "programType": "episode", "seasonNumber": 1, "episodeNumber": 1, "title": "Knock Knock, Who's There?", "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": "1986-03-25T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "556", "entityId": "111", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] }, { "identifiers": { "entityId": "112", "seriesId": "98765" }, "entityType": "program", "programType": "episode", "seasonNumber": 1, "episodeNumber": 2, "title": "Picture This", "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": "1986-04-01T00:00:00.000Z", "contentRatings": [ { "scheme": "US-TV", "rating": "TV-PG" } ], "waysToWatch": [ { "identifiers": { "assetId": "557", "entityId": "112", "seriesId": "98765" }, "entitled": true, "offeringType": "free", "videoQuality": ["SD"], "audioProfile": ["stereo"], "audioLanguages": ["en"], "closedCaptions": ["en"] } ] } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### launch Launch or foreground the specified app, and optionally instructs it to navigate to the specified user action. For the Primary Experience, the appId can be any one of: - xrn:firebolt:application-type:main - xrn:firebolt:application-type:settings ``` function launch(appId: string, intent: NavigationIntent): Promise ``` Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `appId` | `string` | true | The durable app Id of the app to launch | | `intent` | [`NavigationIntent`](/docs/170-core-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 | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:lifecycle:launch | #### Examples Launch the 'Foo' app to it's home screen. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('foo', { action: 'home', context: { source: 'voice' }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "foo", "intent": { "action": "home", "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the 'Foo' app to it's home screen where the launch intent came from a child-directed browse menu. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('foo', { action: 'home', context: { source: 'browse' }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "foo", "intent": { "action": "home", "context": { "source": "browse" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the 'Foo' app to it's own page for a specific entity. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('foo', { action: 'entity', data: { entityType: 'program', programType: 'movie', entityId: 'example-movie-id', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "foo", "intent": { "action": "entity", "data": { "entityType": "program", "programType": "movie", "entityId": "example-movie-id" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the 'Foo' app to a fullscreen playback experience for a specific entity. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('foo', { action: 'playback', data: { entityType: 'program', programType: 'movie', entityId: 'example-movie-id', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "foo", "intent": { "action": "playback", "data": { "entityType": "program", "programType": "movie", "entityId": "example-movie-id" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to a global page for a specific entity. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main', { action: 'entity', data: { entityType: 'program', programType: 'movie', entityId: 'example-movie-id', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main", "intent": { "action": "entity", "data": { "entityType": "program", "programType": "movie", "entityId": "example-movie-id" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to a global page for the company / partner with the ID 'foo'. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main', { action: 'section', data: { sectionName: 'company:foo', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main", "intent": { "action": "section", "data": { "sectionName": "company:foo" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to it's home screen, as if the Home remote button was pressed. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main', { action: 'home', context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main", "intent": { "action": "home", "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to it's search screen. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main', { action: 'search', context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main", "intent": { "action": "search", "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to it's settings screen. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:settings', { action: 'section', data: { sectionName: 'settings', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:settings", "intent": { "action": "section", "data": { "sectionName": "settings" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to it's linear/epg guide. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main', { action: 'section', data: { sectionName: 'guide', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main", "intent": { "action": "section", "data": { "sectionName": "guide" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Launch the Aggregated Experience to the App Store details page for a specific app with the ID 'foo'. JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.launch('xrn:firebolt:application-type:main ', { action: 'section', data: { sectionName: 'app:foo', }, context: { source: 'voice', }, }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.launch", "params": { "appId": "xrn:firebolt:application-type:main ", "intent": { "action": "section", "data": { "sectionName": "app:foo" }, "context": { "source": "voice" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### listen To listen to a specific event pass the event name as the first parameter: ``` listen(event: string, callback: (data: any) => void): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `event` | `string` | Yes | The event to listen for, see [Events](/docs/170-core-discovery#events). | | *callback* | `function` | Yes | A function that will be invoked when the event occurs. | Promise resolution: | Type | Description | | --- | --- | | `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Discovery.clear(id)` | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/170-core-discovery#events). | To listen to all events from this module pass only a callback, without specifying an event name: ``` listen(callback: (event: string, data: any) => void): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | *callback* | `function` | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see [Events](/docs/170-core-discovery#events). | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `event` | `string` | Yes | The event that has occured listen for, see [Events](/docs/170-core-discovery#events). | | `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/170-core-discovery#events). | Promise resolution: | Type | Description | | --- | --- | | `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Discovery.clear(id)` | See [Listening for events](/docs/listening-for-events/) for more information and examples. ### once To listen to a single instance of a specific event pass the event name as the first parameter: ``` once(event: string, callback: (data: any) => void): Promise ``` The `once` method will only pass the next instance of this event, and then dicard the listener you provided. Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `event` | `string` | Yes | The event to listen for, see [Events](/docs/170-core-discovery#events). | | *callback* | `function` | Yes | A function that will be invoked when the event occurs. | Promise resolution: | Type | Description | | --- | --- | | `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Discovery.clear(id)` | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/170-core-discovery#events). | To listen to the next instance only of any events from this module pass only a callback, without specifying an event name: ``` once(callback: (event: string, data: any) => void): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | *callback* | `function` | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see [Events](/docs/170-core-discovery#events). | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `event` | `string` | Yes | The event that has occured listen for, see [Events](/docs/170-core-discovery#events). | | `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/170-core-discovery#events). | Promise resolution: | Type | Description | | --- | --- | | `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Discovery.clear(id)` | See [Listening for events](/docs/listening-for-events/) for more information and examples. ### policy Get the discovery policy To get the value of `policy` call the method like this: ``` function policy(): Promise ``` Promise resolution: [DiscoveryPolicy](/docs/170-core-discovery#discoverypolicy) Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:policy | #### Examples Getting the discovery policy JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let policy = await Discovery.policy() console.log(policy) ``` Value of `policy`: ``` { "enableRecommendations": true, "shareWatchHistory": true, "rememberWatchedPrograms": true } ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.policy", "params": {} } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "enableRecommendations": true, "shareWatchHistory": true, "rememberWatchedPrograms": true } } ``` --- To subscribe to notifications when the value changes, call the method like this: ``` function policy(callback: (value) => DiscoveryPolicy): Promise ``` Promise resolution: ``` number ``` #### Examples Getting the discovery policy JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let listenerId = await policy((value) => { console.log(value) }) console.log(listenerId) ``` Value of `policy`: ``` { "enableRecommendations": true, "shareWatchHistory": true, "rememberWatchedPrograms": true } ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onPolicyChanged", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "enableRecommendations": true, "shareWatchHistory": true, "rememberWatchedPrograms": true } } ``` --- ### provide To provide a specific capability to the platform. See [Provider Interfaces](/docs/170-core-discovery#provider-interfaces) for a list of interfaces available to provide in this module. ``` provide(capability: string, provider: any): void ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `capability` | `string` | Yes | The capability that is being provided. | | `provider` | `any` | Yes | An implementation of the required interface. | See [Provider Interfaces](/docs/170-core-discovery#provider-interfaces) for each capabilities interface definition. ### purchasedContent Return content purchased by the user, such as rentals and electronic sell through purchases. The app should return the user's 100 most recent purchases in `entries`. The total count of purchases must be provided in `count`. If `count` is greater than the total number of `entries`, the UI may provide a link into the app to see the complete purchase list. The `EntityInfo` object returned is not required to have `waysToWatch` populated, but it is recommended that it do so in case the UI wants to surface additional information on the purchases screen. The app should implement both Push and Pull methods for `purchasedContent`. The app should actively push `purchasedContent` when: - The app becomes Active. - When the state of the purchasedContent set has changed. - The app goes into Inactive or Background state, if there is a chance a change event has been missed. To allow the platform to pull data, use `purchasedContent(callback: Function)`: ``` function purchasedContent( callback: ( parameters: PurchasedContentParameters, ) => Promise, ): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `callback` | `Function` | Yes | A callback for the platform to pull PurchasedContentResult objects | Callback parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `parameters` | `PurchasedContentParameters` | Yes | An object describing the platform's query for an `PurchasedContentResult` object. | ``` 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: ``` type PurchasedContentResult = { expires: string totalCount: number entries: EntityInfo[] } ``` See also: [PurchasedContentResult](/docs/170-core-discovery#purchasedcontentresult-1) #### Examples Inform the platform of the user's purchased content JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' 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'], }, ], }, ], } }) console.log(success) ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onPullPurchasedContent", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "correlationId": "xyz", "parameters": { "limit": 100 } } } ``` Push Request: ``` { "jsonrpc": "2.0", "id": 2, "method": "Discovery.purchasedContent", "params": { "correlationId": "TBD", "result": { "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"] } ] } ] } } } ``` To push data to the platform, e.g. during app launch, use `purchasedContent(result: PurchasedContentResult)`: ``` function purchasedContent(result: PurchasedContentResult): Promise ``` Parameters: | Param | Type | Required | Summary | | --- | --- | --- | --- | | `result` | `PurchasedContentResult` | Yes | The `PurchasedContentResult` data to push to the platform | ``` type PurchasedContentResult = { expires: string totalCount: number entries: EntityInfo[] } ``` See also: [PurchasedContent](/docs/170-core-discovery#purchasedcontent-1) Promise resolution: | Type | Summary | | --- | --- | | `boolean` | Whether or not the push was successful | #### Examples Inform the platform of the user's purchased content 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'], }, ], }, ], }) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.purchasedContent", "params": { "correlationId": null, "result": { "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"] } ] } ] } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### signIn 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. ``` function signIn(entitlements: Entitlement[]): Promise ``` 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. | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:sign-in-status | #### Examples Send signIn metric JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.signIn() console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.signIn", "params": {} } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Send signIn notification with entitlements JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.signIn([ { entitlementId: '123', startTime: '2025-01-01T00:00:00.000Z', endTime: '2025-01-01T00:00:00.000Z', }, ]) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.signIn", "params": { "entitlements": [ { "entitlementId": "123", "startTime": "2025-01-01T00:00:00.000Z", "endTime": "2025-01-01T00:00:00.000Z" } ] } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### signOut 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. ``` function signOut(): Promise ``` Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:sign-in-status | #### Examples Send signOut notification JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.signOut() console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.signOut", "params": {} } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### userInterest Send an entity that the user has expressed interest in to the platform. ``` function userInterest( type: InterestType, reason: InterestReason, entity: EntityDetails, ): Promise ``` Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `type` | [`InterestType`](/docs/170-core-Discovery-schemas#InterestType) | true | values: `'interest' \| 'disinterest'` | | `reason` | [`InterestReason`](/docs/170-core-Discovery-schemas#InterestReason) | true | values: `'playlist' \| 'reaction' \| 'recording'` | | `entity` | [`EntityDetails`](/docs/170-core-Entity-schemas#EntityDetails) | true | | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | provides | xrn:firebolt:capability:discovery:interest | #### Examples Default Example JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let result = await Discovery.userInterest('interest', 'playlist', { identifiers: { entityId: '345', entityType: 'program', programType: 'movie', }, info: {}, }) console.log(result) ``` Value of `result`: ``` null ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.userInterest", "params": { "type": "interest", "reason": "playlist", "entity": { "identifiers": { "entityId": "345", "entityType": "program", "programType": "movie" }, "info": {} } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` --- ### watched Notify the platform that content was partially or completely watched ``` function watched( entityId: string, progress: number, completed: boolean, watchedOn: string, agePolicy: AgePolicy, ): Promise ``` Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `entityId` | `string` | true | The entity Id of the watched content. | | `progress` | `number` | false | How much of the content has been watched (percentage as (0-0.999) for VOD, number of seconds for live) minumum: 0 | | `completed` | `boolean` | false | Whether or not this viewing is considered "complete," per the app's definition thereof | | `watchedOn` | `string` | false | Date/Time the content was watched, ISO 8601 Date/Time format: date-time | | `agePolicy` | [`AgePolicy`](/docs/170-core-Policies-schemas#AgePolicy) | false | The age policy to associate with the discovery event. The age policy describes the age group to which content is directed. | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:watched | #### Examples Notify the platform of watched content JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.watched( 'partner.com/entity/123', 0.95, true, '2021-04-23T18:25:43.511Z', ) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.watched", "params": { "entityId": "partner.com/entity/123", "progress": 0.95, "completed": true, "watchedOn": "2021-04-23T18:25:43.511Z" } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Notify the platform that child-directed content was watched JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.watched( 'partner.com/entity/123', 0.95, true, '2021-04-23T18:25:43.511Z', 'app:child', ) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.watched", "params": { "entityId": "partner.com/entity/123", "progress": 0.95, "completed": true, "watchedOn": "2021-04-23T18:25:43.511Z", "agePolicy": "app:child" } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ### watchNext Suggest a call-to-action for this app on the platform home screen ``` function watchNext( title: LocalizedString, identifiers: ContentIdentifiers, expires: string, images: object, ): Promise ``` Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `title` | [`LocalizedString`](/docs/170-core-Types-schemas#LocalizedString) | true | The title of this call to action | | `identifiers` | [`ContentIdentifiers`](/docs/170-core-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 | Promise resolution: Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:watch-next | #### Examples Suggest a watch-next tile for the home screen JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.watchNext( 'A Cool Show', { entityId: 'partner.com/entity/123', }, '2021-04-23T18:25:43.511Z', { '3x4': { 'en-US': 'https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg', es: 'https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg', }, '16x9': { en: 'https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg', }, }, ) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.watchNext", "params": { "title": "A Cool Show", "identifiers": { "entityId": "partner.com/entity/123" }, "expires": "2021-04-23T18:25:43.511Z", "images": { "3x4": { "en-US": "https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg", "es": "https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg" }, "16x9": { "en": "https://i.ytimg.com/vi/4r7wHMg5Yjg/maxresdefault.jpg" } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` Suggest a watch-next tile for the home screen JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' let success = await Discovery.watchNext( 'A Fantastic Show', { entityId: 'partner.com/entity/456' }, undefined, ) console.log(success) ``` Value of `success`: ``` true ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.watchNext", "params": { "title": "A Fantastic Show", "identifiers": { "entityId": "partner.com/entity/456" } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": true } ``` --- ## Private Methods **View** ### userInterestError *This is a private RPC method.* Internal API for .onRequestUserInterest Provider to send back error. Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `correlationId` | `string` | true | | | `error` | `object` | true | | Result: Capabilities: | Role | Capability | | --- | --- | | provides | xrn:firebolt:capability:discovery:interest | #### Examples Example 1 JSON-RPC: Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.userInterestError", "params": { "correlationId": "123", "error": { "code": 1, "message": "Error" } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` --- ### userInterestResponse *This is a private RPC method.* Internal API for .onRequestUserInterest Provider to send back response. Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `correlationId` | `string` | true | | | `result` | [`EntityDetails`](/docs/170-core-Entity-schemas#EntityDetails) | true | | Result: Capabilities: | Role | Capability | | --- | --- | | provides | xrn:firebolt:capability:discovery:interest | #### Examples Example JSON-RPC: Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.userInterestResponse", "params": { "correlationId": "123", "result": { "identifiers": { "entityId": "345", "entityType": "program", "programType": "movie" }, "info": { "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" } ] } } } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": null } ``` --- ## Events ### navigateTo ``` function listen('navigateTo', () => void): Promise ``` See also: [listen()](/docs/170-core-discovery#listen), [once()](/docs/170-core-discovery#listen), [clear()](/docs/170-core-discovery#listen). Event value: [NavigationIntent](/docs/170-core-Intents-schemas#NavigationIntent) Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:navigate-to | #### Examples Listening for `navigateTo` events JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' Discovery.listen('navigateTo', (value) => { console.log(value) }) ``` Value of `value`: ``` { "action": "search", "data": { "query": "a cool show" }, "context": { "campaign": "unknown", "source": "voice" } } ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onNavigateTo", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "action": "search", "data": { "query": "a cool show" }, "context": { "campaign": "unknown", "source": "voice" } } } ``` --- ### policyChanged See: [policy](/docs/170-core-discovery#policy) ## Private Events **View** ### navigateTo ``` function listen('navigateTo', () => void): Promise ``` See also: [listen()](/docs/170-core-discovery#listen), [once()](/docs/170-core-discovery#listen), [clear()](/docs/170-core-discovery#listen). Event value: [NavigationIntent](/docs/170-core-Intents-schemas#NavigationIntent) Capabilities: | Role | Capability | | --- | --- | | uses | xrn:firebolt:capability:discovery:navigate-to | #### Examples Listening for `navigateTo` events JavaScript: ``` import { Discovery } from '@firebolt-js/sdk' Discovery.listen('navigateTo', (value) => { console.log(value) }) ``` Value of `value`: ``` { "action": "search", "data": { "query": "a cool show" }, "context": { "campaign": "unknown", "source": "voice" } } ``` **JSON-RPC:** Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onNavigateTo", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "action": "search", "data": { "query": "a cool show" }, "context": { "campaign": "unknown", "source": "voice" } } } ``` --- ### policyChanged See: [policy](/docs/170-core-discovery#policy) ### onRequestUserInterest *This is a private RPC method.* Provide information about the entity currently displayed or selected on the screen. Parameters: | Param | Type | Required | Description | | --- | --- | --- | --- | | `listen` | `boolean` | true | | Result: Capabilities: | Role | Capability | | --- | --- | | provides | xrn:firebolt:capability:discovery:interest | #### Examples Default Example JSON-RPC: Request: ``` { "jsonrpc": "2.0", "id": 1, "method": "Discovery.onRequestUserInterest", "params": { "listen": true } } ``` Response: ``` { "jsonrpc": "2.0", "id": 1, "result": { "correlationId": "xyz", "parameters": { "type": "interest", "reason": "playlist" } } } ``` --- ## Provider Interfaces ### UserInterestProvider The provider interface for the `xrn:firebolt:capability:discovery:interest` capability. ``` interface UserInterestProvider { userInterest( parameters: UserInterestProviderParameters, session: ProviderSession, ): Promise } ``` Usage: ``` Discovery.provide('xrn:firebolt:capability:discovery:interest', provider: UserInterestProvider | object) ``` #### Examples **Register your app to provide the `xrn:firebolt:capability:discovery:interest` capability.** ``` import { Discovery } from '@firebolt-js/sdk' class MyUserInterestProvider { async userInterest(parameters, session) { return { identifiers: { entityId: '345', entityType: 'program', programType: 'movie', }, info: { 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', }, ], }, } } } Discovery.provide( 'xrn:firebolt:capability:discovery:interest', new MyUserInterestProvider(), ) ``` **JSON-RPC** **Register to recieve each provider API** Request: ``` { "id": 1, "method": "Discovery.onRequestUserInterest", "params": { "listen": true } } ``` Response: ``` { "id": 1, "result": { "listening": true, "event": "Discovery.onRequestUserInterest" } } ``` **Asynchronous event to initiate userInterest()** Event Response: ``` { "id": 1, "result": { "correlationId": undefined, "parameters": { "type": "interest", "reason": "playlist" } } } ``` **App initiated response to event** Request: ``` { "id": 2, "method": "Discovery.userInterestResponse", "params": { "correlationId": undefined, "result": { "identifiers": { "entityId": "345", "entityType": "program", "programType": "movie" }, "info": { "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" } ] } } } } ``` Response: ``` { "id": 2, "result": true } ``` ## Types ### DiscoveryPolicy ``` 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 ``` type Availability = { type: 'channel-lineup' | 'program-lineup' id: string catalogId?: string startTime?: string endTime?: string } ``` --- ### UserInterestProviderParameters ``` type UserInterestProviderParameters = { type: InterestType reason: InterestReason } ``` See also: [InterestType](/docs/170-core-Discovery-schemas#InterestType) [InterestReason](/docs/170-core-Discovery-schemas#InterestReason) --- ### PurchasedContentParameters ``` 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: [OfferingType](/docs/170-core-Entertainment-schemas#OfferingType) [ProgramType](/docs/170-core-Entertainment-schemas#ProgramType) --- ### ContentAccessIdentifiers ``` 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 } ``` See also: [Availability](/docs/170-core-discovery#availability) [Entitlement](/docs/170-core-Entertainment-schemas#Entitlement) --- ### EntityInfoParameters ``` type EntityInfoParameters = { entityId: string assetId?: string } ``` --- ### EntityInfoFederatedRequest ``` type EntityInfoFederatedRequest = { parameters: EntityInfoParameters correlationId: string } ``` See also: [FederatedRequest](/docs/170-core-discovery#federatedrequest) [EntityInfoParameters](/docs/170-core-discovery#entityinfoparameters) --- ### PurchasedContentFederatedRequest ``` type PurchasedContentFederatedRequest = { parameters: PurchasedContentParameters correlationId: string } ``` See also: [FederatedRequest](/docs/170-core-discovery#federatedrequest) [PurchasedContentParameters](/docs/170-core-discovery#purchasedcontentparameters) ---