goog.locale

Provided By	`goog.locale`

Returns the language-subtag of the given language code.

Parameters

`languageCode`	`string`
	Language code to extract language subtag from.

Returns

string

Language subtag (in lowercase).

VIEW SOURCE

Retrieve the current locale

Deprecated	Use goog.LOCALE and goog.i18n instead.

Parameters

None.

Returns

string

Current locale name string.

VIEW SOURCE

Returns the localized country name for the provided language code in the current or provided locale symbols set.

This method depends on goog.locale.LocaleNameConstants__<locale> available from http://go/js_locale_data. User of this method has to add dependency to this.

Parameters

`languageCode`	`string`
	Language code to lookup the country name for.
`opt_localeSymbols`	`(Object\|null)=`
	If omitted the current locale symbol set is used.

Returns

string

Localized country name.

VIEW SOURCE

Returns the localized language name for the provided language code in the current or provided locale symbols set.

This method depends on goog.locale.LocaleNameConstants__<locale> available from http://go/js_locale_data. User of this method has to add dependency to this.

Parameters

`languageCode`	`string`
	Language code to lookup the language name for.
`opt_localeSymbols`	`(Object\|null)=`
	locale symbol set if given.

Returns

string

Localized language name of the provided language code.

VIEW SOURCE

Returns the localized country name for the provided language code in the current or provided locale symbols set.

This method depends on goog.locale.LocaleNameConstants__<locale> available from http://go/js_locale_data. User of this method has to add dependency to this.

Parameters

`regionCode`	`string`
	Two character country code or three digit region code to look up the country name for.
`opt_localeSymbols`	`(Object\|null)=`
	If omitted the current locale symbol set is used.

Returns

string

Localized region name.

VIEW SOURCE

Returns the country name of the provided language code in its native language.

This method depends on goog.locale.nativeNameConstants available from nativenameconstants.js. User of this method has to add dependency to this.

Parameters

`countryCode`	`string`
	Code to lookup the country name for.

Returns

string

Country name for the provided language code.

VIEW SOURCE

Returns the language name of the provided language code in its native language.

This method depends on goog.locale.nativeNameConstants available from nativenameconstants.js. User of this method has to add dependency to this.

Parameters

`languageCode`	`string`
	Language code to lookup the language name for.

Returns

string

Language name for the provided language code.

VIEW SOURCE

Returns the region-sub-tag of the given language code.

Parameters

`languageCode`	`string`
	Language code to extract region subtag from.

Returns

string

Region sub-tag (in uppercase).

VIEW SOURCE

Retrieve specified resource for certain locale.

Parameters

`resourceName`	`string`
	String that represents the type of resource.
`opt_locale`	`string=`
	Locale ID, if not given, current locale will be assumed.

Returns

(Object|null|undefined)

The resource object that hold all the resource data, or undefined if not available.

VIEW SOURCE

Retrieve specified resource for certain locale with fallback. For example, request of 'zh_CN' will be resolved in following order: zh_CN, zh, en. If none of the above succeeds, of if the resource as indicated by resourceName does not exist at all, undefined will be returned.

Parameters

`resourceName`	`string`
	String that represents the type of resource.
`opt_locale`	`string=`
	locale ID, if not given, current locale will be assumed.

Returns

(Object|null|undefined)

The resource object for desired locale.

VIEW SOURCE

Returns the script subtag of the locale with the first alphabet in uppercase and the rest 3 characters in lower case.

Parameters

`languageCode`	`string`
	Language Code to extract script subtag from.

Returns

string

Script subtag.

VIEW SOURCE

Returns the variant-sub-tag of the given language code.

Parameters

`languageCode`	`string`
	Language code to extract variant subtag from.

Returns

string

Variant sub-tag.

VIEW SOURCE

Returns true if the required resource has already been registered.

Parameters

`resourceName`	`string`
	String that represents the type of resource.
`localeName`	`string`
	Locale ID.

Returns

boolean

Whether the required resource has already been registered.

VIEW SOURCE

Registers the LocaleNameConstants constants object for a given locale name.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Register a resource object for certain locale.

Parameters

`dataObj`	`(Object\|null)`
	The resource object being registered.
`resourceName`	`string`
	String that represents the type of resource.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Registers the TimeZoneAllLongNames constants object for a given locale name.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Registers the timezone constants object for a given locale name.

Deprecated	Use goog.i18n.TimeZone, no longer need this.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Registers the TimeZoneSelectedIds constants object for a given locale name.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Registers the TimeZoneSelectedLongNames constants object for a given locale name.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Registers the TimeZoneSelectedShortNames constants object for a given locale name.

Parameters

`dataObj`	`(Object\|null)`
	The resource object.
`localeName`	`string`
	Locale ID.

VIEW SOURCE

Set current locale to the specified one.

