IFileSystem | @signageos/sdk

Hierarchy

IFileSystem

Index

Methods

Methods

appendFile

appendFile(filePath: IFilePath, content: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:91
Parameters
- filePath: IFilePath
- content: string
Returns Promise<void>

copyFile

copyFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options: ICopyFileOptions | {}): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:93
Parameters
- sourceFilePath: IFilePath
- destinationFilePath: IFilePath
- options: ICopyFileOptions | {}
Returns Promise<void>

createDirectory

createDirectory(directoryPath: IFilePath): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:99
Parameters
- directoryPath: IFilePath
Returns Promise<void>

deleteFile

deleteFile(filePath: IFilePath, recursive: boolean): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:95
Parameters
- filePath: IFilePath
- recursive: boolean
Returns Promise<void>

downloadFile

downloadFile(filePath: IFilePath, sourceUri: string, headers?: IHeaders): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:96
Parameters
- filePath: IFilePath
- sourceUri: string
- Optional headers: IHeaders
Returns Promise<void>

exists

exists(filePath: IFilePath): Promise<boolean>

- Defined in src/RestApi/Timing/Timing.ts:88
Parameters
- filePath: IFilePath
Returns Promise<boolean>

extractFile

extractFile(archiveFilePath: IFilePath, destinationDirectionPath: IFilePath, method: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:97
Parameters
- archiveFilePath: IFilePath
- destinationDirectionPath: IFilePath
- method: string
Returns Promise<void>

getFile

getFile(filePath: IFilePath): Promise<IFileSystemFile | null>

- Defined in src/RestApi/Timing/Timing.ts:89
Parameters
- filePath: IFilePath
Returns Promise<IFileSystemFile | null>

getFileChecksum

getFileChecksum(filePath: IFilePath, hashType: string): Promise<string>

- Defined in src/RestApi/Timing/Timing.ts:98
Parameters
- filePath: IFilePath
- hashType: string
Returns Promise<string>

isDirectory

isDirectory(filePath: IFilePath): Promise<boolean>

- Defined in src/RestApi/Timing/Timing.ts:100
Parameters
- filePath: IFilePath
Returns Promise<boolean>

listFiles

listFiles(directoryPath: IFilePath): Promise<IFilePath[]>

- Defined in src/RestApi/Timing/Timing.ts:87
Parameters
- directoryPath: IFilePath
Returns Promise<IFilePath[]>

listStorageUnits

listStorageUnits(): Promise<IStorageUnit[]>

- Defined in src/RestApi/Timing/Timing.ts:86
Returns Promise<IStorageUnit[]>

moveFile

moveFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options: IMoveFileOptions | {}): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:94
Parameters
- sourceFilePath: IFilePath
- destinationFilePath: IFilePath
- options: IMoveFileOptions | {}
Returns Promise<void>

readFile

readFile(filePath: IFilePath): Promise<string>

- Defined in src/RestApi/Timing/Timing.ts:92
Parameters
- filePath: IFilePath
Returns Promise<string>

writeFile

writeFile(filePath: IFilePath, content: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:90
Parameters
- filePath: IFilePath
- content: string
Returns Promise<void>

Generated using TypeDoc