Return-Path: X-Original-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 74AB0D291 for ; Mon, 16 Jul 2012 15:57:19 +0000 (UTC) Received: (qmail 22179 invoked by uid 500); 16 Jul 2012 15:57:19 -0000 Delivered-To: apmail-incubator-callback-commits-archive@incubator.apache.org Received: (qmail 22112 invoked by uid 500); 16 Jul 2012 15:57:19 -0000 Mailing-List: contact callback-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@incubator.apache.org Delivered-To: mailing list callback-commits@incubator.apache.org Received: (qmail 22051 invoked by uid 99); 16 Jul 2012 15:57:19 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 16 Jul 2012 15:57:19 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 82F7B14868; Mon, 16 Jul 2012 15:57:18 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [6/9] Version 2.0.0rc1 Message-Id: <20120716155718.82F7B14868@tyr.zones.apache.org> Date: Mon, 16 Jul 2012 15:57:18 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.play.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.play.md b/docs/en/2.0.0rc1/cordova/media/media.play.md new file mode 100644 index 0000000..676dc7f --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.play.md @@ -0,0 +1,188 @@ +--- +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. +--- + +media.play +========== + +Starts or resumes playing an audio file. + + media.play(); + + +Description +----------- + +Function `media.play` is a synchronous function that starts or resumes playing an audio file. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Play audio + // + function playAudio(url) { + // Play the audio file at url + var my_media = new Media(url, + // success callback + function() { + console.log("playAudio():Audio Success"); + }, + // error callback + function(err) { + console.log("playAudio():Audio Error: "+err); + }); + + // Play audio + my_media.play(); + } + + +Full Example +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + + +BlackBerry WebWorks Quirks +---------- + +- BlackBerry devices support a limited number of simultaneous audio channels. CDMA devices only support a single audio channel. Other devices support up to two simultaneous channels. Attempting to play more audio files then the supported amount will result in previous playback being stopped. + +iOS Quirk +--------- + +- __numberOfLoops__ + + Pass in this option to the **play** method to specify the number of times you want the media file to play. e.g: + + var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3") + myMedia.play({ numberOfLoops: 2 }) + +- __playAudioWhenScreenIsLocked__ + + Pass in this option to the **play** method to specify whether you want to play the audio of the media file when the screen is locked (this defaults to true if not set). If this is set to true, it will ignore the state of the hardware mute button. e.g: + + var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3") + myMedia.play({ playAudioWhenScreenIsLocked : false }) http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.release.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.release.md b/docs/en/2.0.0rc1/cordova/media/media.release.md new file mode 100644 index 0000000..d9cc47e --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.release.md @@ -0,0 +1,154 @@ +--- +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. +--- + +media.release +================= + +Releases the underlying operating systems audio resources. + + media.release(); + + +Description +----------- + +Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the Media resource. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Audio player + // + var my_media = new Media(src, onSuccess, onError); + + my_media.play(); + my_media.stop(); + my_media.release(); + +Full Example +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.seekTo.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.seekTo.md b/docs/en/2.0.0rc1/cordova/media/media.seekTo.md new file mode 100644 index 0000000..fda12c2 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.seekTo.md @@ -0,0 +1,157 @@ +--- +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. +--- + +media.seekTo +======================== + +Sets the current position within an audio file. + + media.seekTo(milliseconds); + +Parameters +---------- + +- __milliseconds__: The position to set the playback position within the audio in milliseconds. . + + +Description +----------- + +Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 6.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Audio player + // + var my_media = new Media(src, onSuccess, onError); + my_media.play(); + // SeekTo to 10 seconds after 5 seconds + setTimeout(function() { + my_media.seekTo(10000); + }, 5000); + + +Full Example +------------ + + + + + Media Example + + + + + + Play Audio + Stop Playing Audio +

+ + + +BlackBerry WebWorks Quirks +---------- + +- This API is not supported on BlackBerry OS 5 devices. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.startRecord.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.startRecord.md b/docs/en/2.0.0rc1/cordova/media/media.startRecord.md new file mode 100644 index 0000000..2c8e572 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.startRecord.md @@ -0,0 +1,141 @@ +--- +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. +--- + +media.startRecord +================= + +Starts recording an audio file. + + media.startRecord(); + + +Description +----------- + +Function `media.startRecord` is a synchronous function that starts recording an audio file. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Record audio + // + function recordAudio() { + var src = "myrecording.mp3"; + var mediaRec = new Media(src, + // success callback + function() { + console.log("recordAudio():Audio Success"); + }, + + // error callback + function(err) { + console.log("recordAudio():Audio Error: "+ err.code); + }); + + // Record audio + mediaRec.startRecord(); + } + + +Full Example +------------ + + + + + Device Properties Example + + + + + +

