Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4E8B7D817 for ; Thu, 1 Nov 2012 17:32:14 +0000 (UTC) Received: (qmail 33876 invoked by uid 500); 1 Nov 2012 17:32:13 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 33711 invoked by uid 500); 1 Nov 2012 17:32:13 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 33583 invoked by uid 500); 1 Nov 2012 17:32:11 -0000 Delivered-To: apmail-incubator-callback-commits@incubator.apache.org Received: (qmail 33557 invoked by uid 99); 1 Nov 2012 17:32:11 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Nov 2012 17:32:11 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id C846A51807; Thu, 1 Nov 2012 17:32:10 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [5/10] Version 2.2.0 Message-Id: <20121101173210.C846A51807@tyr.zones.apache.org> Date: Thu, 1 Nov 2012 17:32:10 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/geolocation.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/geolocation.clearWatch.md b/docs/en/2.2.0/cordova/geolocation/geolocation.clearWatch.md new file mode 100644 index 0000000..5962a75 --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/geolocation.clearWatch.md @@ -0,0 +1,118 @@ +--- +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. +--- + +geolocation.clearWatch +====================== + +Stop watching for changes to the device's location referenced by the `watchID` parameter. + + navigator.geolocation.clearWatch(watchID); + +Parameters +---------- + +- __watchID:__ The id of the `watchPosition` interval to clear. (String) + +Description +----------- + +`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x +- webOS +- Tizen + +Quick Example +------------- + + // Options: watch for changes in position, and use the most + // accurate position acquisition method available. + // + var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true }); + + // ...later on... + + navigator.geolocation.clearWatch(watchID); + + +Full Example +------------ + + + + + Device Properties Example + + + + + +

Watching geolocation...

+ + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/geolocation.getCurrentPosition.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/2.2.0/cordova/geolocation/geolocation.getCurrentPosition.md new file mode 100644 index 0000000..b16b5d1 --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/geolocation.getCurrentPosition.md @@ -0,0 +1,127 @@ +--- +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. +--- + +geolocation.getCurrentPosition +============================== + +Returns the device's current position as a `Position` object. + + navigator.geolocation.getCurrentPosition(geolocationSuccess, + [geolocationError], + [geolocationOptions]); + +Parameters +---------- + +- __geolocationSuccess__: The callback that is called with the current position. +- __geolocationError__: (Optional) The callback that is called if there was an error. +- __geolocationOptions__: (Optional) The geolocation options. + +Description +----------- + +`geolocation.getCurrentPositon` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x +- webOS +- Tizen + +Quick Example +------------- + + // onSuccess Callback + // This method accepts a `Position` object, which contains + // the current GPS coordinates + // + var onSuccess = function(position) { + alert('Latitude: ' + position.coords.latitude + '\n' + + 'Longitude: ' + position.coords.longitude + '\n' + + 'Altitude: ' + position.coords.altitude + '\n' + + 'Accuracy: ' + position.coords.accuracy + '\n' + + 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' + + 'Heading: ' + position.coords.heading + '\n' + + 'Speed: ' + position.coords.speed + '\n' + + 'Timestamp: ' + position.timestamp + '\n'); + }; + + // onError Callback receives a PositionError object + // + function onError(error) { + alert('code: ' + error.code + '\n' + + 'message: ' + error.message + '\n'); + } + + navigator.geolocation.getCurrentPosition(onSuccess, onError); + +Full Example +------------ + + + + + Device Properties Example + + + + + +

