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 D159517442 for ; Thu, 10 Sep 2015 21:28:01 +0000 (UTC) Received: (qmail 21241 invoked by uid 500); 10 Sep 2015 21:28:01 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 21114 invoked by uid 500); 10 Sep 2015 21:28:01 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 20899 invoked by uid 99); 10 Sep 2015 21:28:01 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 10 Sep 2015 21:28:01 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4CA06E1084; Thu, 10 Sep 2015 21:28:01 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dblotsky@apache.org To: commits@cordova.apache.org Date: Thu, 10 Sep 2015 21:28:05 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [05/51] [partial] docs commit: Solidifying 'automatic' links. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md b/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md index 61fc5fe..ad072a2 100644 --- a/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md +++ b/www/docs/en/1.8.1/cordova/file/filetransfer/filetransfer.md @@ -18,10 +18,10 @@ license: > under the License. --- -FileTransfer +FileTransfer ========== -FileTransfer is an object that allows you to upload files to a server or download files from a server. +FileTransfer is an object that allows you to upload files to a server or download files from a server. Properties ---------- @@ -37,7 +37,7 @@ Methods Details ------- -The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object. +The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object. It is also possible to download a file from remote and save it on the device (only iOS and Android). Supported Platforms @@ -55,11 +55,11 @@ __Parameters:__ - __filePath__ - Full path of the file on the device - __server__ - URL of the server to receive the file -- __successCallback__ - A callback that is called with a Metadata object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_ +- __successCallback__ - A callback that is called with a Metadata object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_ - __options__ - Optional parameters such as file name and mimetype -__Quick Example__ +__Quick Example__ // !! Assumes variable fileURI contains a valid URI to a text file on the device @@ -75,7 +75,7 @@ __Quick Example__ console.log("upload error target " + error.target); } - var options = new FileUploadOptions(); + var options = new FileUploadOptions(); options.fileKey="file"; options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1); options.mimeType="text/plain"; @@ -86,29 +86,29 @@ __Quick Example__ options.params = params; - var ft = new FileTransfer(); + var ft = new FileTransfer(); ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options); -__Full Example__ +__Full Example__ - File Transfer Example + <a href="../fileobj/fileobj.html">File</a> Transfer <a href="../../storage/storage.opendatabase.html">Example</a> -

Example

-

Upload File

+

Example

+

Upload File

@@ -160,14 +160,14 @@ __Parameters:__ - __source__ - URL of the server to receive the file - __target__ - Full path of the file on the device -- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_ -- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_ +- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_ +- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_ -__Quick Example__ +__Quick Example__ // !! Assumes variable url contains a valid URI to a file on a server and filePath is a valid path on the device - var fileTransfer = new FileTransfer(); + var fileTransfer = new FileTransfer(); fileTransfer.download( url, http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md b/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md index f5fd9db..c843777 100644 --- a/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md +++ b/www/docs/en/1.8.1/cordova/file/filetransfererror/filetransfererror.md @@ -18,10 +18,10 @@ license: > under the License. --- -FileTransferError +FileTransferError ======== -A `FileTransferError` object is returned via the error callback when an error occurs. +A `FileTransferError` object is returned via the error callback when an error occurs. Properties ---------- @@ -34,11 +34,11 @@ Properties Constants --------- -- `FileTransferError.FILE_NOT_FOUND_ERR` -- `FileTransferError.INVALID_URL_ERR` -- `FileTransferError.CONNECTION_ERR` +- `FileTransferError.FILE_NOT_FOUND_ERR` +- `FileTransferError.INVALID_URL_ERR` +- `FileTransferError.CONNECTION_ERR` Description ----------- -The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file. +The `FileTransferError` object is returned via the error callback when an error occurs when uploading a file. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md index 2b02358..afd3e1a 100644 --- a/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md +++ b/www/docs/en/1.8.1/cordova/file/fileuploadoptions/fileuploadoptions.md @@ -18,10 +18,10 @@ license: > under the License. --- -FileUploadOptions +FileUploadOptions ======== -A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. +A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. Properties ---------- @@ -36,7 +36,7 @@ Properties Description ----------- -A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. +A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script. iOS Quirk --------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md index d82cde1..a910ccb 100644 --- a/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md +++ b/www/docs/en/1.8.1/cordova/file/fileuploadresult/fileuploadresult.md @@ -18,10 +18,10 @@ license: > under the License. --- -FileUploadResult +FileUploadResult ======== -A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. +A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. Properties ---------- @@ -33,9 +33,9 @@ Properties Description ----------- -The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. +The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method. iOS Quirks ---------- -- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object. +- iOS does not include values for responseCode nor bytesSent in the success callback FileUploadResult object. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md b/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md index 46d6ae9..e67e71f 100644 --- a/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md +++ b/www/docs/en/1.8.1/cordova/file/filewriter/filewriter.md @@ -18,10 +18,10 @@ license: > under the License. --- -FileWriter +FileWriter ========== -FileWriter is an object that allows one to write a file. +FileWriter is an object that allows one to write a file. Properties ---------- @@ -30,7 +30,7 @@ Properties - __fileName:__ The name of the file to be written. _(DOMString)_ - __length:__ The length of the file to be written. _(long)_ - __position:__ The current position of the file pointer. _(long)_ -- __error:__ An object containing errors. _(FileError)_ +- __error:__ An object containing errors. _(FileError)_ - __onwritestart:__ Called when the write starts. . _(Function)_ - __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED - __onwrite:__ Called when the request has completed successfully. _(Function)_ @@ -49,9 +49,9 @@ Methods Details ------- -The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events. +The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded). Users register their own event listeners to receive the writestart, progress, write, writeend, error and abort events. -A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file. +A FileWriter is created for a single file. You can use it to write to a file multiple times. The FileWriter maintains the file's position and length attributes, so you can seek and write anywhere in the file. By default, the FileWriter writes to the beginning of the file (will overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor to begin writing to the end of the file. Supported Platforms ------------------- @@ -61,7 +61,7 @@ Supported Platforms - iOS - Windows Phone 7 ( Mango ) -Seek Quick Example +Seek Quick Example ------------------------------ function win(writer) { @@ -75,7 +75,7 @@ Seek Quick Example entry.createWriter(win, fail); -Truncate Quick Example +Truncate Quick Example -------------------------- function win(writer) { @@ -88,7 +88,7 @@ Truncate Quick Example entry.createWriter(win, fail); -Write Quick Example +Write Quick Example ------------------- function win(writer) { @@ -104,7 +104,7 @@ Write Quick Example entry.createWriter(win, fail); -Append Quick Example +Append Quick Example -------------------- function win(writer) { @@ -121,7 +121,7 @@ Append Quick Example entry.createWriter(win, fail); -Abort Quick Example +Abort Quick Example ------------------- function win(writer) { @@ -138,35 +138,35 @@ Abort Quick Example entry.createWriter(win, fail); -Full Example +Full Example ------------ - FileWriter Example + <a href="../fileobj/fileobj.html">File</a>Writer <a href="../../storage/storage.opendatabase.html">Example</a> -

