概述

zipModule 模块封装了对 zip 文件解压缩等相关操作

注意：本模块 iOS 平台上最低适配系统版本为 iOS 9.0

模块接口

createZip

压缩单个文件

createZip({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩后的文件存放路径，支持fs、widget (Android 不支持widget)

samplePath：

• 类型：字符串
• 描述：压缩文件路径

password：

• 类型：字符串
• 描述：（可选项）压缩文件密码，不传则压缩文件没有密码
• 默认：无

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     status:true, //布尔类型；是否压缩成功
}

示例代码

var zipModule = api.require('zipModule');
zipModule.createZip({
  zipPath:'fs://123.zip',
  samplePath:'widget://file/111.pdf'
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

createMultipleZip

压缩多个个文件

createMultipleZip({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩后的文件存放路径，支持fs、widget (Android 不支持widget)

samplePaths：

• 类型：数组
• 描述：压缩文件路径数组
• 内部字段：

[
    'widget://file/123.png'
]

password：

• 类型：字符串
• 描述：（可选项）压缩文件密码，不传则压缩文件没有密码
• 默认：无

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     status:true, //布尔类型；是否压缩成功
}

示例代码

var zipModule = api.require('zipModule');
zipModule.createMultipleZip({
  zipPath:'',
  samplePaths:[]
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

unzip

解压文件

unzip({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩文件路径，支持fs、widget

unzipPath：

• 类型：字符串
• 描述：解压压缩文件后的路径，支持fs、widget

password：

• 类型：字符串
• 描述：（可选项）压缩文件密码，压缩文件没有密码可不传
• 默认：无

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     status:true, //布尔类型；是否压缩成功

}

示例代码

var zipModule = api.require('zipModule');
zipModule.unzip({
  zipPath:'',
  unzipPath:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hasPassword

验证压缩文件是否有密码

hasPassword({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩文件路径，支持fs、widget

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     status:true, //布尔类型；是否有密码
}

示例代码

var zipModule = api.require('zipModule');
zipModule.hasPassword({
  zipPath:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isPasswordValidForArchiveAtPath

验证压缩文件密码是否正确 （Android不支持该方法）

isPasswordValidForArchiveAtPath({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩文件路径，支持fs、widget

password：

• 类型：字符串
• 描述：压缩文件密码

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     status:true, //布尔类型；密码是否正确
}

示例代码

var zipModule = api.require('zipModule');
zipModule.isPasswordValidForArchiveAtPath({
  zipPath:'',
  password:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

payloadSizeForArchiveAtPath

获取解压文件大小 （Android不支持该方法）

payloadSizeForArchiveAtPath({params},callback(ret))

params

zipPath：

• 类型：字符串
• 描述：压缩文件路径，支持fs、widget

callback(ret)

ret:

• 类型：JSON对象
• 内部字段：

{
     size:6, //数字类型；压缩文件大小
}

示例代码

var zipModule = api.require('zipModule');
zipModule.payloadSizeForArchiveAtPath({
  zipPath:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本