# [zip]()
Zip模块管理文件压缩和解压,通过plus.zip可获取压缩管理对象。
### 方法:
- [compress](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.compress): 用于压缩Zip文件
- [decompress](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.decompress): 用于解压缩Zip文件。
### 回调方法:
- [ZipSuccessCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipSuccessCallback): 操作成功回调函数接口,在解压Zip文件或压缩成Zip文件成功时调用
- [ZipErrorCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipErrorCallback): 操作错误回调函数接口,在解压Zip文件或压缩成Zip文件失败时调用
### 权限:
permissions
~~~
"Zip": {
"description": "文件压缩与解压缩"
}
~~~
# [compress]()
用于压缩Zip文件
~~~
void plus.zip.compress(src, zipfile, successCB, errorCB);
~~~
### 参数:
- src: *( DOMString ) 可选 *要压缩的源文件路径,支持文件路径或目录
- zipfile: *( DOMString ) 可选 *压缩后保存的Zip文件路径
- successCB: *( [ZipSuccessCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipSuccessCallback) ) 必选 *压缩Zip文件操作成功回调,在压缩操作成功时调用
- errorCB: *( [ZipErrorCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipErrorCallback) ) 必选 *压缩Zip文件操作失败回调,在压缩操作失败时调用
### 返回值:
void : 无
### 示例:
~~~
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8" />
<script type="text/javascript">
//压缩
function zipCompress(){
var zipfile = "_doc/text11.zip";
var targetPath = '_doc/dir/';
plus.zip.compress(targetPath,zipfile,
function() {
alert("Compress success!");
},function(error) {
alert("Compress error!");
});
}
</script>
</head>
<body >
<input type='button' onclick='zipCompress()' value='zip压缩' />
</body>
</html>
~~~
# [decompress]()
用于解压缩Zip文件。
~~~
void plus.zip.decompress( zipfile, target, successCB, errorCB);
~~~
### 参数:
- zipfile: *( DOMString ) 可选 *
需解压Zip文件路径
- target: *( DOMString ) 可选 *
解压Zip文件的目标路径,必须是路径
- successCB: *( [ZipSuccessCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipSuccessCallback) ) 必选 *
解压Zip文件操作成功回调,在解压操作成功时调用。
- errorCB: *( [ZipErrorCallback](http://www.dcloud.io/docs/api/zh_cn/zip.shtml#plus.zip.ZipErrorCallback) ) 必选 *
解压Zip文件操作失败回调,在解压操作失败时调用。
### 返回值:
void : 无
### 示例:
~~~
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8" />
<script type="text/javascript">
//解压缩
function zipDecompress() {
var zipfile = "_doc/text.zip";
var targetPath = '_doc/dir/';
plus.zip.decompress(zipfile, targetPath,
function() {
alert("Decompress success!");
},function(error) {
alert("Compress error!");
});
}
</script>
</head>
<body >
<input type='button' onclick='zipDecompress()' value='zip解压' />
</body>
</html>
~~~
# [ZipSuccessCallback]()
操作成功回调函数接口,在解压Zip文件或压缩成Zip文件成功时调用
~~~
void onSuccess(){
// Code here
}
~~~
### 参数:
无
### 返回值:
void : 无
# [ZipErrorCallback]()
操作错误回调函数接口,在解压Zip文件或压缩成Zip文件失败时调用
~~~
void onError(error){
// Handle the error
}
~~~
### 参数:
- error: *( DOMException ) 可选 *
Zip文件操作的错误信息
### 返回值:
void : 无
- API参考
- Accelerometer
- Audio
- Camera
- Contacts
- Device
- Downloader
- Events
- Gallery
- Geolocation
- IO
- Key
- Messaging
- NativeUI
- Navigator
- Orientation
- Proximity
- SplashScreen
- Storage
- UI
- Uploader
- InterfaceOrientation
- Runtime
- WebView
- XMLHttpRequest
- Zip
- Plugins
- Barcode
- Maps
- Payment
- Push
- Share
- Speech
- Statistic
- Native.js
- Android
- iOS