title: Localization

version: 1.2.0
layout: default
sdk: manage

# Localization Module

Version Localization 1.2.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • addAdditionalInfo
  • additionalInfo
  • countryCode
  • language
  • listen
  • locale
  • locality
  • once
  • postalCode
  • preferredAudioLanguages
  • removeAdditionalInfo
  • timeZone
• Events
  • countryCodeChanged
  • languageChanged
  • localeChanged
  • localityChanged
  • postalCodeChanged
  • preferredAudioLanguagesChanged
  • timeZoneChanged
• Types

Usage

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

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

Overview

Methods for accessessing location and language preferences

Methods

addAdditionalInfo

Add any platform-specific localization information in key/value pair

function addAdditionalInfo(key: string, value: string): Promise<void>

Parameters:

Promise resolution:

Capabilities:

Examples

Add an additionalInfo for localization

JavaScript:

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

let result = await Localization.addAdditionalInfo('defaultKey', 'defaultValue=')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.addAdditionalInfo",
  "params": {
    "key": "defaultKey",
    "value": "defaultValue="
  }
}

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

additionalInfo

Get any platform-specific localization information, in an Map<string, string>

function additionalInfo(): Promise<object>

Promise resolution:

Capabilities:

Examples

Default Example

JavaScript:

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

let info = await Localization.additionalInfo()
console.log(info)

Value of info:

{
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.additionalInfo",
  "params": {}
}

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

countryCode

Get the ISO 3166-1 alpha-2 code for the country device is located in

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

function countryCode(): Promise<CountryCode>

Promise resolution:

CountryCode

Capabilities:

Examples

Default example #1

JavaScript:

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

let code = await Localization.countryCode()
console.log(code)

Value of code:

'US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.countryCode",
  "params": {}
}

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

Default example #2

JavaScript:

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

let code = await Localization.countryCode()
console.log(code)

Value of code:

'US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.countryCode",
  "params": {}
}

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

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

function countryCode(value: CountryCode): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

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

let result = await Localization.countryCode('US')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setCountryCode",
  "params": {
    "value": "US"
  }
}

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

Default example #2

JavaScript:

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

let result = await Localization.countryCode('UK')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setCountryCode",
  "params": {
    "value": "UK"
  }
}

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

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

function countryCode(callback: (value) => CountryCode): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

let listenerId = await countryCode((value) => {
  console.log(value)
})
console.log(listenerId)

Value of code:

'US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onCountryCodeChanged",
  "params": {
    "listen": true
  }
}

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

Default example #2

JavaScript:

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

let listenerId = await countryCode((value) => {
  console.log(value)
})
console.log(listenerId)

Value of code:

'US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onCountryCodeChanged",
  "params": {
    "listen": true
  }
}

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

language

Get the ISO 639 1/2 code for the preferred language

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

function language(): Promise<Language>

Promise resolution:

Language

Capabilities:

Examples

Default example #1

JavaScript:

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

let lang = await Localization.language()
console.log(lang)

Value of lang:

'en'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.language",
  "params": {}
}

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

Default example #2

JavaScript:

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

let lang = await Localization.language()
console.log(lang)

Value of lang:

'en'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.language",
  "params": {}
}

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

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

function language(value: Language): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

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

let result = await Localization.language('en')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLanguage",
  "params": {
    "value": "en"
  }
}

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

Default example #2

JavaScript:

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

let result = await Localization.language('es')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLanguage",
  "params": {
    "value": "es"
  }
}

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

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

function language(callback: (value) => Language): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

let listenerId = await language((value) => {
  console.log(value)
})
console.log(listenerId)

Value of lang:

'en'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLanguageChanged",
  "params": {
    "listen": true
  }
}

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

Default example #2

JavaScript:

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

let listenerId = await language((value) => {
  console.log(value)
})
console.log(listenerId)

Value of lang:

'en'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLanguageChanged",
  "params": {
    "listen": true
  }
}

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

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.

