mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 17:31:12 +00:00
358 lines
12 KiB
TypeScript
358 lines
12 KiB
TypeScript
/*
|
|
* Copyright (c) 2022 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License"),
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { AsyncCallback, Callback } from "./basic";
|
|
import Want from './@ohos.application.Want';
|
|
import Context from './application/Context';
|
|
import { Filter } from './@ohos.fileio';
|
|
|
|
/**
|
|
* This module provides the capability to access user public files.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
*/
|
|
declare namespace fileAccess {
|
|
/**
|
|
* Query the want information of HAP configured with fileaccess.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @return Returns the wants.
|
|
*/
|
|
function getFileAccessAbilityInfo(callback: AsyncCallback<Array<Want>>): void;
|
|
function getFileAccessAbilityInfo(): Promise<Array<Want>>;
|
|
|
|
/**
|
|
* Obtains the fileAccessHelper that connects all fileaccess servers in the system.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param context Indicates the application context.
|
|
* @return Returns the fileAccessHelper.
|
|
*/
|
|
function createFileAccessHelper(context: Context): FileAccessHelper;
|
|
|
|
/**
|
|
* Obtains the fileAccessHelper that connects some specified fileaccess servers in the system.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
|
|
* @param context Indicates the application context.
|
|
* @param want Represents the connected data provider.
|
|
* @return Returns the fileAccessHelper.
|
|
*/
|
|
function createFileAccessHelper(context: Context, wants: Array<Want>): FileAccessHelper;
|
|
|
|
/**
|
|
* File Object
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Indicates the path of the file.
|
|
* @param fileName Indicates the name of the file.
|
|
* @param mode Indicates the mode of the file.
|
|
* @param size Indicates the size of the file.
|
|
* @param mtime Indicates the mtime of the file.
|
|
* @param mimeType Indicates the mimeType of the file.
|
|
*/
|
|
interface FileInfo {
|
|
/**
|
|
* @type {string}
|
|
* @readonly
|
|
*/
|
|
uri: string;
|
|
/**
|
|
* @type {string}
|
|
* @readonly
|
|
*/
|
|
fileName: string;
|
|
/**
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
mode: number;
|
|
/**
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
size: number;
|
|
/**
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
mtime: number;
|
|
/**
|
|
* @type {string}
|
|
* @readonly
|
|
*/
|
|
mimeType: string;
|
|
|
|
/**
|
|
* List files in the current directory.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param filter Indicates the filter of file.
|
|
* @return Returns the FileIterator Object.
|
|
*/
|
|
listFile(filter?: Filter): FileIterator;
|
|
|
|
/**
|
|
* Recursively list all files in the current directory.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param filter Indicates the filter of file.
|
|
* @return Returns the FileIterator Object.
|
|
*/
|
|
scanFile(filter?: Filter): FileIterator;
|
|
}
|
|
|
|
/**
|
|
* FileIterator Object
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
*/
|
|
interface FileIterator {
|
|
next(): {value: FileInfo, done: boolean}
|
|
}
|
|
|
|
/**
|
|
* Root Object
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
*/
|
|
interface RootInfo {
|
|
/**
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
deviceType: number;
|
|
/**
|
|
* @type {string}
|
|
* @readonly
|
|
*/
|
|
uri: string;
|
|
/**
|
|
* @type {string}
|
|
* @readonly
|
|
*/
|
|
displayName: string;
|
|
/**
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
deviceFlags: number;
|
|
|
|
/**
|
|
* List files in the current directory.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param filter Indicates the filter of file.
|
|
* @return Returns the RootIterator Object.
|
|
*/
|
|
listFile(filter?: Filter): FileIterator;
|
|
|
|
/**
|
|
* Recursively list all files in the current directory.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param filter Indicates the filter of file.
|
|
* @return Returns the RootIterator Object.
|
|
*/
|
|
scanFile(filter?: Filter): FileIterator;
|
|
}
|
|
|
|
/**
|
|
* RootIterator Object
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
*/
|
|
interface RootIterator {
|
|
next(): {value: RootInfo, done: boolean}
|
|
}
|
|
|
|
/**
|
|
* OPENFLAGS represents the way to open the file.
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
*/
|
|
enum OPENFLAGS {
|
|
/** file is openFile only_read */
|
|
READ = 0o0,
|
|
/** file is openFile only_write */
|
|
WRITE = 0o1,
|
|
/** file is openFile write_read */
|
|
WRITE_READ = 0o2
|
|
}
|
|
|
|
/**
|
|
* FileAccessHelper Object
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
*/
|
|
interface FileAccessHelper {
|
|
/**
|
|
* Open a file.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Indicates the path of the file to open.
|
|
* @param flags Indicate options of opening a file. The default value is read-only.
|
|
* @return Returns the file descriptor.
|
|
*/
|
|
openFile(uri: string, flags: OPENFLAGS) : Promise<number>;
|
|
openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback<number>) : void;
|
|
|
|
/**
|
|
* Create a file.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Represents a specific parent directory.
|
|
* @param displayName Indicates the new file name, and supports with suffix.
|
|
* @return Returns the new file's URI.
|
|
*/
|
|
createFile(uri: string, displayName: string) : Promise<string>;
|
|
createFile(uri: string, displayName: string, callback: AsyncCallback<string>) : void;
|
|
|
|
/**
|
|
* Create a Directory.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param parentUri Represents a specific parent directory.
|
|
* @param displayName Indicates the new directory name.
|
|
* @return Returns the new directory's URI.
|
|
*/
|
|
mkDir(parentUri: string, displayName: string) : Promise<string>;
|
|
mkDir(parentUri: string, displayName: string, callback: AsyncCallback<string>) : void;
|
|
|
|
/**
|
|
* Delete a file or delete a directory recursively.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Indicates the file or directory to be deleted.
|
|
*/
|
|
delete(uri: string) : Promise<number>;
|
|
delete(uri: string, callback: AsyncCallback<number>) : void;
|
|
|
|
/**
|
|
* Move a file or move a directory recursively.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param sourceFile Indicates the file or directory to be moved.
|
|
* @param destFile Represents the destonation folder.
|
|
* @return Returns the generated new file or directory.
|
|
*/
|
|
move(sourceFile: string, destFile: string) : Promise<string>;
|
|
move(sourceFile: string, destFile: string, callback: AsyncCallback<string>) : void;
|
|
|
|
/**
|
|
* Rename the selected file or directory.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Indicates the selected file or directory.
|
|
* @param displayName Indicates the new directory or file name.
|
|
* @return Returns a URI representing the new file or directory.
|
|
*/
|
|
rename(uri: string, displayName: string) : Promise<string>;
|
|
rename(uri: string, displayName: string, callback: AsyncCallback<string>) : void;
|
|
|
|
/**
|
|
* Obtain the status of a file or directory.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @param uri Indicates the selected file or directory.
|
|
* @return Returns whether it exists.
|
|
*/
|
|
access(sourceFileUri: string) : Promise<boolean>;
|
|
access(sourceFileUri: string, callback: AsyncCallback<boolean>) : void;
|
|
|
|
/**
|
|
* Get a RootIterator.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.FileManagement.UserFileService
|
|
* @StageModelOnly
|
|
* @systemapi
|
|
* @permission ohos.permission.FILE_ACCESS_MANAGER
|
|
* @return Returns a RootIterator.
|
|
*/
|
|
getRoots(): Promise<RootIterator>;
|
|
getRoots(callback:AsyncCallback<RootIterator>) : void;
|
|
}
|
|
}
|
|
|
|
export default fileAccess;
|