@ohos.file.trash (Trash)

The file.trash module provides APIs for querying, recovering, or permanently deleting the files or folders in Recently deleted (trash). Currently, only local files and folders are supported.

You can use delete() of @ohos.file.fileAccess to move a file or folder to the trash.

NOTE

• The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• The APIs of this module are system APIs and can be called only by the file manager.

Modules to Import

import trash from '@ohos.file.trash';

trash.listFile

listFile(): Array<FileInfo>

Lists the files and folders in the Recently deleted list.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

let fileinfos = trash.listFile();
for(let i = 0; i < fileinfos.length; i++){
  console.info('uri: ' + fileinfos[i].uri);
  console.info('srcPath: ' + fileinfos[i].srcPath);
  console.info('fileName: ' + fileinfos[i].fileName);
  console.info('mode: ' + fileinfos[i].mode);
  console.info('size: ' + fileinfos[i].size);
  console.info('mtime: ' + fileinfos[i].mtime);
  console.info('ctime: ' + fileinfos[i].ctime);
}

trash.recover

recover(uri: string): void;

Recovers a file or folder from the trash.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

let fileinfos = trash.listFile();
let uri = fileinfos[0].uri;
trash.recover(uri);

trash.completelyDelete

completelyDelete(uri: string): void

Permanently deletes a file or folder from the Recently deleted list.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService

Required permissions: ohos.permission.FILE_ACCESS_MANAGER

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

let fileinfos = trash.listFile();
let uri = fileinfos[0].uri;
trash.completelyDelete(uri);

FileInfo

Represents information about a file or folder in the Recently deleted list.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.FileManagement.UserFileService