Parameters Module

Version Parameters 1.2.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • initialization
• Types
  • AppInitialization

Usage

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

import { Parameters } from '@firebolt-js/sdk'

Overview

Methods for getting initialization parameters for an app cold launch.

Methods

initialization

Returns any initialization parameters for the app, e.g. initialial NavigationIntent.

function initialization(): Promise<AppInitialization>

Promise resolution:

AppInitialization

Capabilities:

Examples

Default Example

JavaScript:

import { Parameters } from '@firebolt-js/sdk'

let init = await Parameters.initialization()
console.log(init)

Value of init:

{
	"lmt": 0,
	"us_privacy": "1-Y-",
	"discovery": {
		"navigateTo": {
			"action": "entity",
			"data": {
				"entityId": "abc",
				"entityType": "program",
				"programType": "movie"
			},
			"context": {
				"source": "voice"
			}
		}
	}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Parameters.initialization",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "lmt": 0,
    "us_privacy": "1-Y-",
    "discovery": {
      "navigateTo": {
        "action": "entity",
        "data": {
          "entityId": "abc",
          "entityType": "program",
          "programType": "movie"
        },
        "context": {
          "source": "voice"
        }
      }
    }
  }
}

Types

AppInitialization

type AppInitialization = {
  us_privacy?: string // The IAB US Privacy string.
  lmt?: number // The IAB limit ad tracking opt out value.
  discovery?: object
  secondScreen?: object
}

See also:

NavigationIntent SecondScreenEvent