FileSystemManager

FileSystemManager.open

FileSystemManager.open(Object object): void

打开文件，返回文件描述符。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

success回调函数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.open({
  filePath: 'internal://cache/test.txt',
  success: (res) => {
    console.info('open success', res);
  },
  fail: (err) => {
    console.error('open fail', err);
  },
  complete: (res) => {
    console.info('open complete', res);
  }
});

FileSystemManager.openSync

FileSystemManager.openSync(Object object): string

同步打开文件，返回文件描述符。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

返回值：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});

FileSystemManager.close

FileSystemManager.close(Object object): void

关闭文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});
fileSystemManager.close({
  fd: fd,
  success: () => {
    console.info('close success');
  },
  fail: (err) => {
    console.error('close fail', err);
  },
  complete: (res) => {
    console.info('close complete', res);
  }
});

FileSystemManager.closeSync

FileSystemManager.closeSync(Object object): void

同步关闭文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});
fileSystemManager.closeSync({
  fd: fd
});

FileSystemManager.read

FileSystemManager.read(Object object): void

读文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

success回调函数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});
fileSystemManager.read({
  fd: fd,
  arrayBuffer: new ArrayBuffer(10),
  length: 10,
  success: (res) => {
    console.info('read success', res.bytesRead);
  },
  fail: (err) => {
    console.error('read fail', err);
  },
  complete: (res) => {
    console.info('read complete', res);
  }
});

FileSystemManager.readSync

FileSystemManager.readSync(Object object): ReadResult

同步读文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

返回值：

ReadResult，文件读取结果，为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});
const readResult = fileSystemManager.readSync({
  fd: fd,
  arrayBuffer: new ArrayBuffer(10),
  length: 10
});
console.info('bytesRead', readResult.bytesRead);
console.info('arrayBuffer', readResult.arrayBuffer);

FileSystemManager.fstat

FileSystemManager.fstat(Object object): void

获取文件的状态信息。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

success回调函数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt'
});
fileSystemManager.fstat({
  fd: fd,
  success: (res) => {
    console.info('fstat success', res);
    console.info('fstat success', res.stats.isFile());
  },
  fail: (err) => {
    console.error('fstat fail', err);
  },
  complete: (res) => {
    console.info('fstat complete', res);
  }
});

FileSystemManager.fstatSync

FileSystemManager.fstatSync(Object object): Stats

同步获取文件的状态信息。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

返回值：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  const fd = fileSystemManager.openSync({
    filePath: 'internal://cache/test.txt'
  });
  const stats = fileSystemManager.fstatSync({
    fd: fd
  });
  console.info('fstatSync result', stats);
  console.info('fstatSync result', stats.isFile());
} catch (err) {
  console.error('fstatSync error', err);
}

FileSystemManager.ftruncate

FileSystemManager.ftruncate(Object object): void

对文件内容进行截断操作。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt', // 文件需要写入权限
  flag: 'r+'
});
fileSystemManager.ftruncate({
  fd: fd,
  length: 0,
  success: () => {
    console.info('ftruncate success');
  },
  fail: (err) => {
    console.error('ftruncate fail', err);
  },
  complete: (res) => {
    console.info('ftruncate complete', res);
  }
});

FileSystemManager.ftruncateSync

FileSystemManager.ftruncateSync(Object object): void

同步对文件内容进行截断操作。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt', // 文件需要写入权限
  flag: 'r+'
});
fileSystemManager.ftruncateSync({
  fd: fd,
  length: 0
});

FileSystemManager.truncate

FileSystemManager.truncate(Object object): void

对文件内容进行截断操作。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.truncate({
  filePath: 'internal://cache/test.txt',
  length: 0,
  success: () => {
    console.info('truncate success');
  },
  fail: (err) => {
    console.error('truncate fail', err);
  },
  complete: (res) => {
    console.info('truncate complete', res);
  }
});

FileSystemManager.truncateSync

FileSystemManager.truncateSync(Object object): void

同步对文件内容进行截断操作。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.truncateSync({
  filePath: 'internal://cache/test.txt',
  length: 0
});

