File (文件操作)

获取

var File = RongDesktop.require('File');

File.open(path)

使用系统系统默认方式打开指定文件

参数说明:

参数 类型 是否必填 说明 桌面版版本
path String 本地路径 2.0.0

示例代码:

var path = '/Users/rongcloud/rong.png';
File.open(path);

File.openFolder(path)

在系统文件管理器中显示指定目录

参数说明:

参数 类型 是否必填 说明 桌面版版本
path String 本地路径 2.0.0

示例代码:

var path = '/Users/rongcloud/rong.png';
File.openFolder(path);

File.exist(path)

检查本地文件是否存在

参数说明:

参数 类型 是否必填 说明 桌面版版本
path String 本地路径 2.0.0

示例代码:

var path = '/Users/rongcloud/rong.png';
var exist = File.exist(path);
console.log(exist);
// true

File.save(option, callback)

保存文件

option 参数说明:

参数 类型 是否必填 说明 桌面版版本
url String 文件下载地址 2.0.0
name String 文件保存后的别名, 默认为原文件名 2.0.0
path String 保存路径 2.0.0
size Number 文件总大小 2.0.0
chunkSize Number 分片大小 2.0.0
timeout Number 连接超时时间, 默认 100000, 单位为 ms 2.0.0
retries Number 出错时重试次数, 默认 1 2.0.0

callback 参数说明:

参数 类型 是否必填 说明 桌面版版本
onBefore Function 即将下载回调 2.0.0
onProgress Function 下载中回调 2.0.0
onComplete Function 下载完成回调 2.0.0
onCancel Function 下载取消回调 2.0.0
onError Function 下载失败回调 2.0.0

示例代码:

var option = {
    url: 'http://cdn.ronghub.com/thinking-face.png',
    name: 'face.png'
};
var manager = File.save(option, {
    onProgress: function(file) {
        var loaded = file.loaded;
        var total = file.total;
    }
});
// 暂停下载
manager.pause()

File.saveAs(option, callback)

弹出本地路径选择框, 保存文件. 保存地址为用户选择路径. 仅 macOS, win7+ 有效

示例代码:

var option = {
    url: 'http://cdn.ronghub.com/thinking-face.png'
};
var manager = File.saveAs(option, {
    onComplete: function(file) {
        var loaded = file.loaded;
        var total = file.total;
        var path = file.path;
    }
});

onBefore(callback)

即将下载回调

onBefore 回调参数说明:

参数 类型 说明 桌面版版本
total String 文件总大小 2.0.0
path String 文件保存路径 2.0.0

示例代码:

var option = { url: 'http://cdn.ronghub.com/thinking-face.png' };
var manager = File.save(option, {
    onBefore: function(file) {
        var total = file.total;
        var path = file.path;
    }
});

onProgress(callback)

下载中回调

onProgress 回调参数说明:

参数 类型 说明 桌面版版本
loaded String 已下载文件大小 2.0.0
total String 文件总大小 2.0.0
path String 文件保存路径 2.0.0

示例代码:

var option = { url: 'http://cdn.ronghub.com/thinking-face.png' };
var manager = File.save(option, {
    onProgress: function(file) {
        var loaded = file.loaded;
        var total = file.total;
        var progress = loaded / total;
    }
});

onComplete(callback)

下载完成回调

onComplete 回调参数说明:

参数 类型 说明 桌面版版本
loaded String 已下载文件大小 2.0.0
total String 文件总大小 2.0.0
path String 文件保存路径 2.0.0

示例代码:

var option = { url: 'http://cdn.ronghub.com/thinking-face.png' };
var manager = File.save(option, {
    onComplete: function(file) {
        var loaded = file.loaded;
        var total = file.total;
        var path = file.path;
    }
});

onCancel(callback)

下载取消回调

onCancel 回调参数说明:

参数 类型 说明 桌面版版本
loaded String 已下载文件大小 2.0.0
total String 文件总大小 2.0.0
path String 文件保存路径 2.0.0

示例代码:

var option = { url: 'http://cdn.ronghub.com/thinking-face.png' };
var manager = File.save(option, {
    onCancel: function(file) {
        var loaded = file.loaded;
        var total = file.total;
        var path = file.path;
    }
});

onError(callback)

下载失败

onError 回调参数说明:

参数 类型 说明 桌面版版本
code String 错误码 2.0.0
message String 错误信息 2.0.0

常见错误码:

  • ENOTFOUND:DNS 找不到域名. 请检查 1. 域名是否写错 2. 网络连接是否正常
  • ECONNREFUSED:防火墙或代理程序无法访问网络. 请检查防火墙或者代理设置
  • EPIPE:nodejs 版本过低
  • ETIMEDOUT:连接超时

示例代码:

var option = { url: 'http://cdn.ronghub.com/thinking-face.png' };
var manager = File.save(option, {
    onError: function(file) {
        var code = file.code;
        var message = file.message;
    }
});

manager.pause()

暂停下载

manager.resume()

恢复下载

manager.abort()

中断下载

results matching ""

    No results matching ""