Document that describes a single locale.
| Property | Type | Constraints | Description |
|---|---|---|---|
country
|
String | The country/region code for this Locale,
which will either be the empty string or an upercase ISO 3166
2-letter code. |
|
default
|
Boolean | Flag that is true if the locale is the default one to use if an explicit locale is not specified. | |
display_country
|
String | The name for the Locale's country that is
appropriate for display to the user, or an empty string if no
country has been specified for the Locale. The
display country is returned in the language defined for this
locale, and not in the language of the session locale. |
|
display_language
|
String | The name for the Locale's language that is
appropriate for display to the user, or an empty string if no
language has been specified for the Locale. The
display language is returned in the language defined for this
locale, and not in the language of the session locale. |
|
display_name
|
String | The name for the Locale that is
appropriate for display to the user, or an empty string if no
display name has been specified for the Locale.
The display name is returned in the language defined for this
locale, and not in the language of the session locale. |
|
id
|
String | The identifier of the Locale. Contains a
combination of the language and the country key, concatenated by
"-", e.g. "en-US". This attribute is the primary key of the
class. |
|
iso3_country
|
String | The three-letter abbreviation for this
Locale's country, or an empty string if no
country has been specified for the
Locale. |
|
iso3_language
|
String | The three-letter abbreviation for this
Locale's language, or an empty string if no
language has been specified for the
Locale. |
|
language
|
String | The language code for this Locale, which
will either be the empty string or a lowercase ISO 639
code. |
|
name
|
String | The display name of the Locale. This uses
the current request locale to localize the value. |