FileSystemManager.write

FileSystemManager.write(Object object): void

写入文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

success回调函数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt',
  flag: 'r+'
});
fileSystemManager.write({
  fd: fd,
  data: 'some text',
  success: (res) => {
    console.info('write success', res.bytesWritten);
  },
  fail: (err) => {
    console.error('write fail', err);
  },
  complete: (res) => {
    console.info('write complete', res);
  }
});

FileSystemManager.writeSync

FileSystemManager.writeSync(Object object): WriteResult

同步写入文件。

起始版本： 1.0.16

参数：

参数为Object对象，包括以下字段。

返回值：

返回文件写入结果WriteResult，类型为Object对象。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const fd = fileSystemManager.openSync({
  filePath: 'internal://cache/test.txt',
  flag: 'r+'
});
const writeResult = fileSystemManager.writeSync({
  fd: fd,
  data: 'some text'
});
console.info('writeSync.bytesWritten ', writeResult.bytesWritten);

FileSystemManager.access

FileSystemManager.access(Object object)

异步判断一个文件/目录是否存在。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

fail返回值：

若不存在则返回：

{errMsg: 'access:fail no such file or directory.'}

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.access({
  path: 'internal://cache/demo.png',
  success: () => {
    console.info('access success');
  },
  fail: (err) => {
    console.error('access fail', err);
  },
  complete: (res) => {
    console.info('access complete', res);
  }
});

FileSystemManager.accessSync

FileSystemManager.accessSync(string path): void

同步判断一个文件/目录是否存在。存在则正常执行，不存在抛出异常。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.accessSync('internal://cache/demo.png');
} catch (err) {
  console.error('accessSync error', err);
}

FileSystemManager.appendFile

FileSystemManager.appendFile(Object object)

在文件结尾追加内容。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.appendFile({
  filePath: 'internal://cache/demo.png',
  data: '附件内容',
  success: () => {
    console.info('appendFile success');
  },
  fail: (err) => {
    console.error('appendFile fail', err);
  },
  complete: (res) => {
    console.info('appendFile complete', res);
  }
});

FileSystemManager.appendFileSync

FileSystemManager.appendFileSync(string filePath, string|ArrayBuffer data, string encoding): void

在文件结尾追加内容。成功则正常执行，失败抛出异常。（ArrayBuffer类型支持情况依据框架是否支持决定）

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.appendFileSync('internal://cache/demo.png', '附件内容', 'utf-8');
} catch (err) {
  console.error('appendFileSync error', err);
}

FileSystemManager.copyFile

FileSystemManager.copyFile(Object object)

异步复制文件接口。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

fail返回值：

{ errMsg: 'copyFile:fail  原因' }

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.copyFile({
  srcPath: 'internal://cache/demo.png',
  destPath: 'internal://cache/demo_copy.png',
  success: () => {
    console.info('copyFile success');
  },
  fail: (err) => {
    console.error('copyFile fail', err);
  },
  complete: (res) => {
    console.info('copyFile complete', res);
  }
});

FileSystemManager.copyFileSync

FileSystemManager.copyFileSync(string srcPath, string destPath): void

同步复制文件接口。成功则正常执行，失败抛出异常。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.copyFileSync('internal://cache/demo.png', 'internal://cache/demo_copy.png');
} catch (err) {
  console.error('copyFileSync error', err);
}

FileSystemManager.getFileInfo

FileSystemManager.getFileInfo(Object object)

获取该元服务下的本地临时文件或本地缓存文件信息。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.getFileInfo({
  filePath: 'internal://cache/demo.png',
  digestAlgorithm: 'sha256',
  success: (res) => {
    console.info('getFileInfo success', res);
  },
  fail: (err) => {
    console.error('getFileInfo fail', err);
  },
  complete: (res) => {
    console.info('getFileInfo complete', res);
  }
});

FileSystemManager.getSavedFileList

FileSystemManager.getSavedFileList(Object object)