Example

-

Write File

+

Example

+

Write File

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/flags/flags.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/flags/flags.md b/www/docs/en/1.8.1/cordova/file/flags/flags.md index dedd8d4..c5e9c8d 100644 --- a/www/docs/en/1.8.1/cordova/file/flags/flags.md +++ b/www/docs/en/1.8.1/cordova/file/flags/flags.md @@ -21,7 +21,7 @@ license: > Flags ===== -This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively. +This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively. Properties ---------- @@ -37,11 +37,11 @@ Supported Platforms - iOS - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- // Get the data directory, creating it if it doesn't exist. dataDir = fileSystem.root.getDirectory("data", {create: true}); // Create the lock file, if and only if it doesn't exist. - lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true}); + lockFile = dataDir.getFile("lockfile.txt", {create: true, exclusive: true}); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md index d00b3a7..4b2da96 100644 --- a/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md +++ b/www/docs/en/1.8.1/cordova/file/localfilesystem/localfilesystem.md @@ -18,7 +18,7 @@ license: > under the License. --- -LocalFileSystem +LocalFileSystem =============== This object provides a way to obtain root file systems. @@ -26,19 +26,19 @@ This object provides a way to obtain root file systems. Methods ---------- -- __requestFileSystem:__ Requests a filesystem. _(Function)_ -- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_ +- __requestFileSystem:__ Requests a filesystem. _(Function)_ +- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_ Constants --------- -- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission. -- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence. +- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission. +- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence. Details ------- -The `LocalFileSystem` object methods are defined on the __window__ object. +The `LocalFileSystem` object methods are defined on the __window__ object. Supported Platforms ------------------- @@ -48,7 +48,7 @@ Supported Platforms - iOS - Windows Phone 7 ( Mango ) -Request File System Quick Example +Request File System Quick Example --------------------------------- function onSuccess(fileSystem) { @@ -56,41 +56,41 @@ Request File System Quick Example } // request the persistent file system - window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError); + window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError); -Resolve Local File System URI Quick Example +Resolve Local File System URI Quick Example ------------------------------------------- function onSuccess(fileEntry) { console.log(fileEntry.name); } - window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError); + window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError); -Full Example +Full Example ------------ - Local File System Example + Local <a href="../fileobj/fileobj.html">File</a> System <a href="../../storage/storage.opendatabase.html">Example</a> -

Example

-

Local File System

+

Example

+

Local File System

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/file/metadata/metadata.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md b/www/docs/en/1.8.1/cordova/file/metadata/metadata.md index 487d07c..e4c5194 100644 --- a/www/docs/en/1.8.1/cordova/file/metadata/metadata.md +++ b/www/docs/en/1.8.1/cordova/file/metadata/metadata.md @@ -31,7 +31,7 @@ Properties Details ------- -The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object. +The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object. Supported Platforms ------------------- @@ -41,7 +41,7 @@ Supported Platforms - iOS - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- function win(metadata) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md index 005aa49..f877c14 100644 --- a/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md +++ b/www/docs/en/1.8.1/cordova/geolocation/Coordinates/coordinates.md @@ -37,7 +37,7 @@ Properties Description ----------- -The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function. +The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function. Supported Platforms ------------------- @@ -49,7 +49,7 @@ Supported Platforms - Bada 1.2 & 2.x - webOS -Quick Example +Quick Example ------------- // onSuccess Callback @@ -71,29 +71,29 @@ Quick Example alert('onError!'); }; - navigator.geolocation.getCurrentPosition(onSuccess, onError); + navigator.geolocation.getCurrentPosition(onSuccess, onError); -Full Example +Full Example ------------ - Geolocation Position Example + <a href="../geolocation.html">Geolocation</a> <a href="../Position/position.html">Position</a> <a href="../../storage/storage.opendatabase.html">Example</a>