root.localizationInfo object

Allows the specification of a default language, and pointers to additional language files. See localization.

Properties that reference this object type:

• root.localizationInfo

Syntax

Syntax

{
  "defaultLanguageTag": "{string}",
  "defaultLanguageFile": "{string}",
  "additionalLanguages": [
    {
      "languageTag": "{string}",
      "file": "{string}"
    }
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "defaultLanguageTag": {
      "$ref": "#/definitions/languageTag",
      "description": "The language tag of the strings in this top level manifest file.",
      "default": "en-us"
    },
    "defaultLanguageFile": {
      "$ref": "#/definitions/relativePath",
      "description": "A relative file path to a the .json file containing strings in the default language."
    },
    "additionalLanguages": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "languageTag": {
            "$ref": "#/definitions/languageTag",
            "description": "The language tag of the strings in the provided file."
          },
          "file": {
            "$ref": "#/definitions/relativePath",
            "description": "A relative file path to a the .json file containing the translated strings."
          }
        },
        "required": [
          "languageTag",
          "file"
        ]
      }
    }
  },
  "required": [
    "defaultLanguageTag"
  ]
}

Properties

defaultLanguageTag

The language tag for the strings in this top-level app manifest file.

Type
string

Required
✅

Constraints

Supported values
The value must be a language tag, like en-us.

defaultLanguageFile

A relative file path to the .json file that contains the strings. If unspecified, strings are taken directly from the app manifest file. A default language file is required for agents that support multiple languages.

Type
string

Required
—

Constraints
Maximum string length: 2048.

Supported values

additionalLanguages

An array of objects, each with properties to specify additional language translations.

Type
Array of additionalLanguages

Required
—

Constraints
Array items must be unique.

Supported values

Examples

{
    "localizationInfo": {
        "defaultLanguageTag": "en",
        "defaultLanguageFile": "en.json",
        "additionalLanguages": [
            {
                "languageTag": "es",
                "file": "es.json"
            }
        ]
    }
}