Finding geolocation...

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/geolocation.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/geolocation.md b/docs/en/2.2.0/cordova/geolocation/geolocation.md new file mode 100644 index 0000000..f2838bb --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/geolocation.md @@ -0,0 +1,108 @@ +--- +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. +--- + +Geolocation +=========== + +> The `geolocation` object provides access to the device's GPS sensor. + +Geolocation provides location information for the device, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. No guarantee is given that the API returns the device's actual location. + +This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7, webOS and Tizen, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification. + +Methods +------- + +- geolocation.getCurrentPosition +- geolocation.watchPosition +- geolocation.clearWatch + + +Arguments +--------- + +- geolocationSuccess +- geolocationError +- geolocationOptions + +Objects (Read-Only) +------------------- + +- Position +- PositionError +- Coordinates + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + + +#### app/AndroidManifest.xml + + + + + +### Bada + + No permissions are required. + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +#### www/config.xml + + + read_geolocation + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Geolocation + CDVLocation + + +### webOS + + No permissions are required. + +### Windows Phone + +#### Properties/WPAppManifest.xml + + + + + +Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) + +### Tizen + + No permissions are required. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/geolocation.watchPosition.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/geolocation.watchPosition.md b/docs/en/2.2.0/cordova/geolocation/geolocation.watchPosition.md new file mode 100644 index 0000000..9e180eb --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/geolocation.watchPosition.md @@ -0,0 +1,129 @@ +--- +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. +--- + +geolocation.watchPosition +========================= + +Watches for changes to the device's current position. + + var watchId = navigator.geolocation.watchPosition(geolocationSuccess, + [geolocationError], + [geolocationOptions]); + +Parameters +---------- + +- __geolocationSuccess__: The callback that is called with the current position. +- __geolocationError__: (Optional) The callback that is called if there was an error. +- __geolocationOptions__: (Optional) The geolocation options. + +Returns +------- + +- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position. + +Description +----------- + +`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x +- webOS +- Tizen + +Quick Example +------------- + + // onSuccess Callback + // This method accepts a `Position` object, which contains + // the current GPS coordinates + // + function onSuccess(position) { + var element = document.getElementById('geolocation'); + element.innerHTML = 'Latitude: ' + position.coords.latitude + '
' + + 'Longitude: ' + position.coords.longitude + '
' + + '
' + element.innerHTML; + } + + // onError Callback receives a PositionError object + // + function onError(error) { + alert('code: ' + error.code + '\n' + + 'message: ' + error.message + '\n'); + } + + // Options: throw an error if no update is received every 30 seconds. + // + var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 }); + + +Full Example +------------ + + + + + Device Properties Example + + + + + +