Recording audio...

+

+ + + +BlackBerry WebWorks Quirks +---------- + +- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a .amr extension. + +iOS Quirks +---------- + +- The file to record to must already exist and should be of type .wav. The File API's can be used to create the file. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.stop.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.stop.md b/docs/en/2.0.0rc1/cordova/media/media.stop.md new file mode 100644 index 0000000..60651d7 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.stop.md @@ -0,0 +1,169 @@ +--- +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. +--- + +media.stop +========== + +Stops playing an audio file. + + media.stop(); + + +Description +----------- + +Function `media.stop` is a synchronous function that stops playing an audio file. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Play audio + // + function playAudio(url) { + // Play the audio file at url + var my_media = new Media(url, + // success callback + function() { + console.log("playAudio():Audio Success"); + }, + // error callback + function(err) { + console.log("playAudio():Audio Error: "+err); + }); + + // Play audio + my_media.play(); + + // Pause after 10 seconds + setTimeout(function() { + my_media.stop(); + }, 10000); + } + +Full Example +------------ + + + + + Media Example + + + + + + Play Audio + Pause Playing Audio + Stop Playing Audio +

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/media/media.stopRecord.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/media/media.stopRecord.md b/docs/en/2.0.0rc1/cordova/media/media.stopRecord.md new file mode 100644 index 0000000..d7155fb --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/media/media.stopRecord.md @@ -0,0 +1,139 @@ +--- +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. +--- + +media.stopRecord +================ + +Stops recording an audio file. + + media.stopRecord(); + + +Description +----------- + +Function `media.stopRecord` is a synchronous function that stops recording an audio file. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iOS +- Windows Phone 7 ( Mango ) + +Quick Example +------------- + + // Record audio + // + function recordAudio() { + var src = "myrecording.mp3"; + var mediaRec = new Media(src, + // success callback + function() { + console.log("recordAudio():Audio Success"); + }, + + // error callback + function(err) { + console.log("recordAudio():Audio Error: "+ err.code); + }); + + // Record audio + mediaRec.startRecord(); + + // Stop recording after 10 seconds + setTimeout(function() { + mediaRec.stopRecord(); + }, 10000); + } + + +Full Example +------------ + + + + + Device Properties Example + + + + + +

Recording audio...

+

+ + + + + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/notification/notification.alert.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/notification/notification.alert.md b/docs/en/2.0.0rc1/cordova/notification/notification.alert.md new file mode 100644 index 0000000..3c8da7e --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/notification/notification.alert.md @@ -0,0 +1,116 @@ +--- +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.alert +================== + +Shows a custom alert or dialog box. + + navigator.notification.alert(message, alertCallback, [title], [buttonName]) + +- __message:__ Dialog message (`String`) +- __alertCallback:__ Callback to invoke when alert dialog is dismissed. (`Function`) +- __title:__ Dialog title (`String`) (Optional, Default: "Alert") +- __buttonName:__ Button name (`String`) (Optional, Default: "OK") + +Description +----------- + +Most Cordova implementations use a native dialog box for this feature. However, some platforms simply use the browser's `alert` function, which is typically less customizable. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x +- webOS + +Quick Example +------------- + + // Android / BlackBerry WebWorks (OS 5.0 and higher) / iPhone + // + function alertDismissed() { + // do something + } + + navigator.notification.alert( + 'You are the winner!', // message + alertDismissed, // callback + 'Game Over', // title + 'Done' // buttonName + ); + +Full Example +------------ + + + + + Notification Example + + + + + +

Show Alert

+ + + +Windows Phone 7 Quirks +------------- + +- Ignores button names, always uses 'OK' +- There is no built in browser alert, so if you want to just write alert('foo'); you can assign window.alert = navigator.notification.alert; +- alert + confirm calls are non-blocking, and result is only available asyncronously. + +Bada 2.x Quirks +--------------- +- alert uses javascript alert http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/notification/notification.beep.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/notification/notification.beep.md b/docs/en/2.0.0rc1/cordova/notification/notification.beep.md new file mode 100644 index 0000000..7a9903e --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/notification/notification.beep.md @@ -0,0 +1,113 @@ +--- +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.beep +================= + +The device will play a beep sound. + + navigator.notification.beep(times); + +- __times:__ The number of times to repeat the beep (`Number`) + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x + +Quick Example +------------- + + // Beep twice! + navigator.notification.beep(2); + +Full Example +------------ + + + + + Notification Example + + + + + +

Show Alert

+

Play Beep

+

Vibrate

