Home > @poq/sdk-sfcc > Locale
Document that describes a single locale.
Signature:
export declare class Locale extends BaseModel<Locale>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Locale class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _default? | boolean | (Optional) Flag that is true if this locale is the default to use if a locale is not specified. | |
| country? | string | (Optional) The uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string. | |
| displayCountry? | string | (Optional) The display name of this Locale’s country, in this Locale’s language, not in the session locale’s language. If no country has been specified for this Locale, this value is an empty string. | |
| displayLanguage? | string | (Optional) The display name of this Locale’s language, in this Locale’s language, not in the session locale’s language. If no country has been specified for this Locale, this value is an empty string. | |
| displayName? | string | (Optional) The display name of this Locale, in this Locale’s language, not in the session locale’s language. If no display name has been specified for this Locale, this value is an empty string. | |
| id? | string | (Optional) The identifier of the Locale. Combines the language and the country key, concatenated with “-”. For example: “en-US”. This attribute is the primary key of the class. | |
| iso3Country? | string | (Optional) The uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string. | |
| iso3Language? | string | (Optional) The 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string. | |
| language? | string | (Optional) The lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string. | |
| name? | string | (Optional) The display name of the Locale. Uses the current request locale to localize the value. |