获取该元服务下的internal://files/store/下的文件列表。（保存缓存文件时，需写入到指定路径internal://files/store/下）

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

fileList说明：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.getSavedFileList({
  success: (res) => {
    console.info('getSavedFileList success', res);
  },
  fail: (err) => {
    console.error('getSavedFileList fail', err);
  },
  complete: (res) => {
    console.info('getSavedFileList complete', res);
  }
});

FileSystemManager.mkdir

FileSystemManager.mkdir(Object object)

创建目录。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.mkdir({
  dirPath: 'internal://files/example',
  recursive: false,
  success: () => {
    console.info('mkdir success');
  },
  fail: (err) => {
    console.error('mkdir fail', err);
  },
  complete: (res) => {
    console.info('mkdir complete', res);
  }
});

FileSystemManager.mkdirSync

FileSystemManager.mkdirSync(string dirPath, boolean recursive): void

同步创建目录。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.mkdirSync('internal://files/example', false);
} catch (err) {
  console.error('mkdirSync error', err);
}

FileSystemManager.readdir

FileSystemManager.readdir(Object object)

读取目录内文件列表。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.readdir({
  dirPath: 'internal://files/example',
  success: (res) => {
    console.info('readdir success', res);
  },
  fail: (err) => {
    console.error('readdir fail', err);
  },
  complete: (res) => {
    console.info('readdir complete', res);
  }
});

FileSystemManager.readdirSync

FileSystemManager.readdirSync(string dirPath): Array<string>

同步读取目录内文件列表（本地路径）。

起始版本： 1.0.4

参数：

返回值：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  const res = fileSystemManager.readdirSync('internal://files/example');
  console.info('readdirSync success', res);
} catch (err) {
  console.error('readdirSync error', err);
}

FileSystemManager.readFile

FileSystemManager.readFile(Object object)

读取本地文件内容。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.readFile({
  filePath: 'internal://files/hello.txt',
  encoding: 'utf-8',
  position: 0,
  success: (res) => {
    console.info('readFile success', res);
  },
  fail: (err) => {
    console.error('readFile fail', err);
  },
  complete: (res) => {
    console.info('readFile complete', res);
  }
});

FileSystemManager.readFileSync

FileSystemManager.readFileSync(string filePath, string encoding, number position, number length): string|ArrayBuffer

同步读取本地文件内容。

起始版本： 1.0.4

参数：

返回值：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  const res = fileSystemManager.readFileSync('internal://files/hello.txt', 'utf-8', 0);
  console.info('readFileSync success', res);
} catch (err) {
  console.error('readFileSync error', err);
}

FileSystemManager.removeSavedFile

FileSystemManager.removeSavedFile(Object object)

删除该元服务下已保存的本地缓存文件

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.removeSavedFile({
  filePath: 'internal://files/store/hello.txt',
  success: () => {
    console.info('removeSavedFile success');
  },
  fail: (err) => {
    console.error('removeSavedFile fail', err);
  },
  complete: (res) => {
    console.info('removeSavedFile complete', res);
  }
});

FileSystemManager.rename

FileSystemManager.rename(Object object)

重命名文件。可以把文件从oldPath移动到newPath。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.rename({
  oldPath: 'internal://files/hello.txt',
  newPath: 'internal://files/hello_new.txt',
  success: () => {
    console.info('rename success');
  },
  fail: (err) => {
    console.error('rename fail', err);
  },
  complete: (res) => {
    console.info('rename complete', res);
  }
});

FileSystemManager.renameSync

FileSystemManager.renameSync(string oldPath, string newPath): void

同步重命名文件。可以把文件从oldPath移动到newPath。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.renameSync('internal://files/hello.txt', 'internal://files/hello_new.txt');
} catch(err) {
  console.error('renameSync error', err);
}

FileSystemManager.rmdir

FileSystemManager.rmdir(Object object)

删除目录。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.rmdir({
  dirPath: 'internal://files/example',
  recursive: false,
  success: () => {
    console.info('rmdir success');
  },
  fail: (err) => {
    console.error('rmdir fail', err);
  },
  complete: (res) => {
    console.info('rmdir complete', res);
  }
});

