• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.file.recent (最近访问列表)(系统接口)
2<!--Kit: Core File Kit-->
3<!--Subsystem: FileManagement-->
4<!--Owner: @wang_zhangjun; @zhuangzhuang-->
5<!--Designer: @wang_zhangjun; @zhuangzhuang; @renguang1116-->
6<!--Tester: @liuhonggang123; @yue-ye2; @juxiaopang-->
7<!--Adviser: @foryourself-->
8
9该模块提供最近访问列表插入、移除、查询等常用能力。
10
11>**说明:**
12>
13> - 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14> - 本模块为系统接口。
15> - 当前只支持文件管理器调用。
16
17## 导入模块
18
19```js
20import recent from '@ohos.file.recent';
21```
22
23## recent.add
24
25add(uri: string): void
26
27将uri对应的文件加入最近访问列表。
28
29**模型约束**:此接口仅可在Stage模型下使用。
30
31**系统能力**:SystemCapability.FileManagement.UserFileService
32
33**需要权限**:ohos.permission.FILE_ACCESS_MANAGER
34
35**系统接口**:此接口为系统接口。
36
37**参数:**
38
39| 参数名 | 类型   | 必填 | 说明                       |
40| ------ | ------ | ---- | -------------------------- |
41| uri   | string | 是   | 公共目录文件类URI。 |
42
43**错误码:**
44
45接口抛出错误码的详细介绍请参见[文件管理错误码](errorcode-filemanagement.md)。
46
47**示例:**
48
49  ```js
50  let uri = 'file://docs/storage/Users/currentUser/<publicPath>';
51  recent.add(uri);
52  ```
53
54## recent.remove
55
56remove(uri: string): void
57
58将uri对应的文件从最近访问列表中移除。
59
60**模型约束**:此接口仅可在Stage模型下使用。
61
62**系统能力**:SystemCapability.FileManagement.UserFileService
63
64**需要权限**:ohos.permission.FILE_ACCESS_MANAGER
65
66**系统接口**:此接口为系统接口。
67
68**参数:**
69
70| 参数名 | 类型   | 必填 | 说明                       |
71| ------ | ------ | ---- | -------------------------- |
72| uri   | string | 是   | 公共目录文件类URI。 |
73
74**错误码:**
75
76接口抛出错误码的详细介绍请参见[文件管理错误码](errorcode-filemanagement.md)。
77
78**示例:**
79
80  ```js
81  let uri = 'file://docs/storage/Users/currentUser/<publicPath>';
82  recent.remove(uri);
83  ```
84
85## recent.listFile
86
87listFile(): Array\<FileInfo>
88
89查询最近访问列表中文件信息。
90
91**模型约束**:此接口仅可在Stage模型下使用。
92
93**系统能力**:SystemCapability.FileManagement.UserFileService
94
95**需要权限**:ohos.permission.FILE_ACCESS_MANAGER
96
97**系统接口**:此接口为系统接口。
98
99**返回值:**
100
101  | 类型 | 说明 |
102  | --- | -- |
103  |  Array<[FileInfo](#fileinfo)> | FileInfo数组。 |
104
105**错误码:**
106
107接口抛出错误码的详细介绍请参见[文件管理错误码](errorcode-filemanagement.md)。
108
109**示例:**
110
111  ```js
112  let fileinfos = recent.listFile();
113  for(let i = 0; i < fileinfos.length; i++){
114    console.info('uri: ' + fileinfos[i].uri);
115    console.info('srcPath: ' + fileinfos[i].srcPath);
116    console.info('fileName: ' + fileinfos[i].fileName);
117    console.info('mode: ' + fileinfos[i].mode);
118    console.info('size: ' + fileinfos[i].size);
119    console.info('mtime: ' + fileinfos[i].mtime);
120    console.info('ctime: ' + fileinfos[i].ctime);
121  }
122  ```
123
124## FileInfo
125
126最近访问列表文件信息。
127
128**模型约束**:此接口仅可在Stage模型下使用。
129
130**系统能力**:SystemCapability.FileManagement.UserFileService
131
132| 名称 | 类型   | 只读 | 可选 | 说明     |
133| ------ | ------ | -------- | ------ | -------- |
134| uri | string | 是 | 否 | 文件URI。 |
135| srcPath | string | 是 | 否 | 文件路径。 |
136| fileName | string | 是 | 否 | 文件名。 |
137| mode | number | 是 | 否 | [文件权限信息](js-apis-file-fs.md#stat)。 |
138| size | number | 是 | 否 |  文件的大小(单位:字节)。 |
139| mtime | number | 是 | 否 |  文件的修改时间。 |
140| ctime | number | 是 | 否 |  文件的创建时间。 |
141