title: Localization

# Localization Module

Version 0.10.0

Overview

Methods for accessessing location and language preferences

OpenRPC

Firebolt APIs are maintained in the rdkcentral/firebolt-core-sdk GitHub repository.

You can see this API in the localization.json OpenRPC JSON-Schema document.

Table of Contents

• Overview

• OpenRPC

• Usage

• Methods

  • additionalInfo
  • countryCode
  • language
  • latlon
  • listen
  • locale
  • locality
  • once
  • postalCode

• Events

  • Additional Events

• Schemas

  • LatLon

Usage

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

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

Methods

additionalInfo

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

function additionalInfo(): Promise<object>

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.additionalInfo()
    .then(info => {
        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 code for the counrty device is located in

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

function countryCode(): Promise<CountryCode>

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.countryCode()
    .then(code => {
        console.log(code)
    })

Value of code:

"US"

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

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

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

function countryCode(): Promise<ListenResponse | CountryCode>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.countryCode(true)

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

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

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

function countryCode (subscriber: () => void): Promise<listenerId>

Parameters:

Promise resolution:

Callback parameters:

Examples

JavaScript:

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

Localization.countryCode((value) => {
  // property value was changed
  console.log(value)
}).then(listenerId => {
  // you can clear this listener w/ Localization.clear(listenerId)
})

value of value:

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

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:

Examples

Default Example

JavaScript:

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

Localization.language()
    .then(lang => {
        console.log(lang)
    })

Value of lang:

"en"

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

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

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

function language(): Promise<ListenResponse | Language>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.language(true)

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

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

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

function language (subscriber: () => void): Promise<listenerId>

Parameters:

Promise resolution:

Callback parameters:

Examples

JavaScript:

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

Localization.language((value) => {
  // property value was changed
  console.log(value)
}).then(listenerId => {
  // you can clear this listener w/ Localization.clear(listenerId)
})

value of value:

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

latlon

Get the approximate latitude and longitude coordinates of the device location

function latlon(): Promise<[number, number]>

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.latlon()
    .then(latlong => {
        console.log(latlong)
    })

Value of latlong:

[
  39.9549,
  75.1699
]

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "localization.latlon",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    39.9549,
    75.1699
  ]
}

listen

Listen for events from this module.

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

Localization.listen(event: string, (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:

Localization.listen((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:

Examples

Default Example

JavaScript:

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

Localization.locale()
    .then(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"
}

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

function locale(): Promise<ListenResponse | Locale>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.locale(true)

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

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

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

function locale (subscriber: () => void): Promise<listenerId>

Parameters:

Promise resolution:

Callback parameters:

Examples

JavaScript:

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

Localization.locale((value) => {
  // property value was changed
  console.log(value)
}).then(listenerId => {
  // you can clear this listener w/ Localization.clear(listenerId)
})

value of value:

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

locality

Get the locality/city the device is located in

function locality(): Promise<Locality>

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.locality()
    .then(locality => {
        console.log(locality)
    })

Value of locality:

"Philadelphia"

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

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

once

Listen for only one occurance of an event from this module. The callback will be cleared after one event.

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

Localization.once(event: string, (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:

Localization.once((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:

Examples

Default Example

JavaScript:

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

Localization.postalCode()
    .then(postalCode => {
        console.log(postalCode)
    })

Value of postalCode:

"19103"

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

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

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

function postalCode(): Promise<ListenResponse | string>

Parameters:

Promise resolution:

Examples

Default Example

JavaScript:

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

Localization.postalCode(true)

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

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

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

function postalCode (subscriber: () => void): Promise<listenerId>

Parameters:

Promise resolution:

Callback parameters:

Examples

JavaScript:

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

Localization.postalCode((value) => {
  // property value was changed
  console.log(value)
}).then(listenerId => {
  // you can clear this listener w/ Localization.clear(listenerId)
})

value of value:

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

Events

Additional events

The following events are documented as part of a related set of method APIs.

For more information, follow the links under the "Documentation" column.

Schemas

LatLon

type LatLon = [number, number]