Parameters

`localeName`	`string`
	Locale name string. We are following the usage in CLDR, but can make a few compromise for existing name compatibility.

VIEW SOURCE

goog.locale

Functions

getLanguageSubTag( `languageCode` ) `→` `string`

getLocale() `→` `string`

getLocalizedCountryName( `languageCode`, `opt_localeSymbols` ) `→` `string`

getLocalizedLanguageName( `languageCode`, `opt_localeSymbols` ) `→` `string`

getLocalizedRegionNameFromRegionCode( `regionCode`, `opt_localeSymbols` ) `→` `string`

getNativeCountryName( `countryCode` ) `→` `string`

getNativeLanguageName( `languageCode` ) `→` `string`

getRegionSubTag( `languageCode` ) `→` `string`

getResource( `resourceName`, `opt_locale` ) `→` `(Object|null|undefined)`

getResourceWithFallback( `resourceName`, `opt_locale` ) `→` `(Object|null|undefined)`

getScriptSubTag( `languageCode` ) `→` `string`

getVariantSubTag( `languageCode` ) `→` `string`

isResourceRegistered( `resourceName`, `localeName` ) `→` `boolean`

registerLocaleNameConstants( `dataObj`, `localeName` ) `→` `void`

registerResource( `dataObj`, `resourceName`, `localeName` ) `→` `void`

registerTimeZoneAllLongNames( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneConstants( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedIds( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedLongNames( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedShortNames( `dataObj`, `localeName` ) `→` `void`

setLocale( `localeName` ) `→` `void`

Properties

countries `→` `Array<string>`

nativeNameConstants `→` `Object<string, Object<string, string>>`

scriptToLanguages `→` `Object<string, Array<string>>`

Enumerations

goog.locale

Functions

getLanguageSubTag( languageCode ) → string

getLocale() → string

getLocalizedCountryName( languageCode, opt_localeSymbols ) → string

getLocalizedLanguageName( languageCode, opt_localeSymbols ) → string

getLocalizedRegionNameFromRegionCode( regionCode, opt_localeSymbols ) → string

getNativeCountryName( countryCode ) → string

getNativeLanguageName( languageCode ) → string

getRegionSubTag( languageCode ) → string

getResource( resourceName, opt_locale ) → (Object|null|undefined)

getResourceWithFallback( resourceName, opt_locale ) → (Object|null|undefined)

getScriptSubTag( languageCode ) → string

getVariantSubTag( languageCode ) → string

isResourceRegistered( resourceName, localeName ) → boolean

registerLocaleNameConstants( dataObj, localeName ) → void

registerResource( dataObj, resourceName, localeName ) → void

registerTimeZoneAllLongNames( dataObj, localeName ) → void

registerTimeZoneConstants( dataObj, localeName ) → void

registerTimeZoneSelectedIds( dataObj, localeName ) → void

registerTimeZoneSelectedLongNames( dataObj, localeName ) → void

registerTimeZoneSelectedShortNames( dataObj, localeName ) → void

setLocale( localeName ) → void

Properties

countries → Array<string>

nativeNameConstants → Object<string, Object<string, string>>

scriptToLanguages → Object<string, Array<string>>

Enumerations

getLanguageSubTag( `languageCode` ) `→` `string`

getLocale() `→` `string`

getLocalizedCountryName( `languageCode`, `opt_localeSymbols` ) `→` `string`

getLocalizedLanguageName( `languageCode`, `opt_localeSymbols` ) `→` `string`

getLocalizedRegionNameFromRegionCode( `regionCode`, `opt_localeSymbols` ) `→` `string`

getNativeCountryName( `countryCode` ) `→` `string`

getNativeLanguageName( `languageCode` ) `→` `string`

getRegionSubTag( `languageCode` ) `→` `string`

getResource( `resourceName`, `opt_locale` ) `→` `(Object|null|undefined)`

getResourceWithFallback( `resourceName`, `opt_locale` ) `→` `(Object|null|undefined)`

getScriptSubTag( `languageCode` ) `→` `string`

getVariantSubTag( `languageCode` ) `→` `string`

isResourceRegistered( `resourceName`, `localeName` ) `→` `boolean`

registerLocaleNameConstants( `dataObj`, `localeName` ) `→` `void`

registerResource( `dataObj`, `resourceName`, `localeName` ) `→` `void`

registerTimeZoneAllLongNames( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneConstants( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedIds( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedLongNames( `dataObj`, `localeName` ) `→` `void`

registerTimeZoneSelectedShortNames( `dataObj`, `localeName` ) `→` `void`

setLocale( `localeName` ) `→` `void`

countries `→` `Array<string>`

nativeNameConstants `→` `Object<string, Object<string, string>>`

scriptToLanguages `→` `Object<string, Array<string>>`