locale

Get the full BCP 47 code, including script, region, variant, etc., for the preferred langauage/locale

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

function locale(): Promise<Locale>

Promise resolution:

Locale

Capabilities:

Examples

Default example #1

JavaScript:

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

let locale = await Localization.locale()
console.log(locale)

Value of locale:

'en-US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.locale",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "en-US"
}

Default example #2

JavaScript:

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

let locale = await Localization.locale()
console.log(locale)

Value of locale:

'en-US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.locale",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "es-US"
}

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

function locale(value: Locale): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

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

let result = await Localization.locale('en-US')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLocale",
  "params": {
    "value": "en-US"
  }
}

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

Default example #2

JavaScript:

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

let result = await Localization.locale('es-US')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLocale",
  "params": {
    "value": "es-US"
  }
}

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

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

function locale(callback: (value) => Locale): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

let listenerId = await locale((value) => {
  console.log(value)
})
console.log(listenerId)

Value of locale:

'en-US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLocaleChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "en-US"
}

Default example #2

JavaScript:

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

let listenerId = await locale((value) => {
  console.log(value)
})
console.log(listenerId)

Value of locale:

'en-US'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLocaleChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "es-US"
}

locality

Get the locality/city the device is located in

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

function locality(): Promise<Locality>

Promise resolution:

Locality

Capabilities:

Examples

Default example #1

JavaScript:

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

let locality = await Localization.locality()
console.log(locality)

Value of locality:

'Philadelphia'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.locality",
  "params": {}
}

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

Default example #2

JavaScript:

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

let locality = await Localization.locality()
console.log(locality)

Value of locality:

'Philadelphia'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.locality",
  "params": {}
}

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

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

function locality(value: Locality): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

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

let result = await Localization.locality('Philadelphia')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLocality",
  "params": {
    "value": "Philadelphia"
  }
}

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

Default example #2

JavaScript:

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

let result = await Localization.locality('Rockville')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setLocality",
  "params": {
    "value": "Rockville"
  }
}

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

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

function locality(callback: (value) => Locality): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

let listenerId = await locality((value) => {
  console.log(value)
})
console.log(listenerId)

Value of locality:

'Philadelphia'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLocalityChanged",
  "params": {
    "listen": true
  }
}

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

Default example #2

JavaScript:

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

let listenerId = await locality((value) => {
  console.log(value)
})
console.log(listenerId)

Value of locality:

'Philadelphia'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onLocalityChanged",
  "params": {
    "listen": true
  }
}

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

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.

postalCode

Get the postal code the device is located in

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

function postalCode(): Promise<string>

Promise resolution:

Capabilities:

Examples

Default example #1

JavaScript:

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

let postalCode = await Localization.postalCode()
console.log(postalCode)

Value of postalCode:

'19103'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.postalCode",
  "params": {}
}

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

Default example #2

JavaScript:

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

let postalCode = await Localization.postalCode()
console.log(postalCode)

Value of postalCode:

'19103'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.postalCode",
  "params": {}
}

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

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

function postalCode(value: string): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

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

let result = await Localization.postalCode('19103')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setPostalCode",
  "params": {
    "value": "19103"
  }
}

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

Default example #2

JavaScript:

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

let result = await Localization.postalCode('20850')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setPostalCode",
  "params": {
    "value": "20850"
  }
}

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

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

function postalCode(callback: (value) => string): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

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

let listenerId = await postalCode((value) => {
  console.log(value)
})
console.log(listenerId)

Value of postalCode:

'19103'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onPostalCodeChanged",
  "params": {
    "listen": true
  }
}

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

Default example #2

JavaScript:

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

let listenerId = await postalCode((value) => {
  console.log(value)
})
console.log(listenerId)

Value of postalCode:

'19103'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onPostalCodeChanged",
  "params": {
    "listen": true
  }
}

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

preferredAudioLanguages

A prioritized list of ISO 639 1/2 codes for the preferred audio languages on this device.

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

