2016-08-16 12:53:15 +08:00
|
|
|
import { Plugin, Cordova } from './plugin';
|
2016-08-15 17:10:43 +08:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @name Zip
|
|
|
|
|
* @description
|
|
|
|
|
* A Cordova plugin to unzip files in Android and iOS.
|
|
|
|
|
*
|
|
|
|
|
* @usage
|
|
|
|
|
* ```
|
|
|
|
|
* import {Zip} from 'ionic-native';
|
|
|
|
|
*
|
|
|
|
|
* Zip.unzip('path/to/source.zip', 'path/to/dest', (progress) => console.log('Unzipping, ' + Math.round((progress.loaded / progress.total) * 100) + '%'))
|
|
|
|
|
* .then((result) => {
|
|
|
|
|
* if(result === 0) console.log('SUCCESS');
|
|
|
|
|
* if(result === -1) console.log('FAILED');
|
|
|
|
|
* });
|
|
|
|
|
*
|
|
|
|
|
* ```
|
|
|
|
|
*/
|
|
|
|
|
@Plugin({
|
|
|
|
|
plugin: 'cordova-plugin-zip',
|
|
|
|
|
pluginRef: 'zip',
|
|
|
|
|
repo: 'https://github.com/MobileChromeApps/cordova-plugin-zip',
|
|
|
|
|
})
|
|
|
|
|
export class Zip {
|
|
|
|
|
/**
|
|
|
|
|
* Extracts files from a ZIP archive
|
|
|
|
|
* @param sourceZip {string} Source ZIP file
|
|
|
|
|
* @param destUrl {string} Destination folder
|
|
|
|
|
* @param onProgress {Function} optional callback to be called on progress update
|
|
|
|
|
* @return {Promise<number>} returns a promise that resolves with a number. 0 is success, -1 is error
|
|
|
|
|
*/
|
|
|
|
|
@Cordova({
|
|
|
|
|
successIndex: 2,
|
|
|
|
|
errorIndex: 4
|
|
|
|
|
})
|
|
|
|
|
static unzip(sourceZip: string, destUrl: string, onProgress: Function): Promise<number> {return; }
|
|
|
|
|
|
|
|
|
|
}
|
