You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/19 04:01:13 UTC
[3/7] CB-5658 Delete plugin API reference in favour of links to
github doc/index.md files
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
deleted file mode 100644
index 210e4a9..0000000
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ /dev/null
@@ -1,105 +0,0 @@
----
-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 to format and parse dates according to the
-client's user preferences.
-
- navigator.globalization.getDatePattern(successCallback, errorCallback, options);
-
-## Description
-
-Returns the pattern to the `successCallback`. The object passed in as
-a parameter contains the following properties:
-
-- __pattern__: The date and time pattern to format and parse dates. The patterns follow [Unicode Technical Standard #35](http://unicode.org/reports/tr35/tr35-4.html). _(String)_
-
-- __timezone__: The abbreviated name of the time zone on the client. _(String)_
-
-- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_
-
-- __dst\_offset__: 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. _(Number)_
-
-If there is an error obtaining the pattern, the `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.PATTERN\_ERROR`.
-
-The `options` parameter is optional, and defaults to the following values:
-
- {formatLength:'short', selector:'date and time'}
-
-The `options.formatLength` can be `short`, `medium`, `long`, or
-`full`. The `options.selector` can be `date`, `time` or `date and
-time`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this example displays
-a popup dialog with text such as `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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>getDatePattern Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkDatePattern() {
- navigator.globalization.getDatePattern(
- function (date) {alert('pattern: ' + date.pattern + '\n');},
- function () {alert('Error getting pattern\n');},
- {formatLength:'short', selector:'date and time'}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkDatePattern()">Click for pattern</button>
- </body>
- </html>
-
-## Windows Phone 8 Quirks
-
-- The `formatLength` supports only `short` and `full` values.
-
-- The `pattern` for `date and time` pattern returns only full datetime format.
-
-- The `timezone` returns the full time zone name.
-
-- The `dst_offset` property is not supported, and always returns zero.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
deleted file mode 100644
index 08338d1..0000000
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ /dev/null
@@ -1,77 +0,0 @@
----
-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(successCallback, errorCallback);
-
-## Description
-
-The days of the week are numbered starting from 1, where 1 is assumed
-to be Sunday. Returns the day to the `successCallback` 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 `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this displays 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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>getFirstDayOfWeek Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkFirstDay() {
- navigator.globalization.getFirstDayOfWeek(
- function (day) {alert('day: ' + day.value + '\n');},
- function () {alert('Error getting day\n');}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkFirstDay()">Click for first day of week</button>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
deleted file mode 100644
index 0da6e56..0000000
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ /dev/null
@@ -1,77 +0,0 @@
----
-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(successCallback, errorCallback);
-
-## Description
-
-Returns the locale 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 locale, then the `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this displays 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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>getLocaleName Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkLocale() {
- navigator.globalization.getLocaleName(
- function (locale) {alert('locale: ' + locale.value + '\n');},
- function () {alert('Error getting locale\n');}
- );
- }
- </script>
- </head>
- <body>
- <button onclick="checkLocale()">Click for locale</button>
- </body>
- </html>
-
-## Windows Phone 8 Quirks
-
-- Returns the two-letter code defined in ISO 3166 for the current country/region.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
deleted file mode 100644
index b6915a0..0000000
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ /dev/null
@@ -1,128 +0,0 @@
----
-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 to format and parse numbers according to the client's user preferences.
-
- navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
-
-## Description
-
-Returns the pattern to the `successCallback` with a `properties` object
-as a parameter. That object contains the following properties:
-
-- __pattern__: The number pattern to format and parse numbers. The patterns follow [Unicode Technical Standard #35](http://unicode.org/reports/tr35/tr35-4.html). _(String)_
-
-- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_
-
-- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_
-
-- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
-
-- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_
-
-- __negative__: The symbol to use for negative numbers when parsing and formatting. _(String)_
-
-- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
-
-- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
-
-If there is an error obtaining the pattern, then the `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.PATTERN\_ERROR`.
-
-The `options` parameter is optional, and default values are:
-
- {type:'decimal'}
-
-The `options.type` can be `decimal`, `percent`, or `currency`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this should display a
-popup dialog with text similar to the results that follow:
-
- 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'}
- );
-
-Results:
-
- pattern: #,##0.###
- symbol: .
- fraction: 0
- rounding: 0
- positive:
- negative: -
- decimal: .
- grouping: ,
-
-## Full Example
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>getNumberPattern Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkPattern() {
- 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'}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkPattern()">Click for pattern</button>
- </body>
- </html>
-
-## Windows Phone 8 Quirks
-
-- The `pattern` property is not supported, and retuens an empty string.
-
-- The `fraction` property is not supported, and returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
deleted file mode 100644
index d036cab..0000000
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ /dev/null
@@ -1,77 +0,0 @@
----
-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
-
-- Amazon Fire OS
-- Android
-- 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.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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
deleted file mode 100644
index 6d7fd23..0000000
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ /dev/null
@@ -1,82 +0,0 @@
----
-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
-
-Indicates whether daylight savings time is in effect for a given date
-using the client's time zone and calendar.
-
- navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
-
-## Description
-
-Indicates whether or not daylight savings time is in effect to the
-`successCallback` with a `properties` object as a parameter. That object
-should have a `dst` property with a `Boolean` value. A `true` value
-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 `errorCallback`
-executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-During the summer, and if 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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>isDayLightSavingsTime Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkDayLightSavings() {
- navigator.globalization.isDayLightSavingsTime(
- new Date(),
- function (date) {alert('dst: ' + date.dst + '\n');},
- function () {alert('Error getting names\n');}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkDayLightSavings()">Click for daylight savings</button>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.md b/docs/en/edge/cordova/globalization/globalization.md
deleted file mode 100644
index dc096e6..0000000
--- a/docs/en/edge/cordova/globalization/globalization.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-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
-
-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;
-
-## Accessing the Feature
-
-As of version 3.0, Cordova implements device-level APIs as _plugins_.
-Use the CLI's `plugin` command, described in The Command-Line
-Interface, to add or remove this feature for a project:
-
- $ cordova plugin add org.apache.cordova.globalization
- $ cordova plugin ls
- [ 'org.apache.cordova.globalization' ]
- $ cordova plugin rm org.apache.cordova.globalization
-
-These commands apply to all targeted platforms, but modify the
-platform-specific configuration settings described below:
-
-* Amazon Fire OS(in `res/xml/config.xml`)
-
- <feature name="Globalization">
- <param name="android-package" value="org.apache.cordova.globalization.Globalization" />
- </feature>
-
-* Android (in `res/xml/config.xml`)
-
- <feature name="Globalization">
- <param name="android-package" value="org.apache.cordova.globalization.Globalization" />
- </feature>
-
-Some platforms may support this feature without requiring any special
-configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
deleted file mode 100644
index 21b9053..0000000
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ /dev/null
@@ -1,85 +0,0 @@
----
-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, successCallback, errorCallback, options);
-
-## Description
-
-Returns the formatted number 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 formatting the number, then the `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
-
-The `options` parameter is optional, and its default values are:
-
- {type:'decimal'}
-
-The `options.type` can be 'decimal', 'percent', or 'currency'.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this displays 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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>numberToString Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkNumber() {
- navigator.globalization.numberToString(
- 3.1415926,
- function (number) {alert('number: ' + number.value + '\n');},
- function () {alert('Error getting number\n');},
- {type:'decimal'}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkNumber()">Click for number</button>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
deleted file mode 100644
index 6806a3b..0000000
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ /dev/null
@@ -1,114 +0,0 @@
----
-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, successCallback, errorCallback, options);
-
-## Description
-
-Returns the date to the success callback with a `properties` object as
-a parameter. That object should have the following properties:
-
-- __year__: The four digit year. _(Number)_
-
-- __month__: The month from (0-11). _(Number)_
-
-- __day__: The day from (1-31). _(Number)_
-
-- __hour__: The hour from (0-23). _(Number)_
-
-- __minute__: The minute from (0-59). _(Number)_
-
-- __second__: The second from (0-59). _(Number)_
-
-- __millisecond__: The milliseconds (from 0-999), not available on all platforms. _(Number)_
-
-The inbound `dateString` parameter should be of type `String`.
-
-The `options` parameter is optional, and defaults to the following
-values:
-
- {formatLength:'short', selector:'date and time'}
-
-The `options.formatLength` can be `short`, `medium`, `long`, or
-`full`. The `options.selector` can be `date`, `time` or `date and
-time`.
-
-If there is an error parsing the date string, then the `errorCallback`
-executes with a `GlobalizationError` object as a parameter. The
-error's expected code is `GlobalizationError.PARSING\_ERROR`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-When the browser is set to the `en\_US` locale, this displays 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 array 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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>stringToDate Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkStringDate() {
- 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'}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkStringDate()">Click for parsed date</button>
- </body>
- </html>
-
-## Windows Phone 8 Quirks
-
-- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
deleted file mode 100644
index 77cff90..0000000
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ /dev/null
@@ -1,88 +0,0 @@
----
-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, successCallback, errorCallback, options);
-
-## Description
-
-Returns the number to the `successCallback` 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
-`errorCallback` executes with a `GlobalizationError` object as a
-parameter. The error's expected code is
-`GlobalizationError.PARSING\_ERROR`.
-
-The `options` parameter is optional, and defaults to the following
-values:
-
- {type:'decimal'}
-
-The `options.type` can be `decimal`, `percent`, or `currency`.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- iOS
-- Windows Phone 8
-
-## Quick Example
-
-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
-
- <!DOCTYPE HTML>
- <html>
- <head>
- <title>stringToNumber Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- function checkNumber() {
- navigator.globalization.stringToNumber(
- '1234.56',
- function (number) {alert('number: ' + number.value + '\n');},
- function () {alert('Error getting number\n');},
- {type:'decimal'}
- );
- }
-
- </script>
- </head>
- <body>
- <button onclick="checkNumber()">Click for parsed number</button>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md
deleted file mode 100644
index 0d29865..0000000
--- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md
+++ /dev/null
@@ -1,497 +0,0 @@
----
-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.
----
-
-# InAppBrowser
-
-> The `InAppBrowser` is a web browser view that displays when calling `window.open()`, or when opening a link formed as `<a target="_blank">`.
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
-
-__NOTE__: The InAppBrowser window behaves like a standard web browser,
-and can't access Cordova APIs.
-
-## Description
-
-The object returned from a call to `window.open`.
-
-## Methods
-
-- addEventListener
-- removeEventListener
-- close
-- show
-- executeScript
-- insertCSS
-
-## Accessing the Feature
-
-As of version 3.0, Cordova implements device-level APIs as _plugins_.
-Use the CLI's `plugin` command, described in The Command-Line
-Interface, to add or remove this feature for a project:
-
- $ cordova plugin add org.apache.cordova.inappbrowser
- $ cordova plugin ls
- [ 'org.apache.cordova.inappbrowser' ]
- $ cordova plugin rm org.apache.cordova.inappbrowser
-
-These commands apply to all targeted platforms, but modify the
-platform-specific configuration settings described below:
-
-* Amazon Fire OS (in `res/xml/config.xml`)
-
- <feature name="InAppBrowser">
- <param name="android-package" value="org.apache.cordova.inappbrowser.InAppBrowser" />
- </feature>
-
-* Android (in `res/xml/config.xml`)
-
- <feature name="InAppBrowser">
- <param name="android-package" value="org.apache.cordova.inappbrowser.InAppBrowser" />
- </feature>
-
-* iOS (in the named application directory's `config.xml`)
-
- <feature name="InAppBrowser">
- <param name="ios-package" value="CDVInAppBrowser" />
- </feature>
-
-* Windows Phone 7 and 8 (in `config.xml`)
-
- <feature name="InAppBrowser" />
-
-Some platforms may support this feature without requiring any special
-configuration. See Platform Support for an overview.
-
-# addEventListener
-
-> Adds a listener for an event from the `InAppBrowser`.
-
- ref.addEventListener(eventname, callback);
-
-- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
-
-- __eventname__: the event to listen for _(String)_
-
- - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
- - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
- - __loaderror__: event fires when the `InAppBrowser` encounters an error when loading a URL.
- - __exit__: event fires when the `InAppBrowser` window is closed.
-
-- __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- ref.addEventListener('loadstart', function() { alert(event.url); });
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.addEventListener Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- function onDeviceReady() {
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- ref.addEventListener('loadstart', function(event) { alert('start: ' + event.url); });
- ref.addEventListener('loadstop', function(event) { alert('stop: ' + event.url); });
- ref.addEventListener('loaderror', function(event) { alert('error: ' + event.message); });
- ref.addEventListener('exit', function(event) { alert(event.type); });
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# removeEventListener
-
-> Removes a listener for an event from the `InAppBrowser`.
-
- ref.removeEventListener(eventname, callback);
-
-- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
-
-- __eventname__: the event to stop listening for. _(String)_
-
- - __loadstart__: event fires when the `InAppBrowser` starts to load a URL.
- - __loadstop__: event fires when the `InAppBrowser` finishes loading a URL.
- - __loaderror__: event fires when the `InAppBrowser` encounters an error loading a URL.
- - __exit__: event fires when the `InAppBrowser` window is closed.
-
-- __callback__: the function to execute when the event fires.
-The function is passed an `InAppBrowserEvent` object.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- var myCallback = function() { alert(event.url); }
- ref.addEventListener('loadstart', myCallback);
- ref.removeEventListener('loadstart', myCallback);
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.removeEventListener Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Global InAppBrowser reference
- var iabRef = null;
-
- function iabLoadStart(event) {
- alert(event.type + ' - ' + event.url);
- }
-
- function iabLoadStop(event) {
- alert(event.type + ' - ' + event.url);
- }
-
- function iabLoadError(event) {
- alert(event.type + ' - ' + event.message);
- }
-
- function iabClose(event) {
- alert(event.type);
- iabRef.removeEventListener('loadstart', iabLoadStart);
- iabRef.removeEventListener('loadstop', iabLoadStop);
- iabRef.removeEventListener('loaderror', iabLoadError);
- iabRef.removeEventListener('exit', iabClose);
- }
-
- // device APIs are available
- //
- function onDeviceReady() {
- iabRef = window.open('http://apache.org', '_blank', 'location=yes');
- iabRef.addEventListener('loadstart', iabLoadStart);
- iabRef.addEventListener('loadstop', iabLoadStop);
- iabRef.addEventListener('loaderror', iabLoadError);
- iabRef.addEventListener('exit', iabClose);
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# close
-
-> Closes the `InAppBrowser` window.
-
- ref.close();
-
-- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- ref.close();
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.close Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- function onDeviceReady() {
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- // close InAppBrowser after 5 seconds
- setTimeout(function() {
- ref.close();
- }, 5000);
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# show
-
-> Displays an InAppBrowser window that was opened hidden. Calling this has no effect if the InAppBrowser was already visible.
-
- ref.show();
-
-- __ref__: reference to the InAppBrowser window (`InAppBrowser`)
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'hidden=yes');
- ref.show();
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.show Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- var ref = window.open('http://apache.org', '_blank', 'hidden=yes');
- ref.addEventListener('loadstop', function(event) {
- alert('background window loaded');
- });
- // close InAppBrowser after 5 seconds
- setTimeout(function() {
- ref.close();
- }, 5000);
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# executeScript
-
-> Injects JavaScript code into the `InAppBrowser` window
-
- ref.executeScript(details, callback);
-
-- __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_
-
-- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- - __file__: URL of the script to inject.
- - __code__: Text of the script to inject.
-
-- __callback__: the function that executes after the JavaScript code is injected.
- - If the injected script is of type `code`, the callback executes
- with a single parameter, which is the return value of the
- script, wrapped in an `Array`. For multi-line scripts, this is
- the return value of the last statement, or the last expression
- evaluated.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- ref.addEventListener('loadstop', function() {
- ref.executeScript({file: "myscript.js"});
- });
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.executeScript Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Global InAppBrowser reference
- var iabRef = null;
-
- // Inject our custom JavaScript into the InAppBrowser window
- //
- function replaceHeaderImage() {
- iabRef.executeScript({
- code: "var img=document.querySelector('#header img'); img.src='http://cordova.apache.org/images/cordova_bot.png';"
- }, function() {
- alert("Image Element Successfully Hijacked");
- });
- }
-
- function iabClose(event) {
- iabRef.removeEventListener('loadstop', replaceHeaderImage);
- iabRef.removeEventListener('exit', iabClose);
- }
-
- // device APIs are available
- //
- function onDeviceReady() {
- iabRef = window.open('http://apache.org', '_blank', 'location=yes');
- iabRef.addEventListener('loadstop', replaceHeaderImage);
- iabRef.addEventListener('exit', iabClose);
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# insertCSS
-
-> Injects CSS into the `InAppBrowser` window.
-
- ref.insertCSS(details, callback);
-
-- __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_
-
-- __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_
- - __file__: URL of the stylesheet to inject.
- - __code__: Text of the stylesheet to inject.
-
-- __callback__: the function that executes after the CSS is injected.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- ref.addEventListener('loadstop', function() {
- ref.insertCSS({file: "mystyles.css"});
- });
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>InAppBrowser.insertCSS Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Global InAppBrowser reference
- var iabRef = null;
-
- // Inject our custom CSS into the InAppBrowser window
- //
- function changeBackgroundColor() {
- iabRef.insertCSS({
- code: "body { background: #ffff00; }"
- }, function() {
- alert("Styles Altered");
- });
- }
-
- function iabClose(event) {
- iabRef.removeEventListener('loadstop', changeBackgroundColor);
- iabRef.removeEventListener('exit', iabClose);
- }
-
- // device APIs are available
- //
- function onDeviceReady() {
- iabRef = window.open('http://apache.org', '_blank', 'location=yes');
- iabRef.addEventListener('loadstop', changeBackgroundColor);
- iabRef.addEventListener('exit', iabClose);
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
-
-# InAppBrowserEvent
-
-The object that is passed to the callback function from an
-`addEventListener` call on an `InAppBrowser` object.
-
-## Properties
-
-- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
-
-- __url__: the URL that was loaded. _(String)_
-
-- __code__: the error code, only in the case of `loaderror`. _(Number)_
-
-- __message__: the error message, only in the case of `loaderror`. _(String)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/inappbrowser/window.open.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/inappbrowser/window.open.md b/docs/en/edge/cordova/inappbrowser/window.open.md
deleted file mode 100644
index 3ecaccd..0000000
--- a/docs/en/edge/cordova/inappbrowser/window.open.md
+++ /dev/null
@@ -1,105 +0,0 @@
----
-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.
----
-
-# window.open
-
-Opens a URL in a new `InAppBrowser` instance, the current browser
-instance, or the system browser.
-
- var ref = window.open(url, target, options);
-
-- __ref__: Reference to the `InAppBrowser` window. _(InAppBrowser)_
-
-- __url__: The URL to load _(String)_. Call `encodeURI()` on this if the URL contains Unicode characters.
-
-- __target__: The target in which to load the URL, an optional parameter that defaults to `_self`. _(String)_
-
- - `_self`: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the `InAppBrowser`.
- - `_blank`: Opens in the `InAppBrowser`.
- - `_system`: Opens in the system's web browser.
-
-- __options__: Options for the `InAppBrowser`. Optional, defaulting to: `location=yes`. _(String)_
-
- The `options` string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
-
- - __location__: Set to `yes` or `no` to turn the `InAppBrowser`'s location bar on or off.
-
- Android only:
-
- - __closebuttoncaption__: set to a string to use as the __Done__ button's caption.
- - __hidden__: set to `yes` to create the browser and load the page, but not show it. The load event fires when loading is complete. Omit or set to `no` (default) to have the browser open and load normally.
- - __clearcache__: set to `yes` to have the browser's cookie cache cleared before the new window is opened
- - __clearsessioncache__: set to `yes` to have the session cookie cache cleared before the new window is opened
-
- iOS only:
-
- - __closebuttoncaption__: set to a string to use as the __Done__ button's caption. Note that you need to localize this value yourself.
- - __disallowoverscroll__: Set to `yes` or `no` (default is `no`). Turns on/off the UIWebViewBounce property.
- - __hidden__: set to `yes` to create the browser and load the page, but not show it. The load event fires when loading is complete. Omit or set to `no` (default) to have the browser open and load normally.
- - __toolbar__: set to `yes` or `no` to turn the toolbar on or off for the InAppBrowser (defaults to `yes`)
- - __enableViewportScale__: Set to `yes` or `no` to prevent viewport scaling through a meta tag (defaults to `no`).
- - __mediaPlaybackRequiresUserAction__: Set to `yes` or `no` to prevent HTML5 audio or video from autoplaying (defaults to `no`).
- - __allowInlineMediaPlayback__: Set to `yes` or `no` to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML's `video` element must also include the `webkit-playsinline` attribute (defaults to `no`)
- - __keyboardDisplayRequiresUserAction__: Set to `yes` or `no` to open the keyboard when form elements receive focus via JavaScript's `focus()` call (defaults to `yes`).
- - __suppressesIncrementalRendering__: Set to `yes` or `no` to wait until all new view content is received before being rendered (defaults to `no`).
- - __presentationstyle__: Set to `pagesheet`, `formsheet` or `fullscreen` to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to `fullscreen`).
- - __transitionstyle__: Set to `fliphorizontal`, `crossdissolve` or `coververtical` to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to `coververtical`).
- - __toolbarposition__: Set to `top` or `bottom` (default is `bottom`). Causes the toolbar to be at the top or bottom of the window.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-
-## Quick Example
-
- var ref = window.open('http://apache.org', '_blank', 'location=yes');
- var ref2 = window.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>window.open Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- function onDeviceReady() {
- // external url
- var ref = window.open(encodeURI('http://apache.org'), '_blank', 'location=yes');
- // relative document
- ref = window.open('next.html', '_self');
- }
-
- </script>
- </head>
- <body>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/MediaError/mediaError.md b/docs/en/edge/cordova/media/MediaError/mediaError.md
deleted file mode 100644
index 28ed43e..0000000
--- a/docs/en/edge/cordova/media/MediaError/mediaError.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-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__: An 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 passed to a `mediaError` callback function
-when an error occurs.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/Parameters/mediaError.md b/docs/en/edge/cordova/media/Parameters/mediaError.md
deleted file mode 100644
index 4113988..0000000
--- a/docs/en/edge/cordova/media/Parameters/mediaError.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-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 executes 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/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureCB.md b/docs/en/edge/cordova/media/capture/CaptureCB.md
deleted file mode 100644
index c7b7bf5..0000000
--- a/docs/en/edge/cordova/media/capture/CaptureCB.md
+++ /dev/null
@@ -1,44 +0,0 @@
----
-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 executes after a successful capture operation completes.
-At this point 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/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureError.md b/docs/en/edge/cordova/media/capture/CaptureError.md
deleted file mode 100644
index 0dbb700..0000000
--- a/docs/en/edge/cordova/media/capture/CaptureError.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-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`: The camera or microphone failed to capture image or sound.
-
-- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
-
-- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g., the value of `limit` is less than one).
-
-- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera 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/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md b/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
deleted file mode 100644
index 9c2a665..0000000
--- a/docs/en/edge/cordova/media/capture/CaptureErrorCB.md
+++ /dev/null
@@ -1,41 +0,0 @@
----
-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 executes if an error occurs when trying to launch a
-media capture operation. Failure scenarios include when the capture
-application is busy, a capture operation is already taking place, or
-the user cancels the operation before any media files are captured.
-
-This function executes 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');
- };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/ConfigurationData.md b/docs/en/edge/cordova/media/capture/ConfigurationData.md
deleted file mode 100644
index 0cd13b8..0000000
--- a/docs/en/edge/cordova/media/capture/ConfigurationData.md
+++ /dev/null
@@ -1,61 +0,0 @@
----
-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.
----
-
-# ConfigurationData
-
-> Encapsulates a set of media capture parameters that a device supports.
-
-## Description
-
-Describes media capture modes supported by the device. The
-configuration data includes the MIME type, and capture dimensions for
-video or image capture.
-
-The MIME types should adhere to [RFC2046](http://www.ietf.org/rfc/rfc2046.txt). Examples:
-
-- `video/3gpp`
-- `video/quicktime`
-- `image/jpeg`
-- `audio/amr`
-- `audio/wav`
-
-## Properties
-
-- __type__: The ASCII-encoded lowercase string representing the media type. (DOMString)
-
-- __height__: The height of the image or video in pixels. The value is zero for sound clips. (Number)
-
-- __width__: The width of the image or video in pixels. The value is zero for sound clips. (Number)
-
-## Quick Example
-
- // retrieve supported image modes
- var imageModes = navigator.device.capture.supportedImageModes;
-
- // Select mode that has the highest horizontal resolution
- var width = 0;
- var selectedmode;
- for each (var mode in imageModes) {
- if (mode.width > width) {
- width = mode.width;
- selectedmode = mode;
- }
- }
-
-Not supported by any platform. All configuration data arrays are empty.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md b/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
deleted file mode 100644
index 4f3d444..0000000
--- a/docs/en/edge/cordova/media/capture/MediaFile.getFormatData.md
+++ /dev/null
@@ -1,64 +0,0 @@
----
-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.
----
-
-# MediaFile.getFormatData
-
-> Retrieves format information about the media capture file.
-
- mediaFile.getFormatData(
- MediaFileDataSuccessCB successCallback,
- [MediaFileDataErrorCB errorCallback]
- );
-
-## Description
-
-This function asynchronously attempts to retrieve the format
-information for the media file. If successful, it invokes the
-`MediaFileDataSuccessCB` callback with a `MediaFileData` object. If
-the attempt fails, this function invokes the `MediaFileDataErrorCB`
-callback.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## Amazon Fire OS Quirks
-
-The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
-
-## BlackBerry 10 Quirks
-
-Does not provide an API for information about media files, so all
-`MediaFileData` objects return with default values.
-
-## Android Quirks
-
-The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
-
-## iOS Quirks
-
-The API to access media file format information is limited, so not all
-`MediaFileData` properties are supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/MediaFile.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFile.md b/docs/en/edge/cordova/media/capture/MediaFile.md
deleted file mode 100644
index f0ac93a..0000000
--- a/docs/en/edge/cordova/media/capture/MediaFile.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-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.
----
-
-# MediaFile
-
-> Encapsulates properties of a media capture file.
-
-## Properties
-
-- __name__: The name of the file, without path information. (DOMString)
-
-- __fullPath__: The full path of the file, including the name. (DOMString)
-
-- __type__: The file's mime type (DOMString)
-
-- __lastModifiedDate__: The date and time when the file was last modified. (Date)
-
-- __size__: The size of the file, in bytes. (Number)
-
-## Methods
-
-- __MediaFile.getFormatData__: Retrieves the format information of the media file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/MediaFileData.md b/docs/en/edge/cordova/media/capture/MediaFileData.md
deleted file mode 100644
index 54addfb..0000000
--- a/docs/en/edge/cordova/media/capture/MediaFileData.md
+++ /dev/null
@@ -1,92 +0,0 @@
----
-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.
----
-
-# MediaFileData
-
-> Encapsulates format information about a media file.
-
-## Properties
-
-- __codecs__: The actual format of the audio and video content. (DOMString)
-
-- __bitrate__: The average bitrate of the content. The value is zero for images. (Number)
-
-- __height__: The height of the image or video in pixels. The value is zero for audio clips. (Number)
-
-- __width__: The width of the image or video in pixels. The value is zero for audio clips. (Number)
-
-- __duration__: The length of the video or sound clip in seconds. The value is zero for images. (Number)
-
-## BlackBerry 10 Quirks
-
-No API provides format information for media files, so the
-`MediaFileData` object returned by `MediaFile.getFormatData` features
-the following default values:
-
-- __codecs__: Not supported, and returns `null`.
-
-- __bitrate__: Not supported, and returns zero.
-
-- __height__: Not supported, and returns zero.
-
-- __width__: Not supported, and returns zero.
-
-- __duration__: Not supported, and returns zero.
-
-## Amazon Fire OS Quirks
-
-Supports the following `MediaFileData` properties:
-
-- __codecs__: Not supported, and returns `null`.
-
-- __bitrate__: Not supported, and returns zero.
-
-- __height__: Supported: image and video files only.
-
-- __width__: Supported: image and video files only.
-
-- __duration__: Supported: audio and video files only
-
-## Android Quirks
-
-Supports the following `MediaFileData` properties:
-
-- __codecs__: Not supported, and returns `null`.
-
-- __bitrate__: Not supported, and returns zero.
-
-- __height__: Supported: image and video files only.
-
-- __width__: Supported: image and video files only.
-
-- __duration__: Supported: audio and video files only.
-
-## iOS Quirks
-
-Supports the following `MediaFileData` properties:
-
-- __codecs__: Not supported, and returns `null`.
-
-- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
-
-- __height__: Supported: image and video files only.
-
-- __width__: Supported: image and video files only.
-
-- __duration__: Supported: audio and video files only.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
deleted file mode 100644
index a76209d..0000000
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ /dev/null
@@ -1,164 +0,0 @@
----
-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.
----
-
-# Capture
-
-> Provides access to the device's audio, image, and video capture capabilities.
-
-__WARNING__: Collection and use of images, video, or
-audio from the device's camera or microphone raises important privacy
-issues. Your app's privacy policy should discuss how the app uses
-such sensors and whether the data recorded is shared with any other
-parties. In addition, if the app's use of the camera or microphone is
-not apparent in the user interface, you should provide a just-in-time
-notice before the app accesses the camera or microphone (if the
-device operating system doesn't do so already). That notice should
-provide the same information noted above, as well as obtaining the
-user's permission (e.g., by presenting choices for __OK__ and __No
-Thanks__). Note that some app marketplaces may require your app to
-provide just-in-time notice and obtain permission from the user prior
-to accessing the camera or microphone. For more information, please
-see the Privacy Guide.
-
-## Objects
-
-- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCallback
-- CaptureErrorCB
-- ConfigurationData
-- MediaFile
-- MediaFileData
-
-## Methods
-
-- capture.captureAudio
-- capture.captureImage
-- capture.captureVideo
-- MediaFile.getFormatData
-
-## Scope
-
-The `capture` object is assigned to the `navigator.device` object, and
-therefore has global scope.
-
- // The global capture object
- var capture = navigator.device.capture;
-
-## Properties
-
-- __supportedAudioModes__: The audio recording formats supported by the device. (ConfigurationData[])
-
-- __supportedImageModes__: The recording image sizes and formats supported by the device. (ConfigurationData[])
-
-- __supportedVideoModes__: The recording video resolutions and formats supported by the device. (ConfigurationData[])
-
-## Methods
-
-- `capture.captureAudio`: Launch the device's audio recording application to record audio clips.
-
-- `capture.captureImage`: Launch the device's camera application to take photos.
-
-- `capture.captureVideo`: Launch the device's video recorder application to record videos.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## Accessing the Feature
-
-As of version 3.0, Cordova implements device-level APIs as _plugins_.
-Use the CLI's `plugin` command, described in The Command-Line
-Interface, to add or remove this feature for a project:
-
- $ cordova plugin add org.apache.cordova.media-capture
- $ cordova plugin ls
- [ 'org.apache.cordova.file',
- 'org.apache.cordova.media-capture']
- $ cordova plugin rm org.apache.cordova.media-capture
-
-These commands apply to all targeted platforms, but modify the
-platform-specific configuration settings described below:
-
-* Amazon Fire OS
-
- (in app/res/xml/config.xml)
- <feature name="File">
- <param name="android-package" value="org.apache.cordova.file.FileUtils" />
- </feature>
- <feature name="Capture">
- <param name="android-package" value="org.apache.cordova.mediacapture.Capture" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.RECORD_VIDEO" />
-
-* Android
-
- (in app/res/xml/config.xml)
- <feature name="File">
- <param name="android-package" value="org.apache.cordova.file.FileUtils" />
- </feature>
- <feature name="Capture">
- <param name="android-package" value="org.apache.cordova.mediacapture.Capture" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
- <uses-permission android:name="android.permission.RECORD_AUDIO" />
- <uses-permission android:name="android.permission.RECORD_VIDEO" />
-
-* BlackBerry 10
-
- (in www/plugins.xml)
- <feature name="Capture">
- <param name="blackberry-package" value="org.apache.cordova.capture.MediaCapture" />
- </feature>
-
- (in www/config.xml)
- <feature id="blackberry.system" required="true" version="1.0.0.0" />
- <feature id="blackberry.io.file" required="true" version="1.0.0.0" />
-
-* iOS (in the named application directory's `config.xml`)
-
- <feature name="Capture">
- <param name="ios-package" value="CDVCapture" />
- </feature>
-
-* Windows Phone (in `Properties/WPAppManifest.xml`)
-
- <Capabilities>
- <Capability Name="ID_CAP_MEDIALIB" />
- <Capability Name="ID_CAP_MICROPHONE" />
- <Capability Name="ID_HW_FRONTCAMERA" />
- <Capability Name="ID_CAP_ISV_CAMERA" />
- <Capability Name="ID_CAP_CAMERA" />
- </Capabilities>
-
-Some platforms may support this feature without requiring any special
-configuration. See Platform Support for an overview.