function preferredAudioLanguages(): Promise<ISO639_2Language[]>

Promise resolution:

Capabilities:

Examples

Default Example

JavaScript:

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

let languages = await Localization.preferredAudioLanguages()
console.log(languages)

Value of languages:

;['spa', 'eng']

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.preferredAudioLanguages",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": ["spa", "eng"]
}

Default Example #2

JavaScript:

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

let languages = await Localization.preferredAudioLanguages()
console.log(languages)

Value of languages:

;['spa', 'eng']

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.preferredAudioLanguages",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": ["eng", "spa"]
}

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

function preferredAudioLanguages(value: ISO639_2Language[]): Promise<void>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

let result = await Localization.preferredAudioLanguages(['spa', 'eng'])
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setPreferredAudioLanguages",
  "params": {
    "value": ["spa", "eng"]
  }
}

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

Default Example #2

JavaScript:

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

let result = await Localization.preferredAudioLanguages(['eng', 'spa'])
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setPreferredAudioLanguages",
  "params": {
    "value": ["eng", "spa"]
  }
}

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

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

function preferredAudioLanguages(
  callback: (value) => ISO639_2Language[],
): Promise<number>

Promise resolution:

number

Examples

Default Example

JavaScript:

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

let listenerId = await preferredAudioLanguages((value) => {
  console.log(value)
})
console.log(listenerId)

Value of languages:

;['spa', 'eng']

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onPreferredAudioLanguagesChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": ["spa", "eng"]
}

Default Example #2

JavaScript:

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

let listenerId = await preferredAudioLanguages((value) => {
  console.log(value)
})
console.log(listenerId)

Value of languages:

;['spa', 'eng']

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onPreferredAudioLanguagesChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": ["eng", "spa"]
}

removeAdditionalInfo

Remove any platform-specific localization information from map

function removeAdditionalInfo(key: string): Promise<void>

Parameters:

Promise resolution:

Capabilities:

Examples

Remove an additionalInfo for localization

JavaScript:

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

let result = await Localization.removeAdditionalInfo('defaultKey')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.removeAdditionalInfo",
  "params": {
    "key": "defaultKey"
  }
}

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

timeZone

Set the IANA timezone for the device

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

function timeZone(): Promise<TimeZone>

Promise resolution:

TimeZone

Capabilities:

Examples

Default Example

JavaScript:

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

let result = await Localization.timeZone()
console.log(result)

Value of result:

'America/New_York'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.timeZone",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "America/New_York"
}

Additional Example

JavaScript:

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

let result = await Localization.timeZone()
console.log(result)

Value of result:

'America/New_York'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.timeZone",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "America/Los_Angeles"
}

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

function timeZone(value: TimeZone): Promise<void>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

let result = await Localization.timeZone('America/New_York')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setTimeZone",
  "params": {
    "value": "America/New_York"
  }
}

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

Additional Example

JavaScript:

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

let result = await Localization.timeZone('America/Los_Angeles')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.setTimeZone",
  "params": {
    "value": "America/Los_Angeles"
  }
}

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

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

function timeZone(callback: (value) => TimeZone): Promise<number>

Promise resolution:

number

Examples

Default Example

JavaScript:

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

let listenerId = await timeZone((value) => {
  console.log(value)
})
console.log(listenerId)

Value of result:

'America/New_York'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onTimeZoneChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "America/New_York"
}

Additional Example

JavaScript:

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

let listenerId = await timeZone((value) => {
  console.log(value)
})
console.log(listenerId)

Value of result:

'America/New_York'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Localization.onTimeZoneChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "America/Los_Angeles"
}

Events

countryCodeChanged

See: countryCode

languageChanged

See: language

localeChanged

See: locale

localityChanged

See: locality

postalCodeChanged

See: postalCode

preferredAudioLanguagesChanged

See: preferredAudioLanguages

timeZoneChanged

See: timeZone

Types