mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
bugfix_jsdoc
Signed-off-by: 18721213663 <zhuhongtao12@huawei.com>
This commit is contained in:
18721213663
parent
42e3a283d4
commit
3d402f5f4d
124
api/@ohos.file.fs.d.ts
vendored
124
api/@ohos.file.fs.d.ts
vendored
@ -318,7 +318,7 @@ declare function access(path: string): Promise<boolean>;
|
||||
* Access file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<boolean> } [callback] - The callback is used to return the file is accessible or not.
|
||||
* @param { AsyncCallback<boolean> } callback - The callback is used to return the file is accessible or not.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -338,7 +338,7 @@ declare function access(path: string): Promise<boolean>;
|
||||
* Access file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<boolean> } [callback] - The callback is used to return the file is accessible or not.
|
||||
* @param { AsyncCallback<boolean> } callback - The callback is used to return the file is accessible or not.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -435,7 +435,7 @@ declare function close(file: number | File): Promise<void>;
|
||||
* Close file or fd.
|
||||
*
|
||||
* @param { number | File } file - file object or fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -449,7 +449,7 @@ declare function close(file: number | File): Promise<void>;
|
||||
* Close file or fd.
|
||||
*
|
||||
* @param { number | File } file - file object or fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -525,7 +525,7 @@ declare function copyDir(src: string, dest: string, mode?: number): Promise<void
|
||||
*
|
||||
* @param { string } src - source path.
|
||||
* @param { string } dest - destination path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -567,7 +567,7 @@ declare function copyDir(src: string, dest: string, callback: AsyncCallback<void
|
||||
* @param { string } src - source path.
|
||||
* @param { string } dest - destination path.
|
||||
* @param { number } mode - mode.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -694,7 +694,7 @@ declare function copyFile(src: string | number, dest: string | number, mode?: nu
|
||||
*
|
||||
* @param { string | number } src - src.
|
||||
* @param { string | number } dest - dest.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -720,7 +720,7 @@ declare function copyFile(src: string | number, dest: string | number, mode?: nu
|
||||
*
|
||||
* @param { string | number } src - src.
|
||||
* @param { string | number } dest - dest.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -750,7 +750,7 @@ declare function copyFile(src: string | number, dest: string | number, callback:
|
||||
* @param { string | number } src - src.
|
||||
* @param { string | number } dest - dest.
|
||||
* @param { number } [mode = 0] - mode.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -777,7 +777,7 @@ declare function copyFile(src: string | number, dest: string | number, callback:
|
||||
* @param { string | number } src - src.
|
||||
* @param { string | number } dest - dest.
|
||||
* @param { number } [mode = 0] - mode.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -903,7 +903,7 @@ declare function createStream(path: string, mode: string): Promise<Stream>;
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { string } mode - mode.
|
||||
* @param { AsyncCallback<Stream> } [callback] - callback.
|
||||
* @param { AsyncCallback<Stream> } callback - callback.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -1014,7 +1014,7 @@ declare function createRandomAccessFile(file: string | File, mode?: number): Pro
|
||||
* Create class RandomAccessFile.
|
||||
*
|
||||
* @param { string | File } file - file path, object.
|
||||
* @param { AsyncCallback<RandomAccessFile> } [callback] - The callback is used to return the RandomAccessFile object which has been created.
|
||||
* @param { AsyncCallback<RandomAccessFile> } callback - The callback is used to return the RandomAccessFile object which has been created.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -1051,7 +1051,7 @@ declare function createRandomAccessFile(file: string | File, callback: AsyncCall
|
||||
*
|
||||
* @param { string | File } file - file path, object.
|
||||
* @param { number } [mode = OpenMode.READ_ONLY] - mode.
|
||||
* @param { AsyncCallback<RandomAccessFile> } [callback] - The callback is used to return the RandomAccessFile object which has been created.
|
||||
* @param { AsyncCallback<RandomAccessFile> } callback - The callback is used to return the RandomAccessFile object which has been created.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -1199,7 +1199,7 @@ declare function fdatasync(fd: number): Promise<void>;
|
||||
* Synchronize file metadata.
|
||||
*
|
||||
* @param { number } fd - fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
* @throws { BusinessError } 13900020 - Invalid argument
|
||||
@ -1214,7 +1214,7 @@ declare function fdatasync(fd: number): Promise<void>;
|
||||
* Synchronize file metadata.
|
||||
*
|
||||
* @param { number } fd - fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
* @throws { BusinessError } 13900020 - Invalid argument
|
||||
@ -1302,7 +1302,7 @@ declare function fdopenStream(fd: number, mode: string): Promise<Stream>;
|
||||
*
|
||||
* @param { number } fd - fd.
|
||||
* @param { string } mode - mode.
|
||||
* @param { AsyncCallback<Stream> } [callback] - The callback is used to return the Stream object.
|
||||
* @param { AsyncCallback<Stream> } callback - The callback is used to return the Stream object.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -1410,7 +1410,7 @@ declare function fsync(fd: number): Promise<void>;
|
||||
* Synchronize file.
|
||||
*
|
||||
* @param { number } fd - fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
* @throws { BusinessError } 13900020 - Invalid argument
|
||||
@ -1425,7 +1425,7 @@ declare function fsync(fd: number): Promise<void>;
|
||||
* Synchronize file.
|
||||
*
|
||||
* @param { number } fd - fd.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
* @throws { BusinessError } 13900020 - Invalid argument
|
||||
@ -1644,7 +1644,7 @@ declare function lstat(path: string): Promise<Stat>;
|
||||
* Stat link file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<Stat> } [callback] - The callback is used to return the Stat object.
|
||||
* @param { AsyncCallback<Stat> } callback - The callback is used to return the Stat object.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
* @throws { BusinessError } 13900011 - Out of memory
|
||||
@ -1733,7 +1733,7 @@ declare function mkdir(path: string): Promise<void>;
|
||||
* Make dir.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -1756,7 +1756,7 @@ declare function mkdir(path: string): Promise<void>;
|
||||
* Make dir.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -1878,7 +1878,7 @@ declare function mkdtemp(prefix: string): Promise<string>;
|
||||
* Make temp dir.
|
||||
*
|
||||
* @param { string } prefix - dir prefix.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the path to the new directory.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the path to the new directory.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -1901,7 +1901,7 @@ declare function mkdtemp(prefix: string): Promise<string>;
|
||||
* Make temp dir.
|
||||
*
|
||||
* @param { string } prefix - dir prefix.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the path to the new directory.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the path to the new directory.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -2434,7 +2434,7 @@ declare function open(path: string, mode?: number): Promise<File>;
|
||||
* Open file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<File> } [callback] - The callback is used to return the File object to record the file descriptor.
|
||||
* @param { AsyncCallback<File> } callback - The callback is used to return the File object to record the file descriptor.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -2468,7 +2468,7 @@ declare function open(path: string, mode?: number): Promise<File>;
|
||||
* Open file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<File> } [callback] - The callback is used to return the File object to record the file descriptor.
|
||||
* @param { AsyncCallback<File> } callback - The callback is used to return the File object to record the file descriptor.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -2506,7 +2506,7 @@ declare function open(path: string, callback: AsyncCallback<File>): void;
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { number } [mode = OpenMode.READ_ONLY] - mode.
|
||||
* @param { AsyncCallback<File> } [callback] - The callback is used to return the File object to record the file descriptor.
|
||||
* @param { AsyncCallback<File> } callback - The callback is used to return the File object to record the file descriptor.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -2541,7 +2541,7 @@ declare function open(path: string, callback: AsyncCallback<File>): void;
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { number } [mode = OpenMode.READ_ONLY] - mode.
|
||||
* @param { AsyncCallback<File> } [callback] - The callback is used to return the File object to record the file descriptor.
|
||||
* @param { AsyncCallback<File> } callback - The callback is used to return the File object to record the file descriptor.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -2700,7 +2700,7 @@ declare function read(
|
||||
*
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -2718,7 +2718,7 @@ declare function read(
|
||||
*
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -2740,7 +2740,7 @@ declare function read(fd: number, buffer: ArrayBuffer, callback: AsyncCallback<n
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -2759,7 +2759,7 @@ declare function read(fd: number, buffer: ArrayBuffer, callback: AsyncCallback<n
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -2889,7 +2889,7 @@ declare function readText(
|
||||
* Read text.
|
||||
*
|
||||
* @param { string } filePath - file path.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the contents of the read file.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the contents of the read file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -2910,7 +2910,7 @@ declare function readText(
|
||||
* Read text.
|
||||
*
|
||||
* @param { string } filePath - file path.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the contents of the read file.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the contents of the read file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -2935,7 +2935,7 @@ declare function readText(filePath: string, callback: AsyncCallback<string>): vo
|
||||
*
|
||||
* @param { string } filePath - file path.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the contents of the read file.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the contents of the read file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -2957,7 +2957,7 @@ declare function readText(filePath: string, callback: AsyncCallback<string>): vo
|
||||
*
|
||||
* @param { string } filePath - file path.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<string> } [callback] - The callback is used to return the contents of the read file.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the contents of the read file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3103,7 +3103,7 @@ declare function rename(oldPath: string, newPath: string): Promise<void>;
|
||||
*
|
||||
* @param { string } oldPath - oldPath.
|
||||
* @param { string } newPath - newPath.
|
||||
* @param { AsyncCallback<void> } [callback] - Returns the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Returns the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -3131,7 +3131,7 @@ declare function rename(oldPath: string, newPath: string): Promise<void>;
|
||||
*
|
||||
* @param { string } oldPath - oldPath.
|
||||
* @param { string } newPath - newPath.
|
||||
* @param { AsyncCallback<void> } [callback] - Returns the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Returns the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -3261,7 +3261,7 @@ declare function rmdir(path: string): Promise<void>;
|
||||
* Delete dir.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900011 - Out of memory
|
||||
@ -3281,7 +3281,7 @@ declare function rmdir(path: string): Promise<void>;
|
||||
* Delete dir.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900011 - Out of memory
|
||||
@ -3390,7 +3390,7 @@ declare function stat(file: string | number): Promise<Stat>;
|
||||
* Get file information.
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { AsyncCallback<Stat> } [callback] - The callback is used to return the Stat object.
|
||||
* @param { AsyncCallback<Stat> } callback - The callback is used to return the Stat object.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3411,7 +3411,7 @@ declare function stat(file: string | number): Promise<Stat>;
|
||||
* Get file information.
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { AsyncCallback<Stat> } [callback] - The callback is used to return the Stat object.
|
||||
* @param { AsyncCallback<Stat> } callback - The callback is used to return the Stat object.
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3506,7 +3506,7 @@ declare function symlink(target: string, srcPath: string): Promise<void>;
|
||||
*
|
||||
* @param { string } target - target.
|
||||
* @param { string } srcPath - srcPath.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3607,7 +3607,7 @@ declare function truncate(file: string | number, len?: number): Promise<void>;
|
||||
* Truncate file.
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -3631,7 +3631,7 @@ declare function truncate(file: string | number, len?: number): Promise<void>;
|
||||
* Truncate file.
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -3659,7 +3659,7 @@ declare function truncate(file: string | number, callback: AsyncCallback<void>):
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { number } [len = 0] - len.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -3684,7 +3684,7 @@ declare function truncate(file: string | number, callback: AsyncCallback<void>):
|
||||
*
|
||||
* @param { string | number } file - path or file descriptor.
|
||||
* @param { number } [len = 0] - len.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
@ -3811,7 +3811,7 @@ declare function unlink(path: string): Promise<void>;
|
||||
* Delete file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3834,7 +3834,7 @@ declare function unlink(path: string): Promise<void>;
|
||||
* Delete file.
|
||||
*
|
||||
* @param { string } path - path.
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900002 - No such file or directory
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3963,7 +3963,7 @@ declare function write(
|
||||
*
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -3984,7 +3984,7 @@ declare function write(
|
||||
*
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4009,7 +4009,7 @@ declare function write(fd: number, buffer: ArrayBuffer | string, callback: Async
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4031,7 +4031,7 @@ declare function write(fd: number, buffer: ArrayBuffer | string, callback: Async
|
||||
* @param { number } fd - file descriptor.
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4338,7 +4338,7 @@ declare interface RandomAccessFile {
|
||||
* Write randomAccessFile.
|
||||
*
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4361,7 +4361,7 @@ declare interface RandomAccessFile {
|
||||
*
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of bytes written to the file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of bytes written to the file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4446,7 +4446,7 @@ declare interface RandomAccessFile {
|
||||
* Read randomAccessFile.
|
||||
*
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -4466,7 +4466,7 @@ declare interface RandomAccessFile {
|
||||
*
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -4847,7 +4847,7 @@ declare interface Stream {
|
||||
/**
|
||||
* Close stream.
|
||||
*
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -4896,7 +4896,7 @@ declare interface Stream {
|
||||
/**
|
||||
* Flush stream.
|
||||
*
|
||||
* @param { AsyncCallback<void> } [callback] - Return the callback function.
|
||||
* @param { AsyncCallback<void> } callback - Return the callback function.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4966,7 +4966,7 @@ declare interface Stream {
|
||||
* Write stream.
|
||||
*
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes written to file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes written to file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -4989,7 +4989,7 @@ declare interface Stream {
|
||||
*
|
||||
* @param { ArrayBuffer | string } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes written to file.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes written to file.
|
||||
* @throws { BusinessError } 13900001 - Operation not permitted
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
@ -5073,7 +5073,7 @@ declare interface Stream {
|
||||
* Read stream.
|
||||
*
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
@ -5093,7 +5093,7 @@ declare interface Stream {
|
||||
*
|
||||
* @param { ArrayBuffer } buffer - buffer.
|
||||
* @param { object } [options] - options.
|
||||
* @param { AsyncCallback<number> } [callback] - The callback is used to return the number of file bytes read to buffer.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the number of file bytes read to buffer.
|
||||
* @throws { BusinessError } 13900004 - Interrupted system call
|
||||
* @throws { BusinessError } 13900005 - I/O error
|
||||
* @throws { BusinessError } 13900008 - Bad file descriptor
|
||||
|
||||
80
api/@ohos.file.storageStatistics.d.ts
vendored
80
api/@ohos.file.storageStatistics.d.ts
vendored
@ -16,7 +16,7 @@
|
||||
import { AsyncCallback, Callback } from './@ohos.base';
|
||||
|
||||
/**
|
||||
* Provides filesystem statistics APIs
|
||||
* Provides filesystem statistics APIs.
|
||||
*
|
||||
* @namespace storageStatistics
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
@ -24,7 +24,7 @@ import { AsyncCallback, Callback } from './@ohos.base';
|
||||
*/
|
||||
declare namespace storageStatistics {
|
||||
/**
|
||||
* Get the totalSize of volume.
|
||||
* Get the total size of volume.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } volumeUuid - The uuid of the volume
|
||||
@ -34,7 +34,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 8
|
||||
@ -42,7 +42,7 @@ declare namespace storageStatistics {
|
||||
function getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
* Get the totalSize of volume.
|
||||
* Get the total size of volume.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } volumeUuid - The uuid of the volume
|
||||
@ -52,14 +52,14 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 8
|
||||
*/
|
||||
function getTotalSizeOfVolume(volumeUuid: string): Promise<number>;
|
||||
/**
|
||||
* Get the free size Of volume.
|
||||
* Get the free size of volume.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } volumeUuid - The uuid of the volume
|
||||
@ -69,7 +69,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 8
|
||||
@ -77,7 +77,7 @@ declare namespace storageStatistics {
|
||||
function getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
* Get the free size Of volume.
|
||||
* Get the free size of volume.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } volumeUuid - The uuid of the volume
|
||||
@ -87,7 +87,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 8
|
||||
@ -95,7 +95,7 @@ declare namespace storageStatistics {
|
||||
function getFreeSizeOfVolume(volumeUuid: string): Promise<number>;
|
||||
|
||||
/**
|
||||
* Get the bundlestat
|
||||
* Get the bundle statistics.
|
||||
*
|
||||
* @interface BundleStats
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
@ -127,7 +127,7 @@ declare namespace storageStatistics {
|
||||
dataSize: number;
|
||||
}
|
||||
/**
|
||||
* Get the bundlestat
|
||||
* Get the bundle statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } packageName - The name of the application
|
||||
@ -137,7 +137,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -145,7 +145,7 @@ declare namespace storageStatistics {
|
||||
function getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>): void;
|
||||
|
||||
/**
|
||||
* Get the bundlestat
|
||||
* Get the bundle statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { string } packageName - The name of the application
|
||||
@ -155,7 +155,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -163,31 +163,31 @@ declare namespace storageStatistics {
|
||||
function getBundleStats(packageName: string): Promise<BundleStats>;
|
||||
|
||||
/**
|
||||
* Get the Current BundleStats
|
||||
* Get the current bundle statistics.
|
||||
*
|
||||
* @param { AsyncCallback<BundleStats> } callback - callback
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @since 9
|
||||
*/
|
||||
function getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void;
|
||||
|
||||
/**
|
||||
* Get the Current BundleStats
|
||||
* Get the current bundle statistics.
|
||||
*
|
||||
* @returns { Promise<BundleStats> } return Promise
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @since 9
|
||||
*/
|
||||
function getCurrentBundleStats(): Promise<BundleStats>;
|
||||
|
||||
/**
|
||||
* Get the systemsize
|
||||
* Get the system size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { AsyncCallback<number> } callback - callback
|
||||
@ -195,7 +195,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -203,7 +203,7 @@ declare namespace storageStatistics {
|
||||
function getSystemSize(callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
* Get the systemsize
|
||||
* Get the system size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @returns { Promise<number> } return Promise
|
||||
@ -211,7 +211,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -219,7 +219,7 @@ declare namespace storageStatistics {
|
||||
function getSystemSize(): Promise<number>;
|
||||
|
||||
/**
|
||||
* Get the UserStorageStats
|
||||
* Get the user storage statistics.
|
||||
*
|
||||
* @interface StorageStats
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
@ -283,7 +283,7 @@ declare namespace storageStatistics {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the UserStorageStats
|
||||
* Get the user storage statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @returns { Promise<StorageStats> } return Promise
|
||||
@ -291,7 +291,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -299,7 +299,7 @@ declare namespace storageStatistics {
|
||||
function getUserStorageStats(): Promise<StorageStats>;
|
||||
|
||||
/**
|
||||
* Get the UserStorageStats
|
||||
* Get the user storage statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { AsyncCallback<StorageStats> } callback - callback
|
||||
@ -307,7 +307,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -315,7 +315,7 @@ declare namespace storageStatistics {
|
||||
function getUserStorageStats(callback: AsyncCallback<StorageStats>): void;
|
||||
|
||||
/**
|
||||
* Get the UserStorageStats
|
||||
* Get the user storage statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { number } userId - The id of the user
|
||||
@ -325,7 +325,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600009 - User if out of range.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -333,7 +333,7 @@ declare namespace storageStatistics {
|
||||
function getUserStorageStats(userId: number): Promise<StorageStats>;
|
||||
|
||||
/**
|
||||
* Get the UserStorageStats
|
||||
* Get the user storage statistics.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { number } userId - The id of the user
|
||||
@ -343,7 +343,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600009 - User if out of range.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -351,7 +351,7 @@ declare namespace storageStatistics {
|
||||
function getUserStorageStats(userId: number, callback: AsyncCallback<StorageStats>): void;
|
||||
|
||||
/**
|
||||
* Get the totalsize
|
||||
* Get the total size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { AsyncCallback<number> } callback - callback
|
||||
@ -359,7 +359,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -367,7 +367,7 @@ declare namespace storageStatistics {
|
||||
function getTotalSize(callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
* Get the totalsize
|
||||
* Get the total size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @returns { Promise<number> } return Promise
|
||||
@ -375,7 +375,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -399,7 +399,7 @@ declare namespace storageStatistics {
|
||||
function getTotalSizeSync(): number;
|
||||
|
||||
/**
|
||||
* Get the freesize
|
||||
* Get the free size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @param { AsyncCallback<number> } callback - callback
|
||||
@ -407,7 +407,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -415,7 +415,7 @@ declare namespace storageStatistics {
|
||||
function getFreeSize(callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
* Get the freesize
|
||||
* Get the free size.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @returns { Promise<number> } return Promise
|
||||
@ -423,7 +423,7 @@ declare namespace storageStatistics {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -431,7 +431,7 @@ declare namespace storageStatistics {
|
||||
function getFreeSize(): Promise<number>;
|
||||
|
||||
/**
|
||||
* Get the free size with sync interface
|
||||
* Get the free size with sync interface.
|
||||
*
|
||||
* @permission ohos.permission.STORAGE_MANAGER
|
||||
* @returns { number } return the free size
|
||||
|
||||
32
api/@ohos.file.volumeManager.d.ts
vendored
32
api/@ohos.file.volumeManager.d.ts
vendored
@ -105,7 +105,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -121,7 +121,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 202 - The caller is not a system application.
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -142,7 +142,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600003 - Failed to mount.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -163,7 +163,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600003 - Failed to mount.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -184,7 +184,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600004 - Failed to unmount.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -205,7 +205,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600004 - Failed to unmount.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -223,7 +223,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -241,7 +241,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -259,7 +259,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -277,7 +277,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -298,7 +298,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600002 - Not supported filesystem.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -319,7 +319,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600002 - Not supported filesystem.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -340,7 +340,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600002 - Not supported filesystem.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -361,7 +361,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 13600002 - Not supported filesystem.
|
||||
* @throws { BusinessError } 13600005 - Incorrect volume state.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -380,7 +380,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
@ -399,7 +399,7 @@ declare namespace volumeManager {
|
||||
* @throws { BusinessError } 401 - The input parameter is invalid.
|
||||
* @throws { BusinessError } 13600001 - IPC error.
|
||||
* @throws { BusinessError } 13600008 - No such object.
|
||||
* @throws { BusinessError } 13900032 - Unknown error.
|
||||
* @throws { BusinessError } 13900042 - Unknown error.
|
||||
* @syscap SystemCapability.FileManagement.StorageService.Volume
|
||||
* @systemapi
|
||||
* @since 9
|
||||
|
||||
Loading…
Reference in New Issue
Block a user