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