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 E8BF1E562 for ; Tue, 19 Feb 2013 22:27:21 +0000 (UTC) Received: (qmail 62047 invoked by uid 500); 19 Feb 2013 22:27:19 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 61992 invoked by uid 500); 19 Feb 2013 22:27:19 -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 60730 invoked by uid 99); 19 Feb 2013 22:27:18 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Feb 2013 22:27:17 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id B33BF82CC57; Tue, 19 Feb 2013 22:27:17 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: mwbrooks@apache.org To: commits@cordova.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [17/52] [partial] [#2454] Remove versions pre-dating Apache Cordova. Message-Id: <20130219222717.B33BF82CC57@tyr.zones.apache.org> Date: Tue, 19 Feb 2013 22:27:17 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/notification/notification.confirm.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/notification/notification.confirm.md b/docs/en/1.0.0rc1/phonegap/notification/notification.confirm.md deleted file mode 100755 index 3ec2aaf..0000000 --- a/docs/en/1.0.0rc1/phonegap/notification/notification.confirm.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. ---- - -notification.confirm -==================== - -Shows a customizable confirmation dialog box. - - navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels]) - -- __message:__ Dialog message (`String`) -- __confirmCallback:__ - Callback to invoke with index of button pressed (1, 2 or 3). (`Number`) -- __title:__ Dialog title (`String`) (Optional, Default: "Confirm") -- __buttonLabels:__ Comma separated string with button labels (`String`) (Optional, Default: "OK,Cancel") - -Description ------------ - -Function `notification.confirm` displays a native dialog box that is more customizable than the browser's `confirm` function. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // process the confirmation dialog result - function onConfirm(button) { - alert('You selected button ' + button); - } - - // Show a custom confirmation dialog - // - function showConfirm() { - navigator.notification.confirm( - 'You are the winner!', // message - onConfirm, // callback to invoke with index of button pressed - 'Game Over', // title - 'Restart,Exit' // buttonLabels - ); - } - -Full Example ------------- - - - - - Notification Example - - - - - -

Show Confirm

- - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/notification/notification.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/notification/notification.md b/docs/en/1.0.0rc1/phonegap/notification/notification.md deleted file mode 100644 index 865809f..0000000 --- a/docs/en/1.0.0rc1/phonegap/notification/notification.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. ---- - -Notification -============ - -> Visual, audible, and tactile device notifications. - -Methods -------- - -- notification.alert -- notification.confirm -- notification.beep -- notification.vibrate \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/notification/notification.vibrate.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/notification/notification.vibrate.md b/docs/en/1.0.0rc1/phonegap/notification/notification.vibrate.md deleted file mode 100644 index 6cb124c..0000000 --- a/docs/en/1.0.0rc1/phonegap/notification/notification.vibrate.md +++ /dev/null @@ -1,102 +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. ---- - -notification.vibrate -==================== - -Vibrates the device for the specified amount of time. - - navigator.notification.vibrate(milliseconds) - -- __time:__ Milliseconds to vibrate the device. 1000 milliseconds equals 1 second (`Number`) - -Supported Platforms -------------------- - -- Android -- BlackBerry (OS 4.6) -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - // Vibrate for 2.5 seconds - // - navigator.notification.vibrate(2500); - -Full Example ------------- - - - - - Notification Example - - - - - -

Show Alert

-

Play Beep

-

Vibrate

- - - -iPhone Quirks -------------- - -- __time:__ Ignores the time and vibrates for a pre-set amount of time. - - navigator.notification.vibrate(); - navigator.notification.vibrate(2500); // 2500 is ignored \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/database/database.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/database/database.md b/docs/en/1.0.0rc1/phonegap/storage/database/database.md deleted file mode 100644 index d1d13a4..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/database/database.md +++ /dev/null @@ -1,123 +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. ---- - -Database -======= - -Contains methods that allow the user to manipulate the Database - -Methods -------- - -- __transaction__: Runs a database transaction. -- __changeVersion__: method allows scripts to atomically verify the version number and change it at the same time as doing a schema update. - -Details -------- - -A Database object is returned from a call to `window.openDatabase()`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Transaction Quick Example ------------------- - function populateDB(tx) { - tx.executeSql('DROP TABLE IF EXISTS DEMO'); - tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)'); - tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")'); - tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")'); - } - - function errorCB(err) { - alert("Error processing SQL: "+err.code); - } - - function successCB() { - alert("success!"); - } - - var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000); - db.transaction(populateDB, errorCB, successCB); - -Change Version Quick Example -------------------- - - var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000); - db.changeVersion("1.0", "1.1"); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Database

- - - -Android 1.X Quirks ------------------- - -- __changeVersion:__ This method is not support by Android 1.X devices. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/localstorage/localstorage.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/localstorage/localstorage.md b/docs/en/1.0.0rc1/phonegap/storage/localstorage/localstorage.md deleted file mode 100644 index 7643bcc..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/localstorage/localstorage.md +++ /dev/null @@ -1,110 +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. ---- - -localStorage -=============== - -Provides access to a W3C Storage interface (http://dev.w3.org/html5/webstorage/#the-localstorage-attribute) - - var storage = window.localStorage; - -Methods -------- - -- __key__: Returns the name of the key at the position specified. -- __getItem__: Returns the item identified by it's key. -- __setItem__: Saves and item at the key provided. -- __removeItem__: Removes the item identified by it's key. -- __clear__: Removes all of the key value pairs. - -Details ------------ - -localStorage provides an interface to a W3C Storage interface. It allows one to save data as key-value pairs. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Key Quick Example -------------- - - var keyName = window.localStorage.key(0); - -Set Item Quick Example -------------- - - window.localStorage.setItem("key", "value"); - -Get Item Quick Example -------------- - - var value = window.localStorage.getItem("key"); - // value is now equal to "value" - -Remove Item Quick Example -------------- - - window.localStorage.removeItem("key"); - -Clear Quick Example -------------- - - window.localStorage.clear(); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

localStorage

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/parameters/display_name.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/parameters/display_name.md b/docs/en/1.0.0rc1/phonegap/storage/parameters/display_name.md deleted file mode 100644 index f12b2a5..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/parameters/display_name.md +++ /dev/null @@ -1,23 +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. ---- - -display_name -================== - -The display name of the database. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/parameters/name.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/parameters/name.md b/docs/en/1.0.0rc1/phonegap/storage/parameters/name.md deleted file mode 100644 index 93537f8..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/parameters/name.md +++ /dev/null @@ -1,23 +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. ---- - -name -============ - -The name of the database. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/parameters/size.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/parameters/size.md b/docs/en/1.0.0rc1/phonegap/storage/parameters/size.md deleted file mode 100644 index 523ef1b..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/parameters/size.md +++ /dev/null @@ -1,23 +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. ---- - -size -============== - -The size of the database in bytes. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/parameters/version.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/parameters/version.md b/docs/en/1.0.0rc1/phonegap/storage/parameters/version.md deleted file mode 100644 index 215f950..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/parameters/version.md +++ /dev/null @@ -1,23 +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. ---- - -version -============= - -The version of the database. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/sqlerror/sqlerror.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/sqlerror/sqlerror.md b/docs/en/1.0.0rc1/phonegap/storage/sqlerror/sqlerror.md deleted file mode 100644 index b700222..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/sqlerror/sqlerror.md +++ /dev/null @@ -1,47 +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. ---- - -SQLError -======== - -A `SQLError` object is thrown when an error occurs. - -Properties ----------- - -- __code:__ One of the predefined error codes listed below. -- __message:__ A description of the error. - -Constants ---------- - -- `SQLError.UNKNOWN_ERR` -- `SQLError.DATABASE_ERR` -- `SQLError.VERSION_ERR` -- `SQLError.TOO_LARGE_ERR` -- `SQLError.QUOTA_ERR` -- `SQLError.SYNTAX_ERR` -- `SQLError.CONSTRAINT_ERR` -- `SQLError.TIMEOUT_ERR` - -Description ------------ - -The `SQLError` object is thrown when an error occurs when manipulating a database. - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/sqlresultset/sqlresultset.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/sqlresultset/sqlresultset.md b/docs/en/1.0.0rc1/phonegap/storage/sqlresultset/sqlresultset.md deleted file mode 100644 index 829cdab..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/sqlresultset/sqlresultset.md +++ /dev/null @@ -1,134 +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. ---- - -SQLResultSet -======= - -When the executeSql method of a SQLTransaction is called it will invoke it's callback with a SQLResultSet. - -Properties -------- - -- __insertId__: the row ID of the row that the SQLResultSet object's SQL statement inserted into the database -- __rowAffected__: the number of rows that were changed by the SQL statement. If the statement did not affect any rows then it is set to 0. -- __rows__: a SQLResultSetRowList representing the rows returned. If no rows are returned the object will be empty. - -Details -------- - -When you call the SQLTransaction executeSql method it's callback methods will be called with a SQLResultSet object. The result object has three properties. The first is the `insertId` which will return the row number of a success SQL insert statement. If the SQL statement is not an insert then the `insertId` is not set. The `rowAffected` is always 0 for a SQL select statement. For insert or update statements it returns the number of rows that have been modified. The final property is of type SQLResultSetList and it contains the data returned from a SQL select statement. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Execute SQL Quick Example ------------------- - - function queryDB(tx) { - tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB); - } - - function querySuccess(tx, results) { - // this will be empty since no rows were inserted. - console.log("Insert ID = " + results.insertId); - // this will be 0 since it is a select statement - console.log("Rows Affected = " + results.rowAffected); - // the number of rows returned by the select statement - console.log("Insert ID = " + results.rows.length); - } - - function errorCB(err) { - alert("Error processing SQL: "+err.code); - } - - var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000); - db.transaction(queryDB, errorCB); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Database

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md b/docs/en/1.0.0rc1/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md deleted file mode 100644 index f2e0049..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/sqlresultsetlist/sqlresultsetlist.md +++ /dev/null @@ -1,135 +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. ---- - -SQLResultSetList -======= - -One of the properties of the SQLResultSet containing the rows returned from a SQL query. - -Properties -------- - -- __length__: the number of rows returned by the SQL query - -Methods -------- - -- __item__: returns the row at the specified index represented by a JavaScript object. - -Details -------- - -The SQLResultSetList contains the data returned from a SQL select statement. The object contains a length property letting you know how many rows the select statement has been returned. To get a row of data you would call the `item` method specifying an index. The item method returns a JavaScript Object who's properties are the columns of the database the select statement was executed against. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Execute SQL Quick Example ------------------- - - function queryDB(tx) { - tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB); - } - - function querySuccess(tx, results) { - var len = results.rows.length; - ��� console.log("DEMO table: " + len + " rows found."); - ��� for (var i=0; i - - - Contact Example - - - - - -

Example

-

Database

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/sqltransaction/sqltransaction.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/sqltransaction/sqltransaction.md b/docs/en/1.0.0rc1/phonegap/storage/sqltransaction/sqltransaction.md deleted file mode 100644 index 2eb3690..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/sqltransaction/sqltransaction.md +++ /dev/null @@ -1,112 +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. ---- - -SQLTransaction -======= - -Contains methods that allow the user to execute SQL statements against the Database. - -Methods -------- - -- __executeSql__: executes a SQL statement - -Details -------- - -When you call a Database objects transaction method it's callback methods will be called with a SQLTransaction object. The user can build up a database transaction by calling the executeSql method multiple times. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Execute SQL Quick Example ------------------- - - function populateDB(tx) { - tx.executeSql('DROP TABLE IF EXISTS DEMO'); - tx.executeSql('CREATE TABLE IF NOT EXISTS DEMO (id unique, data)'); - tx.executeSql('INSERT INTO DEMO (id, data) VALUES (1, "First row")'); - tx.executeSql('INSERT INTO DEMO (id, data) VALUES (2, "Second row")'); - } - - function errorCB(err) { - alert("Error processing SQL: "+err); - } - - function successCB() { - alert("success!"); - } - - var db = window.openDatabase("Database", "1.0", "PhoneGap Demo", 200000); - db.transaction(populateDB, errorCB, successCB); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

SQLTransaction

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/storage.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/storage.md b/docs/en/1.0.0rc1/phonegap/storage/storage.md deleted file mode 100644 index 309dd5e..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/storage.md +++ /dev/null @@ -1,48 +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. ---- - -Storage -========== - -> Provides access to the devices storage options. - -This API is based on the [W3C Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web Storage API Specification](http://dev.w3.org/html5/webstorage/). Some devices already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with PhoneGap's implementation. For devices that don't have storage support, PhoneGap's implementation should be compatible with the W3C specification. - -Methods -------- - -- openDatabase - -Arguments ---------- - -- name -- version -- display_name -- size - -Objects -------- - -- Database -- SQLTransaction -- SQLResultSet -- SQLResultSetList -- SQLError -- localStorage \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc1/phonegap/storage/storage.opendatabase.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc1/phonegap/storage/storage.opendatabase.md b/docs/en/1.0.0rc1/phonegap/storage/storage.opendatabase.md deleted file mode 100644 index 2a9f7b7..0000000 --- a/docs/en/1.0.0rc1/phonegap/storage/storage.opendatabase.md +++ /dev/null @@ -1,73 +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. ---- - -openDatabase -=============== - -Returns a new Database object. - - var dbShell = window.openDatabase(name, version, display_name, size); - -Description ------------ - -window.openDatabase returns a new Database object. - -This method will create a new SQL Lite Database and return a Database object. Use the Database Object to manipulate the data. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iPhone - -Quick Example -------------- - - var db = window.openDatabase("test", "1.0", "Test DB", 1000000); - -Full Example ------------- - - - - - Contact Example - - - - - -

Example

-

Open Database

- - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/config.json ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/config.json b/docs/en/1.0.0rc2/config.json deleted file mode 100644 index 729aa5c..0000000 --- a/docs/en/1.0.0rc2/config.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "language": "English", - "merge": { - "accelerometer.md": [ - "phonegap/accelerometer/accelerometer.md", - "phonegap/accelerometer/accelerometer.getCurrentAcceleration.md", - "phonegap/accelerometer/accelerometer.watchAcceleration.md", - "phonegap/accelerometer/accelerometer.clearWatch.md", - "phonegap/accelerometer/acceleration/acceleration.md", - "phonegap/accelerometer/parameters/accelerometerSuccess.md", - "phonegap/accelerometer/parameters/accelerometerError.md", - "phonegap/accelerometer/parameters/accelerometerOptions.md" - ], - "camera.md": [ - "phonegap/camera/camera.md", - "phonegap/camera/camera.getPicture.md", - "phonegap/camera/parameter/cameraSuccess.md", - "phonegap/camera/parameter/cameraError.md", - "phonegap/camera/parameter/cameraOptions.md" - ], - "capture.md": [ - "phonegap/media/capture/capture.md", - "phonegap/media/capture/captureAudio.md", - "phonegap/media/capture/captureAudioOptions.md", - "phonegap/media/capture/captureImage.md", - "phonegap/media/capture/captureImageOptions.md", - "phonegap/media/capture/captureVideo.md", - "phonegap/media/capture/captureVideoOptions.md", - "phonegap/media/capture/CaptureError.md", - "phonegap/media/capture/CaptureCB.md", - "phonegap/media/capture/CaptureErrorCB.md", - "phonegap/media/capture/ConfigurationData.md", - "phonegap/media/capture/MediaFile.md", - "phonegap/media/capture/MediaFile.getFormatData.md", - "phonegap/media/capture/MediaFileData.md" - ], - "compass.md": [ - "phonegap/compass/compass.md", - "phonegap/compass/compass.getCurrentHeading.md", - "phonegap/compass/compass.watchHeading.md", - "phonegap/compass/compass.clearWatch.md", - "phonegap/compass/parameters/compassSuccess.md", - "phonegap/compass/parameters/compassError.md", - "phonegap/compass/parameters/compassOptions.md" - ], - "contacts.md": [ - "phonegap/contacts/contacts.md", - "phonegap/contacts/contacts.create.md", - "phonegap/contacts/contacts.find.md", - "phonegap/contacts/Contact/contact.md", - "phonegap/contacts/ContactAddress/contactaddress.md", - "phonegap/contacts/ContactField/contactfield.md", - "phonegap/contacts/ContactFindOptions/contactfindoptions.md", - "phonegap/contacts/ContactName/contactname.md", - "phonegap/contacts/ContactOrganization/contactorganization.md", - "phonegap/contacts/ContactError/contactError.md", - "phonegap/contacts/parameters/contactSuccess.md", - "phonegap/contacts/parameters/contactError.md", - "phonegap/contacts/parameters/contactFields.md", - "phonegap/contacts/parameters/contactFindOptions.md" - ], - "device.md": [ - "phonegap/device/device.md", - "phonegap/device/device.name.md", - "phonegap/device/device.phonegap.md", - "phonegap/device/device.platform.md", - "phonegap/device/device.uuid.md", - "phonegap/device/device.version.md" - ], - "events.md": [ - "phonegap/events/events.md", - "phonegap/events/events.deviceready.md", - "phonegap/events/events.pause.md", - "phonegap/events/events.resume.md", - "phonegap/events/events.online.md", - "phonegap/events/events.offline.md", - "phonegap/events/events.backbutton.md", - "phonegap/events/events.menubutton.md", - "phonegap/events/events.searchbutton.md" - ], - "file.md": [ - "phonegap/file/file.md", - "phonegap/file/fileobj/fileobj.md", - "phonegap/file/filereader/filereader.md", - "phonegap/file/filewriter/filewriter.md", - "phonegap/file/filesystem/filesystem.md", - "phonegap/file/fileentry/fileentry.md", - "phonegap/file/directoryentry/directoryentry.md", - "phonegap/file/directoryreader/directoryreader.md", - "phonegap/file/filetransfer/filetransfer.md", - "phonegap/file/fileuploadoptions/fileuploadoptions.md", - "phonegap/file/fileuploadresult/fileuploadresult.md", - "phonegap/file/flags/flags.md", - "phonegap/file/localfilesystem/localfilesystem.md", - "phonegap/file/metadata/metadata.md", - "phonegap/file/fileerror/fileerror.md", - "phonegap/file/filetransfererror/filetransfererror.md" - ], - "geolocation.md": [ - "phonegap/geolocation/geolocation.md", - "phonegap/geolocation/geolocation.getCurrentPosition.md", - "phonegap/geolocation/geolocation.watchPosition.md", - "phonegap/geolocation/geolocation.clearWatch.md", - "phonegap/geolocation/Coordinates/coordinates.md", - "phonegap/geolocation/Position/position.md", - "phonegap/geolocation/PositionError/positionError.md", - "phonegap/geolocation/parameters/geolocationSuccess.md", - "phonegap/geolocation/parameters/geolocationError.md", - "phonegap/geolocation/parameters/geolocation.options.md" - ], - "media.md": [ - "phonegap/media/media.md", - "phonegap/media/media.getCurrentPosition.md", - "phonegap/media/media.getDuration.md", - "phonegap/media/media.pause.md", - "phonegap/media/media.play.md", - "phonegap/media/media.release.md", - "phonegap/media/media.startRecord.md", - "phonegap/media/media.stop.md", - "phonegap/media/media.stopRecord.md", - "phonegap/media/MediaError/mediaError.md", - "phonegap/media/Parameters/mediaError.md" - ], - "network.md": [ - "phonegap/network/network.md", - "phonegap/network/network.isReachable.md", - "phonegap/network/NetworkStatus/NetworkStatus.md", - "phonegap/network/parameters/reachableCallback.md", - "phonegap/network/parameters/reachableHostname.md", - "phonegap/network/parameters/reachableOptions.md" - ], - "connection.md": [ - "phonegap/connection/connection.md", - "phonegap/connection/connection.type.md" - ], - "notification.md": [ - "phonegap/notification/notification.md", - "phonegap/notification/notification.alert.md", - "phonegap/notification/notification.confirm.md", - "phonegap/notification/notification.beep.md", - "phonegap/notification/notification.vibrate.md" - ], - "storage.md": [ - "phonegap/storage/storage.md", - "phonegap/storage/storage.opendatabase.md", - "phonegap/storage/parameters/name.md", - "phonegap/storage/parameters/version.md", - "phonegap/storage/parameters/display_name.md", - "phonegap/storage/parameters/size.md", - "phonegap/storage/database/database.md", - "phonegap/storage/sqltransaction/sqltransaction.md", - "phonegap/storage/sqlresultset/sqlresultset.md", - "phonegap/storage/sqlresultsetlist/sqlresultsetlist.md", - "phonegap/storage/sqlerror/sqlerror.md", - "phonegap/storage/localstorage/localstorage.md" - ] - } -} http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/guide/upgrading/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/guide/upgrading/blackberry/index.md b/docs/en/1.0.0rc2/guide/upgrading/blackberry/index.md deleted file mode 100644 index 958c189..0000000 --- a/docs/en/1.0.0rc2/guide/upgrading/blackberry/index.md +++ /dev/null @@ -1,71 +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. ---- - -Upgrading Phonegap BlackBerry -============================ - -This document is for people who need to upgrade their Phonegap versions from an older version to a current version of Phonegap. - -- To upgrade to 1.0.0rc2, please go from 0.9.6 - -## Upgrade to 1.0.0rc2 from 0.9.6 ## - -Updating just the www folder: - -1. Open your `www/` folder, which contains your app. -2. Remove and update the old phonegap.0.9.6.jar file in the `ext/` folder and replace it with Phonegap.1.0.0rc2.jar. -3. Copy the new `Phonegap.1.0.0rc2.js` into your project. -4. Update your HTML to use the new `Phonegap.1.0.0rc2.js` file. -5. Add the file plugins.xml to your www folder and edit it so it looks like this: - - - - - - - - - - - - - - -Updating the sample folder (ie, updating using the ant tools): - -1. Open the `sample/lib/` folder. -2. Update the .jar file in the `phonegap.0.9.6/ext/` folder. -3. Update the .js file in the `phonegap.0.9.6/javascript/` folder. -4. Open the `sample/lib/` folder and rename the `Phonegap.0.9.6/` folder to `Phonegap.1.0.0rc2/`. -5. Type `ant blackberry build` to update the `www/` folder with updated Phonegap. -6. Open the `www/` folder and update your HTML to use the new `Phonegap.1.0.0rc2.js` file. -7. Add the file plugins.xml to your www folder and edit it so it looks like this: - - - - - - - - - - - - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/guide/upgrading/webos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/guide/upgrading/webos/index.md b/docs/en/1.0.0rc2/guide/upgrading/webos/index.md deleted file mode 100644 index 73067e1..0000000 --- a/docs/en/1.0.0rc2/guide/upgrading/webos/index.md +++ /dev/null @@ -1,37 +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. ---- - -Upgrading PhoneGap webOS -======================= - -This document is for people who need to upgrade their Cordova versions from an older version to a current version of Cordova. - -## Upgrade to 1.0.0 from 0.9.6 ## - -1. remove phonegap-0.9.6.js from your project - -2. update the following line in your index.html: - - change this: - - - to: - - -3. run the makefile to generate the newest version of the phonegap-1.0.0.js file \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/index.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/index.md b/docs/en/1.0.0rc2/index.md deleted file mode 100644 index c201744..0000000 --- a/docs/en/1.0.0rc2/index.md +++ /dev/null @@ -1,83 +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. ---- - -
-

API Reference

-
    -
  • -

    Accelerometer

    - Tap into the device's motion sensor. -
    • -
  • -

    Camera

    - Capture a photo using the device's camera. -
    • -
  • -

    Capture

    - Capture media files using device's media capture applications. -
    • -
  • -

    Compass

    - Obtain the direction that the device is pointing. -
    • -
  • -

    Connection

    - Quickly check the network state, and cellular network information. -
    • -
  • -

    Contacts

    - Work with the devices contact database. -
    • -
  • -

    Device

    - Gather device specific information. -
    • -
  • -

    Events

    - Hook into native events through JavaScript. -
    • -
  • -

    File

    - Hook into native file system through JavaScript. -
    • -
  • -

    Geolocation

    - Make your application location aware. -
    • -
  • -

    Media

    - Record and play back audio files. -
    • -
  • -

    Notification

    - Visual, audible, and tactile device notifications. -
    • -
  • -

    Storage

    - Hook into the devices native storage options. -
    • -
-

Guides

-
    -
  • -

    Keyword Index

    - Full index of the PhoneGap Documentation. -
    • -
-
\ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/acceleration/acceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/acceleration/acceleration.md b/docs/en/1.0.0rc2/phonegap/accelerometer/acceleration/acceleration.md deleted file mode 100644 index a6de44d..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/acceleration/acceleration.md +++ /dev/null @@ -1,103 +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. ---- - -Acceleration -============ - -Contains `Accelerometer` data captured at a specific point in time. - -Properties ----------- - -- __x:__ Amount of motion on the x-axis. Range [0, 1] (`Number`) -- __y:__ Amount of motion on the y-axis. Range [0, 1] (`Number`) -- __z:__ Amount of motion on the z-axis. Range [0, 1] (`Number`) -- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`) - -Description ------------ - -This object is created and populated by PhoneGap, and returned by an `Accelerometer` method. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); - -Full Example ------------- - - - - - Acceleration Example - - - - - -

Example

-

getCurrentAcceleration

- - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.clearWatch.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.clearWatch.md b/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.clearWatch.md deleted file mode 100644 index 771b110..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.clearWatch.md +++ /dev/null @@ -1,110 +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. ---- - -accelerometer.clearWatch -======================== - -Stop watching the `Acceleration` referenced by the watch ID parameter. - - navigator.accelerometer.clearWatch(watchID); - -- __watchID__: The ID returned by `accelerometer.watchAcceleration`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); - - // ... later on ... - - navigator.accelerometer.clearWatch(watchID); - -Full Example ------------- - - - - - Acceleration Example - - - - - -
Waiting for accelerometer...
- - - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md deleted file mode 100644 index dd21961..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md +++ /dev/null @@ -1,106 +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. ---- - -accelerometer.getCurrentAcceleration -==================================== - -Get the current acceleration along the x, y, and z axis. - - navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError); - -Description ------------ - -The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis. - -The acceleration is returned using the `accelerometerSuccess` callback function. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); - -Full Example ------------- - - - - - Acceleration Example - - - - - -

Example

-

getCurrentAcceleration

- - - -iPhone Quirks -------------- - -- iPhone doesn't have the concept of getting the current acceleration at any given point. -- You must watch the acceleration and capture the data at given time intervals. -- Thus, the `getCurrentAcceleration` function will give you the last value reported from a phoneGap `watchAccelerometer` call. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.md b/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.md deleted file mode 100644 index b84eeb9..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.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. ---- - -Accelerometer -============= - -> Captures device motion in the x, y, and z direction. - -Methods -------- - -- accelerometer.getCurrentAcceleration -- accelerometer.watchAcceleration -- accelerometer.clearWatch - -Arguments ---------- - -- accelerometerSuccess -- accelerometerError -- accelerometerOptions - -Objects (Read-Only) -------------------- - -- Acceleration \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.watchAcceleration.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.watchAcceleration.md b/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.watchAcceleration.md deleted file mode 100644 index dee8487..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/accelerometer.watchAcceleration.md +++ /dev/null @@ -1,135 +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. ---- - -accelerometer.watchAcceleration -=============================== - -At a regular interval, get the acceleration along the x, y, and z axis. - - var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess, - accelerometerError, - [accelerometerOptions]); - -Description ------------ - -The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis. - -The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object. - -The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iPhone - - -Quick Example -------------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; - - function onError() { - alert('onError!'); - }; - - var options = { frequency: 3000 }; // Update every 3 seconds - - var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options); - -Full Example ------------- - - - - - Acceleration Example - - - - - -
Waiting for accelerometer...
- - - - iPhone Quirks -------------- - -- At the interval requested, PhoneGap will call the success callback function and pass the accelerometer results. -- However, in requests to the device PhoneGap restricts the interval to minimum of every 40ms and a maximum of every 1000ms. - - For example, if you request an interval of 3 seconds (3000ms), PhoneGap will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerError.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerError.md b/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerError.md deleted file mode 100644 index c908c16..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerError.md +++ /dev/null @@ -1,27 +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. ---- - -accelerometerError -================== - -onError callback function for acceleration functions. - - function() { - // Handle the error - } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerOptions.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerOptions.md b/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerOptions.md deleted file mode 100644 index 197f416..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerOptions.md +++ /dev/null @@ -1,28 +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. ---- - -accelerometerOptions -==================== - -An optional parameter to customize the retrieval of the accelerometer. - -Options -------- - -- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d132c2bd/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerSuccess.md ---------------------------------------------------------------------- diff --git a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerSuccess.md b/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerSuccess.md deleted file mode 100644 index 277fca8..0000000 --- a/docs/en/1.0.0rc2/phonegap/accelerometer/parameters/accelerometerSuccess.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. ---- - -accelerometerSuccess -==================== - -onSuccess callback function that provides the Acceleration information. - - function(acceleration) { - // Do something - } - -Parameters ----------- - -- __acceleration:__ The acceleration at a single moment in time. (Acceleration) - -Example -------- - - function onSuccess(acceleration) { - alert('Acceleration X: ' + acceleration.x + '\n' + - 'Acceleration Y: ' + acceleration.y + '\n' + - 'Acceleration Z: ' + acceleration.z + '\n' + - 'Timestamp: ' + acceleration.timestamp + '\n'); - }; \ No newline at end of file