+ + + +Android Quirks +-------------- + +- Android plays the default "Notification ringtone" specified under the "Settings/Sound & Display" panel. + +iPhone Quirks +------------- + +- Ignores the beep count argument. +- There is no native beep API for iPhone. + - Cordova implements beep by playing an audio file via the media API. + - The user must provide a file with the desired beep tone. + - This file must be less than 30 seconds long, located in the www/ root, and must be named `beep.wav`. + +Windows Phone 7 Quirks +------------- + +- WP7 Cordova lib includes a generic beep file that is used. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/notification/notification.confirm.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/notification/notification.confirm.md b/docs/en/2.0.0rc1/cordova/notification/notification.confirm.md new file mode 100755 index 0000000..259ff87 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/notification/notification.confirm.md @@ -0,0 +1,132 @@ +--- +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). (`Function`) +- __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. + +confirmCallback +--------------- + +The `confirmCallback` is called when the user has pressed one of the buttons on the confirmation dialog box. + +The callback takes the argument `buttonIndex` (`Number`), which is the index of the pressed button. It's important to note that the index uses one-based indexing, so the value will be `1`, `2`, `3`, etc. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 ( Mango ) +- Bada 1.2 & 2.x + +Quick Example +------------- + + // process the confirmation dialog result + function onConfirm(buttonIndex) { + alert('You selected button ' + buttonIndex); + } + + // 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

+ + + +Windows Phone 7 Quirks +---------------------- + +- Ignores button names, always `'OK|Cancel'`. +- There is no built-in browser function for `window.confirm` + - You can bind `window.confirm` by assigning `window.confirm = navigator.notification.confirm;`. +- Calls to `alert` and `confirm` are non-blocking and result is only available asyncronously. + +Bada 2.x Quirks +--------------- + +- `confirm` uses the browser's built-in `alert` function. + +Bada 1.2 Quirks +--------------- + +- Ignore button names, always `'OK|Cancel'`. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/notification/notification.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/notification/notification.md b/docs/en/2.0.0rc1/cordova/notification/notification.md new file mode 100644 index 0000000..d2dd991 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/notification/notification.md @@ -0,0 +1,80 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +Notification +============ + +> Visual, audible, and tactile device notifications. + +Methods +------- + +- notification.alert +- notification.confirm +- notification.beep +- notification.vibrate + +Permissions +----------- + +### Android + +#### app/res/xml/plugins.xml + + + +#### app/AndroidManifest.xml + + + +### Bada + +#### manifest.xml + + + SYSTEM_SERVICE + + +### BlackBerry WebWorks + +#### www/plugins.xml + + + +#### www/config.xml + + + +### iOS + +#### App/Supporting Files/Cordova.plist + + Plugins + + Notification + CDVNotification + + +### webOS + + No permissions are required. + +### Windows Phone + + No permissions are required. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/notification/notification.vibrate.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/notification/notification.vibrate.md b/docs/en/2.0.0rc1/cordova/notification/notification.vibrate.md new file mode 100644 index 0000000..b0d2124 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/notification/notification.vibrate.md @@ -0,0 +1,103 @@ +--- +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 WebWorks (OS 5.0 and higher) +- iPhone +- Windows Phone 7 +- Bada 1.2 & 2.x + +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 http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/database/database.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/database/database.md b/docs/en/2.0.0rc1/cordova/storage/database/database.md new file mode 100644 index 0000000..7ca6d81 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/database/database.md @@ -0,0 +1,124 @@ +--- +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 +- webOS + +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", "Cordova Demo", 200000); + db.transaction(populateDB, errorCB, successCB); + +Change Version Quick Example +------------------- + + var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000); + db.changeVersion("1.0", "1.1"); + +Full Example +------------ + + + + + Storage 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/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/localstorage/localstorage.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/localstorage/localstorage.md b/docs/en/2.0.0rc1/cordova/storage/localstorage/localstorage.md new file mode 100644 index 0000000..d0b57c0 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/localstorage/localstorage.md @@ -0,0 +1,120 @@ +--- +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. + +Note: window.sessionStorage provides the same interface, but is cleared between app launches. + +Supported Platforms +------------------- + +- Android +- BlackBerry WebWorks (OS 6.0 and higher) +- iPhone +- Windows Phone 7 +- webOS + +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 +------------ + + + + + Storage Example + + + + + +

Example

+

localStorage

