文件模块

数据结构

无

接口

`newFile`

该方法创建文件。

完整方法声明：function newFile(pathname: string): Promise<number>

参数：

参数	描述	类型	非空
pathname	文件路径	`string`	是

返回值：

属性	描述	类型	默认值
无	文件唯一标识符	`Promise<number>`

`getFileId`

该方法获取文件唯一标识符。

完整方法声明：function getFileId(): number

参数：

无

返回值：

属性	描述	类型	默认值
无	文件唯一标识符	`number`

`getName`

该方法获取文件名。

完整方法声明：function getName(): Promise<string>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件名	`Promise<string>`

`getParent`

该方法获取文件父目录。

完整方法声明：function getParent(): Promise<string>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件父目录	`Promise<string>`

`getPath`

该方法获取文件目录。

完整方法声明：function getPath(): Promise<string>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件目录	`Promise<string>`

`isAbsolute`

该方法获取抽象路径名是否是绝对路径。

完整方法声明：function isAbsolute(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	抽象路径名是否是绝对路径	`Promise<boolean>`

`getCanonicalPath`

该方法获取文件规范化的绝对路径。

完整方法声明：function getCanonicalPath(): Promise<string>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件规范化的绝对路径	`Promise<string>`

`canRead`

该方法获取文件是否可读。

完整方法声明：function canRead(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否可读	`Promise<boolean>`

`canWrite`

该方法获取文件是否可写。

完整方法声明：function canWrite(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否可写	`Promise<boolean>`

`exists`

该方法获取文件是否存在。

完整方法声明：function exists(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否存在	`Promise<boolean>`

`isDirectory`

该方法获取文件是否是目录。

完整方法声明：function isDirectory(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否是目录	`Promise<boolean>`

`isFile`

该方法获取文件是否是文件。

完整方法声明：function isFile(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否是文件	`Promise<boolean>`

`isHidden`

该方法获取文件是否是隐藏文件。

完整方法声明：function isHidden(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否是隐藏文件	`Promise<boolean>`

`lastModified`

该方法获取文件最近修改日期。

完整方法声明：function lastModified(): Promise<number>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件最近修改日期	`Promise<number>`

`length`

该方法获取文件长度。

完整方法声明：function length(): Promise<number>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件长度	`Promise<number>`

`createNewFile`

该方法创建新文件。

完整方法声明：function createNewFile(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	创建文件是否成功	`Promise<boolean>`

`deleteOnExit`

该方法判断文件是否存在，如果存在则删除。

完整方法声明：function deleteOnExit(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	删除文件是否成功	`Promise<boolean>`

`list`

该方法获取子文件列表。

完整方法声明：function list(): Promise<Array<string>>

参数：

无

返回值：

属性	描述	类型	默认值
无	子文件列表	`Promise<Array<string>>`

`mkdir`

该方法创建文件夹。

完整方法声明：function mkdir(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	创建文件夹是否成功	`Promise<boolean>`

`mkdirs`

该方法递归创建文件夹。

完整方法声明：function mkdirs(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	递归创建文件夹是否成功	`Promise<boolean>`

`setLastModified`

该方法设置文件最后更改时间。

完整方法声明：function setLastModified(time: number): Promise<boolean>

参数：

参数	描述	类型	非空
time	文件更改时间	`number`	是

返回值：

属性	描述	类型	默认值
无	设置文件最后更改时间是否成功	`Promise<boolean>`

`getTotalSpace`

该方法返回文件占用空间大小。

完整方法声明：function getTotalSpace(): Promise<number>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件占用空间大小	`Promise<number>`

`getFreeSpace`

该方法返回目录可用空间大小。

完整方法声明：function getFreeSpace(): Promise<number>

参数：

无

返回值：

属性	描述	类型	默认值
无	目录可用空间大小	`Promise<number>`

`getUsableSpace`

该方法返回目录已使用空间大小。

完整方法声明：function getUsableSpace(): Promise<number>

参数：

无

返回值：

属性	描述	类型	默认值
无	目录已使用空间大小	`Promise<number>`

`delete`

该方法删除文件。

完整方法声明：function delete(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	删除文件是否成功	`Promise<boolean>`

`setReadOnly`

该方法设置文件只读。

完整方法声明：function setReadOnly(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	设置文件只读是否成功	`Promise<boolean>`

`setWritableOwnerOnly`

该方法设置文件拥有者只能写。

完整方法声明：function setWritableOwnerOnly(writable: boolean, ownerOnly: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
writable	是否可写	`boolean`	是
ownerOnly	文件拥有者	`boolean`	是

返回值：

属性	描述	类型	默认值
无	置文件拥有者只能写否成功	`Promise<boolean>`

`setWritable`

该方法设置文件是否可写。

完整方法声明：function setWritable(writable: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
writable	是否可写	`boolean`	是

返回值：

属性	描述	类型	默认值
无	文件是否可写	`Promise<boolean>`

`setReadableOwnerOnly`

该方法设置文件拥有者只读。

完整方法声明：function setReadableOwnerOnly(readable: boolean, ownerOnly: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
readable	是否可读	`boolean`	是
ownerOnly	文件拥有者	`boolean`	是

返回值：

属性	描述	类型	默认值
无	置文件拥有者只能读否成功	`Promise<boolean>`

`setReadable`

该方法设置文件是否可读。

完整方法声明：function setReadable(readable: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
readable	是否可读	`boolean`	是

返回值：

属性	描述	类型	默认值
无	文件是否可读	`Promise<boolean>`

`setExecutableOwnerOnly`

该方法设置文件拥有者可执行。

完整方法声明：function setExecutableOwnerOnly(executable: boolean, ownerOnly: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
executable	是否可执行	`boolean`	是
ownerOnly	文件拥有者	`boolean`	是

返回值：

属性	描述	类型	默认值
无	置文件拥有者可执行是否成功	`Promise<boolean>`

`setExecutable`

该方法设置文件是否可执行。

完整方法声明：function setExecutable(executable: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
executable	是否可执行	`boolean`	是

返回值：

属性	描述	类型	默认值
无	文件是否可执行	`Promise<boolean>`

`canExecute`

该方法返回文件是否可执行。

完整方法声明：function canExecute(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	文件是否可执行	`Promise<boolean>`

`renameTo`

该方法重命名文件。

完整方法声明：function renameTo(renameFileId: number): Promise<boolean>

参数：

参数	描述	类型	非空
renameFileId	文件唯一标识符	`number`	是

返回值：

属性	描述	类型	默认值
无	重命名文件是否成功	`Promise<boolean>`

`close`

该方法关闭文件。

完整方法声明：function close(): Promise<boolean>

参数：

无

返回值：

属性	描述	类型	默认值
无	关闭文件是否成功	`Promise<boolean>`

基础用法

代码示例：

点击查看源码

TypeScript

vue

<template>
	<div class='es-sdk-root-css'>
		<s-title-view class='es-sdk-content-title-css' :text='this.$options.name' />
		<div class='es-sdk-content-divider-css' />
		<div class='es-sdk-content-column-css'>
			<div class='es-sdk-content-column-css'>
				<s-text-view text='快应用根目录下：/file.test文件操作'></s-text-view>
				<div class='es-sdk-content-row-css'>
					<s-text-button text='创建文件操作对象' @onButtonClicked='initFile' />
					<s-text-button text='创建文件' @onButtonClicked='newFile' />
					<s-text-button text='删除文件' @onButtonClicked='deleteFile' />
					<s-text-button text='是否存在' @onButtonClicked='existsFile' />
					<s-text-button text='是否是文件夹' @onButtonClicked='isDirectory' />
					<s-text-button text='是否是文件' @onButtonClicked='isFile' />
					<s-text-button text='关闭文件操作' @onButtonClicked='closeFile' />
				</div>
			</div>
			<div class='es-sdk-content-column-css'>
				<s-text-view text='扩展屏APP根目录下：/文件夹操作'></s-text-view>
				<div class='es-sdk-content-row-css'>
					<s-text-button text='创建文件夹操作对象' @onButtonClicked='initDirectory' />
					<s-text-button text='是否存在' @onButtonClicked='existsDirectory' />
					<s-text-button text='创建文件夹' @onButtonClicked='newDirectory' />
					<s-text-button text='遍历文件夹' @onButtonClicked='listDirectory' />
					<s-text-button text='关闭文件操作' @onButtonClicked='closeDirectory' />
				</div>
			</div>
		</div>
	</div>
</template>

<script lang='ts'>

import {defineComponent} from '@vue/runtime-core';
import {ESFile, useESToast} from '@extscreen/es3-core';

export default defineComponent({
	name: '文件模块',
	setup() {

		const toast = useESToast();

		let file = null;
		let directory = null;

		function initFile() {
			file = new ESFile();
			file.newFile('/file_text.test');
		}

		function newFile() {
			file.createNewFile().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function deleteFile() {
			file.delete().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function closeFile() {
			file.close().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function existsFile() {
			file.exists().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function isDirectory() {
			file.isDirectory().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function isFile() {
			file.isFile().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		//---------------------------------------------------------
		function initDirectory() {
			//
			directory = new ESFile();
			directory.newFile('/cache');
		}

		function listDirectory() {
			directory.list().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function existsDirectory() {
			directory.exists().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		function newDirectory() {
			directory.mkdirs().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('创建文件夹操作失败');
				});
		}

		function closeDirectory() {
			directory.close().then(
				(result) => {
					toast.showToast(JSON.stringify(result));
				},
				error => {
					toast.showToast('操作失败');
				});
		}

		return {
			initFile,
			newFile,
			deleteFile,
			closeFile,
			existsFile,
			isDirectory,
			isFile,
			initDirectory,
			listDirectory,
			existsDirectory,
			newDirectory,
			closeDirectory,
		};
	},
});

</script>
<style>
</style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

文件模块 ​

数据结构 ​

接口 ​

newFile ​

getFileId ​

getName ​

getParent ​

getPath ​

isAbsolute ​

getCanonicalPath ​

canRead ​

canWrite ​

exists ​

isDirectory ​

isFile ​

isHidden ​

lastModified ​

length ​

createNewFile ​

deleteOnExit ​

list ​

mkdir ​

mkdirs ​

setLastModified ​

getTotalSpace ​

getFreeSpace ​

getUsableSpace ​

delete ​

setReadOnly ​

setWritableOwnerOnly ​

setWritable ​

setReadableOwnerOnly ​

setReadable ​

setExecutableOwnerOnly ​

setExecutable ​

canExecute ​

renameTo ​

close ​

基础用法 ​