0.0.1 • Published 8 years ago
DownloadManager v0.0.1
DownloaderManager plugin for Cordova
The plugin can start and stop a file download from the web (HTTP).
Adding the plugin to your project
Add the git repository to your project:
cordova-plugin-downloadmanager=https://github.com/pierrejochem/cordova-plugin-downloadmanager.git
Using the plugin
The plugin creates the method downloadmanager(action, options, win, fail)
action
may be:
start
to beging to download a filecancel
to stop oneisdownloading
to know the status of another
options
is a json object containing the parameters (some optional) that DownloadManager accepts, it can be:
id:
an ID from a download process (required for "cancel" and "isdownloadind" action)url:
the url to get (http://wherever.com/whatever.txt) (required for "start" action)filePath:
path where to save the file (FileSystem/Download/YOUR_PATH) (optional, by default the app name)fileName:
filename for the resource (FileSystem/Download/YOUR_PATH/YOUR_FILENAME.yy) (optional, by default the url name)overwrite:
If the file already exists, download it again. (required for "start" action)useNotificationBar:
true
to use the Android notification bar to show the progress (optional, by defautl true)startToast:
Message on toast at the beginning of the download process (optional)endToast:
Message on toast at the end of the download process (optional)ticker:
Message to show on notification area where the download start (optional)notificationTitle:
Message to show on the notification bar while during download (optional)cancelToast:
: Message on toast where the donwload is canceled (stoped) (optional)
win
and fail
are callback functions. win
will be called when there is a progress in the download. The passed object is:
{
id: "45345" // id to handle the process
downloading: true // true or false
total: 1000, // The total number of bytes to download.
file: "file.ext" // Name of the file
dir: "youappname" // Path where to download
progress: 46, // In percent
}
Using the plugin
- Basic: (start a download on a notification bar)
- Check if a donwload is in progress:
- More:
Based on
https://github.com/aabilio/phonegap-plugins/tree/master/Android/DownloadManager
Licence
GPL v3
0.0.1
8 years ago