Watching geolocation...

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/parameters/geolocation.options.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/parameters/geolocation.options.md b/docs/en/2.2.0/cordova/geolocation/parameters/geolocation.options.md new file mode 100644 index 0000000..d822d24 --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/parameters/geolocation.options.md @@ -0,0 +1,41 @@ +--- +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. +--- + +geolocationOptions +================== + +Optional parameters to customize the retrieval of the geolocation +`Position`. + + { maximumAge: 3000, timeout: 5000, enableHighAccuracy: true }; + +Options +------- + +- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_ +- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_ +- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_ + +Android Quirks +-------------- + +The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true. + + { enableHighAccuracy: true } + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/parameters/geolocationError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/parameters/geolocationError.md b/docs/en/2.2.0/cordova/geolocation/parameters/geolocationError.md new file mode 100644 index 0000000..c0091a0 --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/parameters/geolocationError.md @@ -0,0 +1,32 @@ +--- +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. +--- + +geolocationError +================ + +The user's callback function that is called when there is an error for geolocation functions. + + function(error) { + // Handle the error + } + +Parameters +---------- + +- __error:__ The error returned by the device. (`PositionError`) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/geolocation/parameters/geolocationSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/2.2.0/cordova/geolocation/parameters/geolocationSuccess.md new file mode 100644 index 0000000..b70a579 --- /dev/null +++ b/docs/en/2.2.0/cordova/geolocation/parameters/geolocationSuccess.md @@ -0,0 +1,46 @@ +--- +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. +--- + +geolocationSuccess +================== + +The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`). + + function(position) { + // Do something + } + +Parameters +---------- + +- __position:__ The geolocation position returned by the device. (`Position`) + +Example +------- + + function geolocationSuccess(position) { + alert('Latitude: ' + position.coords.latitude + '\n' + + 'Longitude: ' + position.coords.longitude + '\n' + + 'Altitude: ' + position.coords.altitude + '\n' + + 'Accuracy: ' + position.coords.accuracy + '\n' + + 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' + + 'Heading: ' + position.coords.heading + '\n' + + 'Speed: ' + position.coords.speed + '\n' + + 'Timestamp: ' + position.timestamp + '\n'); + } http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/GlobalizationError/globalizationerror.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/2.2.0/cordova/globalization/GlobalizationError/globalizationerror.md new file mode 100644 index 0000000..77b56e2 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/GlobalizationError/globalizationerror.md @@ -0,0 +1,93 @@ +--- +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. +--- + +GlobalizationError +============ + +An object representing a error from the Globalization API. + +Properties +---------- + +- __code:__ One of the following codes representing the error type (`Number`) + - GlobalizationError.UNKNOWN\_ERROR: 0 + - GlobalizationError.FORMATTING\_ERROR: 1 + - GlobalizationError.PARSING\_ERROR: 2 + - GlobalizationError.PATTERN\_ERROR: 3 +- __message:__ A text message that includes the error explanation and/or details (`String`) + +Description +----------- + +This object is created and populated by Cordova, and returned to a callback in the case of an error. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS + +Quick Example +------------- + +When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ". + + function errorCB(error) { + alert('code: ' + error.code + '\n' + + 'message: ' + error.message + '\n'); + }; + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.dateToString.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.dateToString.md b/docs/en/2.2.0/cordova/globalization/globalization.dateToString.md new file mode 100644 index 0000000..46c7e95 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.dateToString.md @@ -0,0 +1,86 @@ +--- +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.dateToString +=========== + +Returns a date formatted as a string according to the client's locale and timezone. + + navigator.globalization.dateToString(date, successCB, errorCB, options); + +Description +----------- + +It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value. + +The inbound ``date`` parameter should be of type ``Date``. + +If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR. + +`options.formatLength` can be 'short', 'medium', 'long', or 'full'. +`options.selector` can be 'date', 'time' or 'date and time'. + +The default options are `{formatLength:'short', selector:'date and time'}`. +The `options` parameter is optional. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options. + + navigator.globalization.dateToString( + new Date(), + function (date) {alert('date:' + date.value + '\n');}, + function () {alert('Error getting dateString\n');}, + {formatLength:'short', selector:'date and time'} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getCurrencyPattern.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/2.2.0/cordova/globalization/globalization.getCurrencyPattern.md new file mode 100644 index 0000000..b3e510e --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getCurrencyPattern.md @@ -0,0 +1,106 @@ +--- +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.getCurrencyPattern +=========== + +Returns a pattern string for formatting and parsing currency values according +to the client's user preferences and ISO 4217 currency code. + + navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB); + +Description +----------- + +It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties: + +- pattern {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. +- code {String}: The ISO 4217 currency code for the pattern. +- fraction {Number}: The number of fractional digits to use when parsing and formatting currency. +- rounding {Number}: The rounding increment to use when parsing and formatting. +- decimal: {String}: The decimal symbol to use for parsing and formatting. +- grouping: {String}: The grouping symbol to use for parsing and formatting. + +The inbound `currencyCode` parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'. + +If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to: + + pattern: $#,##0.##;($#,##0.##) + code: USD + fraction: 2 + rounding: 0 + decimal: . + grouping: , + +. + + navigator.globalization.getCurrencyPattern( + 'USD', + function (pattern) {alert('pattern: ' + pattern.pattern + '\n' + + 'code: ' + pattern.code + '\n' + + 'fraction: ' + pattern.fraction + '\n' + + 'rounding: ' + pattern.rounding + '\n' + + 'decimal: ' + pattern.decimal + '\n' + + 'grouping: ' + pattern.grouping);}, + function () {alert('Error getting pattern\n');} + ); + + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getDateNames.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getDateNames.md b/docs/en/2.2.0/cordova/globalization/globalization.getDateNames.md new file mode 100644 index 0000000..a3aa1b4 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getDateNames.md @@ -0,0 +1,92 @@ +--- +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.getDateNames +=========== + +Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar. + + navigator.globalization.getDateNames(successCB, errorCB, options); + +Description +----------- + +It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected. + +If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR. + +`options.type` can be 'narrow', or 'wide'. +`options.item` can be 'months', or 'days'. + +The default options are `{type:'wide', item:'months'}`. +The options parameter is optional. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January" + + navigator.globalization.getDateNames( + function (names) { + for (var i=0; i + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getDatePattern.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getDatePattern.md b/docs/en/2.2.0/cordova/globalization/globalization.getDatePattern.md new file mode 100644 index 0000000..325c7d5 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getDatePattern.md @@ -0,0 +1,89 @@ +--- +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.getDatePattern +=========== + +Returns a pattern string for formatting and parsing dates according to the client's user preferences. + + navigator.globalization.getDatePattern(successCB, errorCB, options); + +Description +----------- + +It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties: + +- pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. +- timezone {String}: The abbreviated name of the time zone on the client +- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time. +- dst\_offset {Number}: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. + +If there is an error obtaining the pattern, then the errorCB callback is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR. + +`options.formatLength` can be 'short', 'medium', 'long', or 'full'. +`options.selector` can be 'date', 'time' or 'date and time'. + +The default options are `{formatLength:'short', selector:'date and time'}`. +The options parameter is optional. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a". + + function checkDatePattern() { + navigator.globalization.getDatePattern( + function (date) {alert('pattern: ' + date.pattern + '\n');}, + function () {alert('Error getting pattern\n');}, + {formatLength:'short', selector:'date and time'} + ); + } + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getFirstDayOfWeek.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/2.2.0/cordova/globalization/globalization.getFirstDayOfWeek.md new file mode 100644 index 0000000..4a79901 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getFirstDayOfWeek.md @@ -0,0 +1,75 @@ +--- +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.getFirstDayOfWeek +=========== + +Returns the first day of the week according to the client's user preferences and calendar. + + navigator.globalization.getFirstDayOfWeek(successCB, errorCB); + +Description +----------- + +The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value. + +If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1". + + navigator.globalization.getFirstDayOfWeek( + function (day) {alert('day: ' + day.value + '\n');}, + function () {alert('Error getting day\n');} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getLocaleName.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getLocaleName.md b/docs/en/2.2.0/cordova/globalization/globalization.getLocaleName.md new file mode 100644 index 0000000..9fa378f --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getLocaleName.md @@ -0,0 +1,77 @@ +--- +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.getLocaleName +=========== + +Get the string identifier for the client's current locale setting. + + navigator.globalization.getLocaleName(successCB, errorCB); + + +Description +----------- + +It returns the locale identifier string to the successCB callback 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 locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US". + + navigator.globalization.getLocaleName( + function (locale) {alert('locale: ' + locale.value + '\n');}, + function () {alert('Error getting locale\n');} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getNumberPattern.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getNumberPattern.md b/docs/en/2.2.0/cordova/globalization/globalization.getNumberPattern.md new file mode 100644 index 0000000..5b64bda --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getNumberPattern.md @@ -0,0 +1,114 @@ +--- +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.getNumberPattern +=========== + +Returns a pattern string for formatting and parsing numbers according to the client's user preferences. + + navigator.globalization.getNumberPattern(successCB, errorCB, options); + +Description +----------- + +It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties: + +- pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. +- symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol. +- fraction {Number}: The number of fractional digits to use when parsing and formatting numbers. +- rounding {Number}: The rounding increment to use when parsing and formatting. +- positive {String}: The symbol to use for positive numbers when parsing and formatting. +- negative: {String}: The symbol to use for negative numbers when parsing and formatting. +- decimal: {String}: The decimal symbol to use for parsing and formatting. +- grouping: {String}: The grouping symbol to use for parsing and formatting. + +If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR. + +`options.type` can be 'decimal', 'percent', or 'currency'. +The default options are `{type:'decimal'}`. The `options` parameter is optional. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to: + + pattern: #,##0.### + symbol: . + fraction: 0 + rounding: 0 + positive: + negative: - + decimal: . + grouping: , + +. + + navigator.globalization.getNumberPattern( + function (pattern) {alert('pattern: ' + pattern.pattern + '\n' + + 'symbol: ' + pattern.symbol + '\n' + + 'fraction: ' + pattern.fraction + '\n' + + 'rounding: ' + pattern.rounding + '\n' + + 'positive: ' + pattern.positive + '\n' + + 'negative: ' + pattern.negative + '\n' + + 'decimal: ' + pattern.decimal + '\n' + + 'grouping: ' + pattern.grouping);}, + function () {alert('Error getting pattern\n');}, + {type:'decimal'} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.getPreferredLanguage.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/2.2.0/cordova/globalization/globalization.getPreferredLanguage.md new file mode 100644 index 0000000..63dc809 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.getPreferredLanguage.md @@ -0,0 +1,76 @@ +--- +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(successCB, errorCB); + + +Description +----------- + +It returns the language identifier string to the successCB callback 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 errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + + +Quick Example +------------- + +In the case 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 +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.isDayLightSavingsTime.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/2.2.0/cordova/globalization/globalization.isDayLightSavingsTime.md new file mode 100644 index 0000000..fd5faa2 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.isDayLightSavingsTime.md @@ -0,0 +1,78 @@ +--- +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.isDayLightSavingsTime +=========== + +Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar. + + navigator.globalization.isDayLightSavingsTime(date, successCB, errorCB); + +Description +----------- + +It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a ``dst`` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not. + +The inbound parameter `date` should be of type `Date`. + +If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true". + + navigator.globalization.isDayLightSavingsTime( + new Date(), + function (date) {alert('dst: ' + date.dst + '\n');}, + function () {alert('Error getting names\n');} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.md b/docs/en/2.2.0/cordova/globalization/globalization.md new file mode 100644 index 0000000..15e787e --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.md @@ -0,0 +1,61 @@ +--- +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 +====== + +The `globalization` object obtains information and performs operations specific to the user's locale and timezone. + +Objects +------- + +- GlobalizationError + +Methods +------- + +- globalization.getPreferredLanguage +- globalization.getLocaleName +- globalization.dateToString +- globalization.stringToDate +- globalization.getDatePattern +- globalization.getDateNames +- globalization.isDayLightSavingsTime +- globalization.getFirstDayOfWeek +- globalization.numberToString +- globalization.stringToNumber +- globalization.getNumberPattern +- globalization.getCurrencyPattern + +Variable Scope +-------------- + +The `globalization` object is a child of the `navigator` object, and therefore has global scope. + + // The global globalization object + var globalization = navigator.globalization; + +Permissions +----------- + +### Android + +#### app/res/xml/config.xml + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.numberToString.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.numberToString.md b/docs/en/2.2.0/cordova/globalization/globalization.numberToString.md new file mode 100644 index 0000000..35ec6d2 --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.numberToString.md @@ -0,0 +1,80 @@ +--- +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.numberToString +=========== + +Returns a number formatted as a string according to the client's user preferences. + + navigator.globalization.numberToString(number, successCB, errorCB, options); + +Description +----------- + +It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value. + +If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR. + +`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142" + + navigator.globalization.numberToString( + 3.1415926, + function (number) {alert('number: ' + number.value + '\n');}, + function () {alert('Error getting number\n');}, + {type:'decimal'} + ); + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.stringToDate.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.stringToDate.md b/docs/en/2.2.0/cordova/globalization/globalization.stringToDate.md new file mode 100644 index 0000000..05c447e --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.stringToDate.md @@ -0,0 +1,102 @@ +--- +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.stringToDate +=========== + +Parses a date formatted as a string according to the client's user +preferences and calendar using the time zone of the client and returns +the corresponding date object. + + navigator.globalization.stringToDate(dateString, successCB, errorCB, options); + +Description +----------- + +It returns the date to the success callback with a properties object as a parameter. That object should have the following properties: + +- year {Number}: The four digit year +- month {Number}: The month from (0 - 11) +- day {Number}: The day from (1 - 31) +- hour {Number}: The hour from (0 - 23) +- minute {Number}: The minute from (0 - 59) +- second {Number}: The second from (0 - 59) +- millisecond {Number}: The milliseconds (from 0 - 999), not available on all platforms + +The inbound `dateString` parameter should be of type `String`. + +`options.formatLength` can be 'short', 'medium', 'long', or 'full'. +`options.selector` can be 'date', 'time' or 'date and time'. + +The default options are `{formatLength:'short', selector:'date and time'}`. +The options parameter is optional. + +If there is an error parsing the date string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index. + + navigator.globalization.stringToDate( + '9/25/2012', + function (date) {alert('month:' + date.month + + ' day:' + date.day + + ' year:' + date.year + '\n');}, + function () {alert('Error getting date\n');}, + {selector:'date'} + ); + + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/globalization/globalization.stringToNumber.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/globalization/globalization.stringToNumber.md b/docs/en/2.2.0/cordova/globalization/globalization.stringToNumber.md new file mode 100644 index 0000000..d788b4f --- /dev/null +++ b/docs/en/2.2.0/cordova/globalization/globalization.stringToNumber.md @@ -0,0 +1,83 @@ +--- +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.stringToNumber +=========== + +Parses a number formatted as a string according to the client's user preferences and returns the corresponding number. + + navigator.globalization.stringToNumber(string, successCB, errorCB, options); + +Description +----------- + +It returns the number to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value. + +If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR. + +`options.type` can be 'decimal', 'percent', or 'currency'. +The default options are `{type:'decimal'}`. The `options` parameter is optional. + + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone + +Quick Example +------------- + +In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56". + + navigator.globalization.stringToNumber( + '1234.56', + function (number) {alert('number: ' + number.value + '\n');}, + function () {alert('Error getting number\n');}, + {type:'decimal'} + ); + + +Full Example +------------ + + + + + Cordova + + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/MediaError/mediaError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/MediaError/mediaError.md b/docs/en/2.2.0/cordova/media/MediaError/mediaError.md new file mode 100644 index 0000000..ab79258 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/MediaError/mediaError.md @@ -0,0 +1,44 @@ +--- +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. +--- + +MediaError +========== + +A `MediaError` object is returned to the `mediaError` callback function when an error occurs. + +Properties +---------- + +- __code:__ One of the predefined error codes listed below. +- __message:__ Error message describing the details of the error. + +Constants +--------- + +- `MediaError.MEDIA_ERR_ABORTED` +- `MediaError.MEDIA_ERR_NETWORK` +- `MediaError.MEDIA_ERR_DECODE` +- `MediaError.MEDIA_ERR_NONE_SUPPORTED` + + +Description +----------- + +The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs. + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/Parameters/mediaError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/Parameters/mediaError.md b/docs/en/2.2.0/cordova/media/Parameters/mediaError.md new file mode 100644 index 0000000..e1803b4 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/Parameters/mediaError.md @@ -0,0 +1,32 @@ +--- +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. +--- + +mediaError +========== + +A user specified callback function that is invoked when there is an error in media functions. + + function(error) { + // Handle the error + } + +Parameters +---------- + +- __error:__ The error returned by the device. (`MediaError`) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/CaptureCB.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/CaptureCB.md b/docs/en/2.2.0/cordova/media/capture/CaptureCB.md new file mode 100644 index 0000000..5f31fd0 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/CaptureCB.md @@ -0,0 +1,44 @@ +--- +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. +--- + +CaptureCB +========= + +> Invoked upon a successful media capture operation. + + function captureSuccess( MediaFile[] mediaFiles ) { ... }; + +Description +----------- + +This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached. + +Each MediaFile object describes a captured media file. + +Quick Example +------------- + + // capture callback + function captureSuccess(mediaFiles) { + var i, path, len; + for (i = 0, len = mediaFiles.length; i < len; i += 1) { + path = mediaFiles[i].fullPath; + // do something interesting with the file + } + }; http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/CaptureError.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/CaptureError.md b/docs/en/2.2.0/cordova/media/capture/CaptureError.md new file mode 100644 index 0000000..5f98d51 --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/CaptureError.md @@ -0,0 +1,37 @@ +--- +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. +--- + +CaptureError +============ + +> Encapsulates the error code resulting from a failed media capture operation. + +Properties +---------- + +- __code:__ One of the pre-defined error codes listed below. + +Constants +--------- + +- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound. +- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request. +- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one). +- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything. +- CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/6ecf3e80/docs/en/2.2.0/cordova/media/capture/CaptureErrorCB.md ---------------------------------------------------------------------- diff --git a/docs/en/2.2.0/cordova/media/capture/CaptureErrorCB.md b/docs/en/2.2.0/cordova/media/capture/CaptureErrorCB.md new file mode 100644 index 0000000..948140a --- /dev/null +++ b/docs/en/2.2.0/cordova/media/capture/CaptureErrorCB.md @@ -0,0 +1,40 @@ +--- +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. +--- + +CaptureErrorCB +============== + +> Invoked if an error occurs during a media capture operation. + + function captureError( CaptureError error ) { ... }; + +Description +----------- + +This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured. + +This function is invoked with a CaptureError object containing an appropriate error code. + +Quick Example +------------- + + // capture error callback + var captureError = function(error) { + navigator.notification.alert('Error code: ' + error.code, null, 'Capture Error'); + };