| --- |
| license: Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --- |
| |
| globalization.getPreferredLanguage |
| =========== |
| |
| Get the string identifier for the client's current language. |
| |
| navigator.globalization.getPreferredLanguage(successCallback, errorCallback); |
| |
| |
| Description |
| ----------- |
| |
| Returns the language identifier string to the `successCallback` with a |
| `properties` object as a parameter. That object should have a `value` |
| property with a `String` value. |
| |
| If there is an error getting the language, then the `errorCallback` |
| executes with a `GlobalizationError` object as a parameter. The |
| error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. |
| |
| Supported Platforms |
| ------------------- |
| |
| - Android |
| - BlackBerry WebWorks (OS 5.0 and higher) |
| - iOS |
| - Windows Phone 8 |
| |
| Quick Example |
| ------------- |
| |
| When the browser is set to the `en\_US` locale, this should display a |
| popup dialog with the text `language: English`: |
| |
| navigator.globalization.getPreferredLanguage( |
| function (language) {alert('language: ' + language.value + '\n');}, |
| function () {alert('Error getting language\n');} |
| ); |
| |
| Full Example |
| ------------ |
| |
| <!DOCTYPE HTML> |
| <html> |
| <head> |
| <title>getPreferredLanguage Example</title> |
| <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> |
| <script type="text/javascript" charset="utf-8"> |
| |
| function checkLanguage() { |
| navigator.globalization.getPreferredLanguage( |
| function (language) {alert('language: ' + language.value + '\n');}, |
| function () {alert('Error getting language\n');} |
| ); |
| } |
| </script> |
| </head> |
| <body> |
| <button onclick="checkLanguage()">Click for language</button> |
| </body> |
| </html> |
| |
| Windows Phone 8 Quirks |
| ------- |
| - Returns the ISO 639-1 two-letter code for the current language. |
