title: Privacy

version: 0.15.0
layout: default
sdk: manage

# Privacy Module

Version Privacy 0.15.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • allowACRCollection
  • allowAppContentAdTargeting
  • allowCameraAnalytics
  • allowPersonalization
  • allowPrimaryBrowseAdTargeting
  • allowPrimaryContentAdTargeting
  • allowProductAnalytics
  • allowRemoteDiagnostics
  • allowResumePoints
  • allowUnentitledPersonalization
  • allowUnentitledResumePoints
  • allowWatchHistory
  • listen
  • once
  • settings
• Events
  • allowACRCollectionChanged
  • allowAppContentAdTargetingChanged
  • allowCameraAnalyticsChanged
  • allowPersonalizationChanged
  • allowPrimaryBrowseAdTargetingChanged
  • allowPrimaryContentAdTargetingChanged
  • allowProductAnalyticsChanged
  • allowRemoteDiagnosticsChanged
  • allowResumePointsChanged
  • allowUnentitledPersonalizationChanged
  • allowUnentitledResumePointsChanged
  • allowWatchHistoryChanged
• Types
  • PrivacySettings

Usage

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

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

Overview

A module for managing device settings.

Methods

allowACRCollection

Whether the user allows their automatic content recognition data to be collected

To get the value of allowACRCollection call the method like this:

