Firebolt DocumentationLocalization Module
Version Localization 1.2.0
Table of Contents
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:
| Param | Type | Required | Description |
|---|---|---|---|
key |
string |
true | Key to add additionalInfo |
value |
string |
true | Value to be set for additionalInfo |
Promise resolution:
Capabilities:
| Role | Capability |
|---|---|
| manages | xrn:firebolt:capability:localization:additional-info |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.addAdditionalInfo",
"params": {
"key": "defaultKey",
"value": "defaultValue="
}
}
Response:
{
"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:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:additional-info |
Examples
Default Example
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let info = await Localization.additionalInfo()
console.log(info)
Value of info:
{
}
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.additionalInfo",
"params": {}
}
Response:
{
"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:
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:country-code |
Examples
Default example #1
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let code = await Localization.countryCode()
console.log(code)
Value of code:
'US'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.countryCode",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.countryCode",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
CountryCode |
true | the device country code pattern: ^[A-Z]{2}$ |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setCountryCode",
"params": {
"value": "US"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setCountryCode",
"params": {
"value": "UK"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onCountryCodeChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onCountryCodeChanged",
"params": {
"listen": true
}
}
Response:
{
"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:
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:language |
Examples
Default example #1
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let lang = await Localization.language()
console.log(lang)
Value of lang:
'en'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.language",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.language",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
Language |
true | the device language pattern: ^[A-Za-z]{2}$ |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLanguage",
"params": {
"value": "en"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLanguage",
"params": {
"value": "es"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLanguageChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLanguageChanged",
"params": {
"listen": true
}
}
Response:
{
"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:
| Param | Type | Required | Summary |
|---|---|---|---|
event |
string |
Yes | The event to listen for, see Events. |
| callback | function |
Yes | A function that will be invoked when the event occurs. |
Promise resolution:
| Type | Description |
|---|---|
number |
Listener ID to clear the callback method and stop receiving the event, e.g. Localization.clear(id) |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
data |
any |
Yes | The event data, which depends on which event is firing, see Events. |
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:
| Param | Type | Required | Summary |
|---|---|---|---|
| callback | function |
Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see Events. |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event |
string |
Yes | The event that has occured listen for, see Events. |
data |
any |
Yes | The event data, which depends on which event is firing, see Events. |
Promise resolution:
| Type | Description |
|---|---|
number |
Listener ID to clear the callback method and stop receiving the event, e.g. Localization.clear(id) |
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:
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:locale |
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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.locale",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.locale",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
Locale |
true | the device locale pattern: ^[a-zA-Z]+([a-zA-Z0-9-]*)$ |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLocale",
"params": {
"value": "en-US"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLocale",
"params": {
"value": "es-US"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLocaleChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLocaleChanged",
"params": {
"listen": true
}
}
Response:
{
"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:
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:locality |
Examples
Default example #1
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let locality = await Localization.locality()
console.log(locality)
Value of locality:
'Philadelphia'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.locality",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.locality",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
Locality |
true | the device city |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLocality",
"params": {
"value": "Philadelphia"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setLocality",
"params": {
"value": "Rockville"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLocalityChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onLocalityChanged",
"params": {
"listen": true
}
}
Response:
{
"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:
| Param | Type | Required | Summary |
|---|---|---|---|
event |
string |
Yes | The event to listen for, see Events. |
| callback | function |
Yes | A function that will be invoked when the event occurs. |
Promise resolution:
| Type | Description |
|---|---|
number |
Listener ID to clear the callback method and stop receiving the event, e.g. Localization.clear(id) |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
data |
any |
Yes | The event data, which depends on which event is firing, see Events. |
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:
| Param | Type | Required | Summary |
|---|---|---|---|
| callback | function |
Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see Events. |
Callback parameters:
| Param | Type | Required | Summary |
|---|---|---|---|
event |
string |
Yes | The event that has occured listen for, see Events. |
data |
any |
Yes | The event data, which depends on which event is firing, see Events. |
Promise resolution:
| Type | Description |
|---|---|
number |
Listener ID to clear the callback method and stop receiving the event, e.g. Localization.clear(id) |
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:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:postal-code |
Examples
Default example #1
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let postalCode = await Localization.postalCode()
console.log(postalCode)
Value of postalCode:
'19103'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.postalCode",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.postalCode",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
string |
true | the device postal code |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setPostalCode",
"params": {
"value": "19103"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setPostalCode",
"params": {
"value": "20850"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onPostalCodeChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onPostalCodeChanged",
"params": {
"listen": true
}
}
Response:
{
"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:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:language |
Examples
Default Example
JavaScript:
import { Localization } from '@firebolt-js/manage-sdk'
let languages = await Localization.preferredAudioLanguages()
console.log(languages)
Value of languages:
;['spa', 'eng']
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.preferredAudioLanguages",
"params": {}
}
Response:
{
"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']
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.preferredAudioLanguages",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
ISO639_2Language[] |
true | the preferred audio languages pattern: ^[a-z]{3}$ |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setPreferredAudioLanguages",
"params": {
"value": ["spa", "eng"]
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setPreferredAudioLanguages",
"params": {
"value": ["eng", "spa"]
}
}
Response:
{
"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']
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onPreferredAudioLanguagesChanged",
"params": {
"listen": true
}
}
Response:
{
"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']
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onPreferredAudioLanguagesChanged",
"params": {
"listen": true
}
}
Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": ["eng", "spa"]
}
removeAdditionalInfo
Remove any platform-specific localization information from map
function removeAdditionalInfo(key: string): Promise<void>
Parameters:
| Param | Type | Required | Description |
|---|---|---|---|
key |
string |
true | Key to remove additionalInfo |
Promise resolution:
Capabilities:
| Role | Capability |
|---|---|
| manages | xrn:firebolt:capability:localization:additional-info |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.removeAdditionalInfo",
"params": {
"key": "defaultKey"
}
}
Response:
{
"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:
Capabilities:
| Role | Capability |
|---|---|
| uses | xrn:firebolt:capability:localization:time-zone |
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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.timeZone",
"params": {}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.timeZone",
"params": {}
}
Response:
{
"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:
| Param | Type | Required | Description |
|---|---|---|---|
value |
TimeZone |
true | pattern: ^[-+_/ A-Za-z 0-9]*$ |
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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setTimeZone",
"params": {
"value": "America/New_York"
}
}
Response:
{
"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
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.setTimeZone",
"params": {
"value": "America/Los_Angeles"
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onTimeZoneChanged",
"params": {
"listen": true
}
}
Response:
{
"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'
JSON-RPC:
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "Localization.onTimeZoneChanged",
"params": {
"listen": true
}
}
Response:
{
"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
timeZoneChanged
See: timeZone