+ + + + +Windows Phone 7 Quirks +------------- + +- dot notation is NOT available on Windows Phone. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue'; http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/parameters/display_name.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/parameters/display_name.md b/docs/en/2.0.0rc1/cordova/storage/parameters/display_name.md new file mode 100644 index 0000000..69af089 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/parameters/display_name.md @@ -0,0 +1,23 @@ +--- +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_displayname +================== + +The display name of the database. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/parameters/name.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/parameters/name.md b/docs/en/2.0.0rc1/cordova/storage/parameters/name.md new file mode 100644 index 0000000..c39dcbf --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/parameters/name.md @@ -0,0 +1,23 @@ +--- +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_name +============ + +The name of the database. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/parameters/size.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/parameters/size.md b/docs/en/2.0.0rc1/cordova/storage/parameters/size.md new file mode 100644 index 0000000..9b46993 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/parameters/size.md @@ -0,0 +1,23 @@ +--- +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_size +============== + +The size of the database in bytes. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/parameters/version.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/parameters/version.md b/docs/en/2.0.0rc1/cordova/storage/parameters/version.md new file mode 100644 index 0000000..2e72923 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/parameters/version.md @@ -0,0 +1,23 @@ +--- +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_version +============= + +The version of the database. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/sqlerror/sqlerror.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/sqlerror/sqlerror.md b/docs/en/2.0.0rc1/cordova/storage/sqlerror/sqlerror.md new file mode 100644 index 0000000..b700222 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/sqlerror/sqlerror.md @@ -0,0 +1,47 @@ +--- +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/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md b/docs/en/2.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md new file mode 100644 index 0000000..ae02d1a --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/sqlresultset/sqlresultset.md @@ -0,0 +1,139 @@ +--- +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 +- __rowsAffected__: 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 its 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 `rowsAffected` 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 +- webOS + +Execute SQL Quick Example +------------------ + + function queryDB(tx) { + tx.executeSql('SELECT * FROM DEMO', [], querySuccess, errorCB); + } + + function querySuccess(tx, results) { + console.log("Returned rows = " + results.rows.length); + // this will be true since it was a select statement and so rowsAffected was 0 + if (!resultSet.rowsAffected) { + console.log('No rows affected!'); + return false; + } + // for an insert statement, this property will return the ID of the last inserted row + console.log("Last inserted row ID = " + results.insertId); + } + + function errorCB(err) { + alert("Error processing SQL: "+err.code); + } + + var db = window.openDatabase("Database", "1.0", "Cordova Demo", 200000); + db.transaction(queryDB, errorCB); + +Full Example +------------ + + + + + Storage Example + + + + + +

Example

+

Database

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md b/docs/en/2.0.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md new file mode 100644 index 0000000..f8c9108 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/sqlresultsetlist/sqlresultsetlist.md @@ -0,0 +1,136 @@ +--- +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 specifing 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 +- webOS + +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 + + + Storage Example + + + + + +

Example

+

Database

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md b/docs/en/2.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md new file mode 100644 index 0000000..4883467 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/sqltransaction/sqltransaction.md @@ -0,0 +1,113 @@ +--- +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 +- webOS + +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", "Cordova Demo", 200000); + db.transaction(populateDB, errorCB, successCB); + +Full Example +------------ + + + + + Storage Example + + + + + +

Example

+

SQLTransaction

+ + http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/storage.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/storage.md b/docs/en/2.0.0rc1/cordova/storage/storage.md new file mode 100644 index 0000000..d8ee694 --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/storage.md @@ -0,0 +1,79 @@ +--- +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 Cordova's implementation. For devices that don't have storage support, Cordova's implementation should be compatible with the W3C specification. + +Methods +------- + +- openDatabase + +Arguments +--------- + +- database_name +- database_version +- database_displayname +- database_size + +Objects +------- + +- Database +- SQLTransaction +- SQLResultSet +- SQLResultSetList +- SQLError +- localStorage + +Permissions +----------- + +### Android + +#### app/res/xml/plugins.xml + + + +### Bada + + No permissions are required. + +### BlackBerry WebWorks + +#### www/config.xml + + + +### iOS + + No permissions are required. + +### webOS + + No permissions are required. + +### Windows Phone + + No permissions are required. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/76664bfc/docs/en/2.0.0rc1/cordova/storage/storage.opendatabase.md ---------------------------------------------------------------------- diff --git a/docs/en/2.0.0rc1/cordova/storage/storage.opendatabase.md b/docs/en/2.0.0rc1/cordova/storage/storage.opendatabase.md new file mode 100644 index 0000000..e529abd --- /dev/null +++ b/docs/en/2.0.0rc1/cordova/storage/storage.opendatabase.md @@ -0,0 +1,74 @@ +--- +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(database_name, database_version, database_displayname, database_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 +- webOS + +Quick Example +------------- + + var db = window.openDatabase("test", "1.0", "Test DB", 1000000); + +Full Example +------------ + + + + + Storage Example + + + + + +

Example

+

Open Database

+ +