cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rakatyal <...@git.apache.org>
Subject [GitHub] cordova-plugin-file-transfer pull request: adding sample section t...
Date Mon, 11 Apr 2016 23:07:00 GMT
Github user rakatyal commented on a diff in the pull request:

    https://github.com/apache/cordova-plugin-file-transfer/pull/136#discussion_r59297145
  
    --- Diff: README.md ---
    @@ -315,3 +315,231 @@ If you are upgrading to a new (1.0.0 or newer) version of File,
and you have pre
         cdvfile://localhost/persistent/path/to/file
     
     which can be used in place of the absolute file path in both `download()` and `upload()`
methods.
    +
    +## Sample: Download and Upload Files <a name="sample"></a>
    +
    +Use the File-Transfer plugin to upload and download files. In these examples, we demonstrate
several tasks like:
    +
    +* Downloading a binary file to the application cache
    +* Uploading a file created in your application's root
    +* Downloading the uploaded file
    +
    +## Download a Binary File to the application cache
    +
    +Use the File plugin with the File-Transfer plugin to provide a target for the files that
you download (the target must be a FileEntry object). Before you download the file, create
a DirectoryEntry object by using `resolveLocalFileSystemURL` and calling `fs.root` in the
success callback. Use the `getFile` method of DirectoryEntry to create the target file.
    +
    +```js
    +window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
    +
    +    console.log('file system open: ' + fs.name);
    +
    +    // Make sure you add the domain name to the Content-Security-Policy <meta>
element.
    +    var url = 'http://cordova.apache.org/static/img/cordova_bot.png';
    +    fs.root.getFile('downloaded-image.png', { create: true, exclusive: false }, function
(fileEntry) {
    +        download(fileEntry, url, true);
    +
    +    }, onErrorCreateFile);
    +
    +}, onErrorLoadFs);
    +```
    +
    +>*Note* For persistent storage, pass LocalFileSystem.PERSISTENT to requestFileSystem.
    +
    +When you have the FileEntry object, download the file using the `download` method of
the FileTransfer object. The 3rd argument to the function is the success handler, which you
can use to call the app's `readBinaryFile` function. In this code example, the `entry` variable
is a new FileEntry object that receives the result of the download operation.
    +
    +```js
    +function download(fileEntry, uri) {
    +
    +    var fileTransfer = new FileTransfer();
    +    var fileURL = fileEntry.toURL();
    +
    +    fileTransfer.download(
    +        uri,
    +        fileURL,
    +        function (entry) {
    +            console.log("download complete: " + entry.toURL());
    +            readBinaryFile(entry);
    +        },
    +        function (error) {
    +            console.log("download error source " + error.source);
    --- End diff --
    
    Consider adding ":" between the string and the value in these examples.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org


Mime
View raw message