@signageos/front-applet 8.5.3 → 8.7.0

package/docs/sos/fileSystem.md

@@ -66,43 +66,16 @@ Only string can be appended to the file. If you want to append binary data, you
 ```ts expandable
 appendFile(filePath: IFilePath, contents: string): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -148,43 +121,16 @@ The `copyFile()` method creates a copy of file from `sourceFilePath` to `destina
 ```ts expandable
 copyFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options?: ICopyFileOptions): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -251,43 +197,16 @@ The `createArchive()` method creates an archive file from selected files and dir
 ```ts expandable
 createArchive(archiveFilePath: IFilePath, archiveEntries: IFilePath[]): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -354,43 +273,16 @@ The `createDirectory()` method create a new directory at specified path.
 ```ts expandable
 createDirectory(directoryPath: IFilePath): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -434,43 +326,16 @@ The `deleteFile()` method deletes the file specified by `filePath`.
 ```ts expandable
 deleteFile(filePath: IFilePath, recursive: boolean): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -557,43 +422,16 @@ The standard is supported on all following platforms:
 ```ts expandable
 downloadFile(filePath: IFilePath, sourceUri: string, headers?: IHeaders): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -647,43 +485,16 @@ The `exists()` method checks whether a file or directory exists.
 ```ts expandable
 exists(filePath: IFilePath): Promise<boolean>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -731,49 +542,19 @@ The `extractFile()` method extract (recursively) the archive file at `archiveFil
 ```ts expandable
 extractFile(archiveFilePath: IFilePath, destinationDirectoryPath: IFilePath, method: ExtractMethodType): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
-/**
- * Allowed extract method types for `extractFile()` operations.
- */
 type ExtractMethodType = 'zip' | AnyString;
 
 type AnyString = string & {};
@@ -824,67 +605,26 @@ Return statement is a dynamic object! It has to be always generated and retrieve
 ```ts expandable
 getFile(filePath: IFilePath): Promise<IFile | null>;
 // show-more
-/**
- * Properties of returned file from File System API.
- */
 interface IFile extends IFilePath {
     localUri: string;
-    /**
-     * Image thumbnail URI of the file, which can be used to display a preview of the file.
-     * Note: Supported only on Linux.
-     */
     imageThumbnailUriTemplate?: string;
-    /**
-     * Video thumbnail URI of the file, which can be used to display a preview of the file.
-     * Note: Supported only on Linux.
-     */
     videoThumbnailUriTemplate?: string;
-    /**
-     * Date and time when the file was created in milliseconds since the epoch.
-     */
     createdAt?: number;
     lastModifiedAt?: number;
     sizeBytes?: number;
     mimeType?: string;
 }
 
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -935,49 +675,19 @@ Reason: MD5 file checksum is not available on any Tizen displays due to the Sams
 ```ts expandable
 getFileChecksum(filePath: IFilePath, hashType: HashAlgorithm): Promise<string>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
-/**
- * Represents the supported hash algorithms by Core Apps.
- */
 type HashAlgorithm = 'md5' | 'crc32' | AnyString;
 
 type AnyString = string & {};
@@ -1024,43 +734,16 @@ The `isDirectory()` method checks whether the file path points to a directory.
 ```ts expandable
 isDirectory(filePath: IFilePath): Promise<boolean>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1110,43 +793,16 @@ This method is only available on Linux devices.
 ```ts expandable
 link(sourceFilePath: IFilePath, destinationFilePath: IFilePath): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1196,43 +852,16 @@ The `listFiles()` method lists all files and directories in the specified path (
 ```ts expandable
 listFiles(directoryPath: IFilePath): Promise<IFilePath[]>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1280,29 +909,11 @@ A shorthand method for listing only the internal storage units (i.e., those with
 ```ts expandable
 listInternalStorageUnits(): Promise<IStorageUnit[]>;
 // show-more
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1343,29 +954,11 @@ This is a mandatory method that is required for all the other File System APIs.
 ```ts expandable
 listStorageUnits(): Promise<IStorageUnit[]>;
 // show-more
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1400,43 +993,16 @@ The `moveFile()` method moves a file from `sourceFilePath` to `destinationFilePa
 ```ts expandable
 moveFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options?: IMoveFileOptions): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1514,43 +1080,16 @@ The file has to be a text file, otherwise the content will be mangled.
 ```ts expandable
 readFile(filePath: IFilePath): Promise<string>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }
 
@@ -1645,43 +1184,16 @@ The `writeFile()` method writes string content to the file specified by `filePat
 ```ts expandable
 writeFile(filePath: IFilePath, contents: string): Promise<void>;
 // show-more
-/**
- * Base File System interface for methods.
- */
 interface IFilePath {
-    /**
-     * Storage unit which is selected for performing file operations.
-     */
     storageUnit: IStorageUnit;
-    /**
-     * File path within the storage unit.
-     */
     filePath: string;
 }
 
-/**
- * File System Storage Unit returned by the File System API.
- */
 interface IStorageUnit {
-    /**
-     * The type of the storage unit, e.g., "internal" or "external".
-     */
     type: string;
-    /**
-     * The total capacity of the storage unit in bytes.
-     */
     capacity: number;
-    /**
-     * The amount of free space available in the storage unit in bytes.
-     */
     freeSpace: number;
-    /**
-     * The amount of usable space in the storage unit in bytes.
-     */
     usableSpace: number;
-    /**
-     * Indicates whether the storage unit is removable (e.g., an SD card).
-     */
     removable: boolean;
 }