Discovery Module

Version Discovery 1.2.0

Table of Contents

• Table of Contents
• Usage
• Overview
  • Localization
• Methods
  • listen
  • once
• Events
  • signIn
  • signOut
• Types

Usage

To use the Discovery module, you can import it into your project from the Firebolt SDK:

import { Discovery } from '@firebolt-js/manage-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

listen

To listen to a specific event pass the event name as the first parameter:

listen(event: string, callback: (data: any) => void): Promise<number>

Parameters:

Promise resolution:

Callback parameters:

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<number>

Parameters:

Callback parameters:

Promise resolution:

See 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<number>

The once method will only pass the next instance of this event, and then dicard the listener you provided.

Parameters:

Promise resolution:

Callback parameters:

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<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

Events

signIn

function listen('signIn', () => void): Promise<number>

See also: listen(), once(), clear().

Event value:

Capabilities:

Examples

Default Example

JavaScript:

import { Discovery } from '@firebolt-js/manage-sdk'

Discovery.listen('signIn', (event) => {
  console.log(event)
})

Value of event:

{
	"appId": "firecert"
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Discovery.onSignIn",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "firecert"
  }
}

signOut

function listen('signOut', () => void): Promise<number>

See also: listen(), once(), clear().

Event value:

Capabilities:

Examples

Default Example

JavaScript:

import { Discovery } from '@firebolt-js/manage-sdk'

Discovery.listen('signOut', (event) => {
  console.log(event)
})

Value of event:

{
	"appId": "firecert"
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Discovery.onSignOut",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "appId": "firecert"
  }
}

Types