FileSystemManager.rmdirSync

FileSystemManager.rmdirSync(string dirPath, boolean recursive): void

同步删除目录。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.rmdirSync('internal://files/example', false);
} catch (err) {
  console.error('rmdirSync error', err);
}

FileSystemManager.saveFile

FileSystemManager.saveFile(Object object)

保存临时文件到本地。此接口会移动临时文件，因此调用成功后（tempFilePath：internal://tmp/, filePath: internal://files/store/），tempFilePath将不可用。

仅当tempFilePath传入temp目录下的文件路径（internal://tmp/）时，才允许filePath传入store目录下的文件路径（internal://files/store/）。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.saveFile({
  tempFilePath: 'internal://tmp/templete.png',
  success: (res) => {
    console.info('saveFile success', res);
  },
  fail: (err) => {
    console.error('saveFile fail', err);
  },
  complete: (res) => {
    console.info('saveFile complete', res);
  }
});

FileSystemManager.saveFileSync

FileSystemManager.saveFileSync(string tempFilePath, string filePath): string

同步保存临时文件到本地。

仅当tempFilePath传入temp目录下的文件路径（internal://tmp/）时，才允许filePath传入store目录下的文件路径（internal://files/store/）。

起始版本： 1.0.4

参数：

返回值：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
const savedFilePath = fileSystemManager.saveFileSync('internal://tmp/demo.png');

FileSystemManager.stat

FileSystemManager.stat(Object object)

获取文件Stats对象。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

success返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.stat({
  path: 'internal://cache/demo.png',
  recursive: false,
  success: (res) => {
    console.info('stat success', res);
  },
  fail: (err) => {
    console.error('stat fail', err);
  },
  complete: (res) => {
    console.info('stat complete', res);
  }
});

FileSystemManager.statSync

FileSystemManager.statSync(string path, boolean recursive): Object

同步获取文件Stats对象。

起始版本： 1.0.4

参数：

返回值：

返回值为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  const res = fileSystemManager.statSync('internal://cache/demo.png');
  console.info('statSync result', res);
} catch (err) {
  console.error('statSync error', err);
}

FileSystemManager.unlink

FileSystemManager.unlink(Object object)

删除文件。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.unlink({
  filePath: 'internal://cache/demo.png',
  success: () => {
    console.info('unlink success');
  },
  fail: (err) => {
    console.error('unlink fail', err);
  },
  complete: (res) => {
    console.info('unlink complete', res);
  }
});

FileSystemManager.unlinkSync

FileSystemManager.unlinkSync(string filePath): void

同步删除文件。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.unlinkSync('internal://cache/demo.png');

FileSystemManager.unzip

FileSystemManager.unzip(Object object)

解压文件。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.unzip({
  zipFilePath: 'internal://cache/example.zip',
  targetPath: 'internal://cache/example',
  success: () => {
    console.info('unzip success');
  },
  fail: (err) => {
    console.error('unzip fail', err);
  },
  complete: (res) => {
    console.info('unzip complete', res);
  }
});

FileSystemManager.writeFile

FileSystemManager.writeFile(Object object)

写文件。

起始版本： 1.0.4

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
fileSystemManager.writeFile({
  filePath: 'internal://cache/demo.txt',
  data: '写入文本',
  encoding: 'utf-8',
  success: () => {
    console.info('writeFile success');
  },
  fail: (err) => {
    console.error('writeFile fail', err);
  },
  complete: (res) => {
    console.info('writeFile complete', res);
  }
});

FileSystemManager.writeFileSync

FileSystemManager.writeFileSync(string filePath, string|ArrayBuffer data, string encoding): void

同步写文件。

起始版本： 1.0.4

参数：

错误码信息：

示例：

const fileSystemManager = has.getFileSystemManager();
try {
  fileSystemManager.writeFileSync('internal://cache/demo.txt', '写入文本', 'utf-8');
} catch (err) {
  console.error('writeFileSync error', err);
}