function allowACRCollection(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowACRCollection()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowACRCollection",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowACRCollection()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowACRCollection",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowACRCollection call the method like this:

function allowACRCollection(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowACRCollection(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowACRCollection",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowACRCollection(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowACRCollection",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowACRCollection(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowACRCollection(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowACRCollectionChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowACRCollection(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowACRCollectionChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowAppContentAdTargeting

Whether the user allows ads to be targeted to the user while watching content in apps

To get the value of allowAppContentAdTargeting call the method like this:

function allowAppContentAdTargeting(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowAppContentAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowAppContentAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowAppContentAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowAppContentAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowAppContentAdTargeting call the method like this:

function allowAppContentAdTargeting(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowAppContentAdTargeting(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowAppContentAdTargeting",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowAppContentAdTargeting(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowAppContentAdTargeting",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowAppContentAdTargeting(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowAppContentAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowAppContentAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowAppContentAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowAppContentAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowCameraAnalytics

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:

function allowCameraAnalytics(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowCameraAnalytics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowCameraAnalytics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowCameraAnalytics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowCameraAnalytics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowCameraAnalytics call the method like this:

function allowCameraAnalytics(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowCameraAnalytics(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowCameraAnalytics",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowCameraAnalytics(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowCameraAnalytics",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowCameraAnalytics(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowCameraAnalytics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowCameraAnalyticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowCameraAnalytics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowCameraAnalyticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowPersonalization

Whether the user allows their usage data to be used for personalization and recommendations

To get the value of allowPersonalization call the method like this:

function allowPersonalization(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowPersonalization()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPersonalization",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowPersonalization()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPersonalization",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowPersonalization call the method like this:

function allowPersonalization(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowPersonalization(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPersonalization",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowPersonalization(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPersonalization",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowPersonalization(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowPersonalization(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPersonalizationChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowPersonalization(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPersonalizationChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowPrimaryBrowseAdTargeting

Whether the user allows ads to be targeted to the user while browsing in the primary experience

To get the value of allowPrimaryBrowseAdTargeting call the method like this:

function allowPrimaryBrowseAdTargeting(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowPrimaryBrowseAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPrimaryBrowseAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowPrimaryBrowseAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPrimaryBrowseAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowPrimaryBrowseAdTargeting call the method like this:

function allowPrimaryBrowseAdTargeting(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowPrimaryBrowseAdTargeting(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPrimaryBrowseAdTargeting",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowPrimaryBrowseAdTargeting(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPrimaryBrowseAdTargeting",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowPrimaryBrowseAdTargeting(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowPrimaryBrowseAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPrimaryBrowseAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowPrimaryBrowseAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPrimaryBrowseAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowPrimaryContentAdTargeting

Whether the user allows ads to be targeted to the user while watching content in the primary experience

To get the value of allowPrimaryContentAdTargeting call the method like this:

function allowPrimaryContentAdTargeting(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowPrimaryContentAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPrimaryContentAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowPrimaryContentAdTargeting()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowPrimaryContentAdTargeting",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowPrimaryContentAdTargeting call the method like this:

function allowPrimaryContentAdTargeting(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowPrimaryContentAdTargeting(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPrimaryContentAdTargeting",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowPrimaryContentAdTargeting(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowPrimaryContentAdTargeting",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowPrimaryContentAdTargeting(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowPrimaryContentAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPrimaryContentAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowPrimaryContentAdTargeting(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowPrimaryContentAdTargetingChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowProductAnalytics

Whether the user allows their usage data can be used for analytics about the product

To get the value of allowProductAnalytics call the method like this:

function allowProductAnalytics(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowProductAnalytics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowProductAnalytics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowProductAnalytics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowProductAnalytics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowProductAnalytics call the method like this:

function allowProductAnalytics(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowProductAnalytics(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowProductAnalytics",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowProductAnalytics(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowProductAnalytics",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowProductAnalytics(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowProductAnalytics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowProductAnalyticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowProductAnalytics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowProductAnalyticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowRemoteDiagnostics

Whether the user allows their personal data to be included in diagnostic telemetry. This also allows whether device logs can be remotely accessed from the client device

To get the value of allowRemoteDiagnostics call the method like this:

function allowRemoteDiagnostics(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowRemoteDiagnostics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowRemoteDiagnostics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowRemoteDiagnostics()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowRemoteDiagnostics",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowRemoteDiagnostics call the method like this:

function allowRemoteDiagnostics(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowRemoteDiagnostics(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowRemoteDiagnostics",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowRemoteDiagnostics(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowRemoteDiagnostics",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowRemoteDiagnostics(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowRemoteDiagnostics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowRemoteDiagnosticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowRemoteDiagnostics(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowRemoteDiagnosticsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowResumePoints

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:

function allowResumePoints(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowResumePoints()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowResumePoints",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowResumePoints()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowResumePoints",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowResumePoints call the method like this:

function allowResumePoints(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowResumePoints(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowResumePoints",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowResumePoints(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowResumePoints",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowResumePoints(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowResumePoints(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowResumePointsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowResumePoints(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowResumePointsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowUnentitledPersonalization

Whether the user allows their usage data to be used for personalization and recommendations for unentitled content

To get the value of allowUnentitledPersonalization call the method like this:

function allowUnentitledPersonalization(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowUnentitledPersonalization()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowUnentitledPersonalization",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowUnentitledPersonalization()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowUnentitledPersonalization",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowUnentitledPersonalization call the method like this:

function allowUnentitledPersonalization(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowUnentitledPersonalization(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowUnentitledPersonalization",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowUnentitledPersonalization(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowUnentitledPersonalization",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowUnentitledPersonalization(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowUnentitledPersonalization(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowUnentitledPersonalizationChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowUnentitledPersonalization(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowUnentitledPersonalizationChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowUnentitledResumePoints

Whether the user allows resume points for content from unentitled providers to show in the main experience

To get the value of allowUnentitledResumePoints call the method like this:

function allowUnentitledResumePoints(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowUnentitledResumePoints()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowUnentitledResumePoints",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowUnentitledResumePoints()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowUnentitledResumePoints",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowUnentitledResumePoints call the method like this:

function allowUnentitledResumePoints(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowUnentitledResumePoints(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowUnentitledResumePoints",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowUnentitledResumePoints(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowUnentitledResumePoints",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowUnentitledResumePoints(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowUnentitledResumePoints(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowUnentitledResumePointsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowUnentitledResumePoints(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowUnentitledResumePointsChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

allowWatchHistory

Whether the user allows their watch history from all sources to show in the main experience

To get the value of allowWatchHistory call the method like this:

function allowWatchHistory(): Promise<boolean>

Promise resolution:

boolean

Capabilities:

Examples

Default example #1

JavaScript:

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

Privacy.allowWatchHistory()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowWatchHistory",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

Privacy.allowWatchHistory()
    .then(allow => {
        console.log(allow)
    })

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.allowWatchHistory",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

To set the value of allowWatchHistory call the method like this:

function allowWatchHistory(value: boolean): Promise<void>

Parameters:

Promise resolution:

null

Examples

Default example #1

JavaScript:

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

Privacy.allowWatchHistory(true)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowWatchHistory",
	"params": {
		"value": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

Default example #2

JavaScript:

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

Privacy.allowWatchHistory(false)
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.setAllowWatchHistory",
	"params": {
		"value": false
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": null
}

To subscribe to notifications when the value changes, call the method like this:

function allowWatchHistory(callback: (value) => boolean): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

allowWatchHistory(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowWatchHistoryChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": true
}

Default example #2

JavaScript:

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

allowWatchHistory(value => {
  console.log(value)
}).then(listenerId => {
  console.log(listenerId)
})

Value of allow:

true

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.onAllowWatchHistoryChanged",
	"params": {
		"listen": true
	}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": false
}

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.

settings

Gets the allowed value for all privacy settings

function settings(): Promise<PrivacySettings>

Promise resolution:

PrivacySettings

Capabilities:

Examples

Default Example

JavaScript:

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

Privacy.settings()
    .then(settings => {
        console.log(settings)
    })

Value of settings:

{
	"allowACRCollection": true,
	"allowResumePoints": false,
	"allowAppContentAdTargeting": false,
	"allowCameraAnalytics": true,
	"allowPersonalization": true,
	"allowPrimaryBrowseAdTargeting": false,
	"allowPrimaryContentAdTargeting": false,
	"allowProductAnalytics": true,
	"allowRemoteDiagnostics": true,
	"allowUnentitledPersonalization": true,
	"allowUnentitledResumePoints": false,
	"allowWatchHistory": true
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "Privacy.settings",
	"params": {}
}

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": {
		"allowACRCollection": true,
		"allowResumePoints": false,
		"allowAppContentAdTargeting": false,
		"allowCameraAnalytics": true,
		"allowPersonalization": true,
		"allowPrimaryBrowseAdTargeting": false,
		"allowPrimaryContentAdTargeting": false,
		"allowProductAnalytics": true,
		"allowRemoteDiagnostics": true,
		"allowUnentitledPersonalization": true,
		"allowUnentitledResumePoints": false,
		"allowWatchHistory": true
	}
}

Events

allowACRCollectionChanged

See: allowACRCollection

allowAppContentAdTargetingChanged

See: allowAppContentAdTargeting

allowCameraAnalyticsChanged

See: allowCameraAnalytics

allowPersonalizationChanged

See: allowPersonalization

allowPrimaryBrowseAdTargetingChanged

See: allowPrimaryBrowseAdTargeting

allowPrimaryContentAdTargetingChanged

See: allowPrimaryContentAdTargeting

allowProductAnalyticsChanged

See: allowProductAnalytics

allowRemoteDiagnosticsChanged

See: allowRemoteDiagnostics

allowResumePointsChanged

See: allowResumePoints

allowUnentitledPersonalizationChanged

See: allowUnentitledPersonalization

allowUnentitledResumePointsChanged

See: allowUnentitledResumePoints

allowWatchHistoryChanged

See: allowWatchHistory

Types

PrivacySettings

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
}