CKFinder 3 – ASP.NET Connector Documentation
IFileSystem Interface Reference

A file system interface. More...

Inheritance diagram for IFileSystem:
AmazonStorage AzureStorage DropboxStorage FtpStorage LocalStorage

Public Member Functions

Task CreateFolderAsync (string path, CancellationToken cancellationToken)
 Asynchronously creates new folder. More...
 
Task DeleteFileAsync (string path, CancellationToken cancellationToken)
 Asynchronously deletes a file. More...
 
Task DeleteFolderAsync (string path, CancellationToken cancellationToken)
 Asynchronously deletes a folder. More...
 
Task DeleteFolderAsync (string path, Action< int, int > progressAction, CancellationToken cancellationToken)
 Asynchronously deletes a folder. More...
 
Task MoveFileAsync (string srcPath, string destPath, CancellationToken cancellationToken)
 Asynchronously moves a file. More...
 
Task MoveFolderAsync (string srcPath, string destPath, CancellationToken cancellationToken)
 Asynchronously moves a folder. More...
 
Task MoveFolderAsync (string srcPath, string destPath, Action< int, int > progressAction, CancellationToken cancellationToken)
 Asynchronously moves a folder. More...
 
Task CopyFileAsync (string srcPath, string destPath, CancellationToken cancellationToken)
 Asynchronously copies a file. More...
 
Task< bool > FileExistsAsync (string path, CancellationToken cancellationToken)
 Asynchronously checks whether a file exists. More...
 
Task< bool > FolderExistsAsync (string path, CancellationToken cancellationToken)
 Asynchronously checks whether a folder exists. More...
 
Task WriteAsync (Stream fileStream, string path, CancellationToken cancellationToken)
 Asynchronously writes file content. More...
 
Task< Stream > ReadAsync (string path, CancellationToken cancellationToken)
 Asynchronously reads file content. More...
 
Task< FolderListResultGetFolderInfosAsync (string path, CancellationToken cancellationToken)
 Asynchronously lists folder informations. More...
 
Task< FolderListResultGetFolderInfosAsync (IFolderListContinuation folderListContinuation, CancellationToken cancellationToken)
 Asynchronously lists folder informations. More...
 
Task< FileListResultGetFileInfosAsync (string path, CancellationToken cancellationToken)
 Asynchronously lists file informations. More...
 
Task< FileListResultGetFileInfosAsync (IFileListContinuation fileListContinuation, CancellationToken cancellationToken)
 Asynchronously lists file informations. More...
 
Task< FolderInfoGetFolderInfoAsync (string path, CancellationToken cancellationToken)
 Asychronously gets folder information. More...
 
Task< FileInfoGetFileInfoAsync (string path, CancellationToken cancellationToken)
 Asychronously gets file information. More...
 
Task< string > GetUrlAsync (string path, CancellationToken cancellationToken)
 Asynchronously gets resource URL. May return null if URL is not available. More...
 

Detailed Description

A file system interface.

Member Function Documentation

◆ CopyFileAsync()

Task CopyFileAsync ( string  srcPath,
string  destPath,
CancellationToken  cancellationToken 
)

Asynchronously copies a file.

Parameters
srcPathA path to the file.
destPathA path to the destination file.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ CreateFolderAsync()

Task CreateFolderAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously creates new folder.

Parameters
pathA path to the new folder.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ DeleteFileAsync()

Task DeleteFileAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously deletes a file.

Parameters
pathA path to the file.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ DeleteFolderAsync() [1/2]

Task DeleteFolderAsync ( string  path,
Action< int, int >  progressAction,
CancellationToken  cancellationToken 
)

Asynchronously deletes a folder.

Parameters
pathA path to the folder.
progressActionAn action fired when progress is updated.
cancellationTokenA cancellation token.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ DeleteFolderAsync() [2/2]

Task DeleteFolderAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously deletes a folder.

Parameters
pathA path to the folder.
cancellationTokenA cancellation token.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ FileExistsAsync()

Task<bool> FileExistsAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously checks whether a file exists.

Parameters
pathA path to the file.
cancellationTokenA cancellation token.
Returns
True if file exists, false otherwise.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ FolderExistsAsync()

Task<bool> FolderExistsAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously checks whether a folder exists.

Parameters
pathA path to the folder.
cancellationTokenA cancellation token.
Returns
True if folder exists, false otherwise.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ GetFileInfoAsync()

Task<FileInfo> GetFileInfoAsync ( string  path,
CancellationToken  cancellationToken 
)

Asychronously gets file information.

Parameters
pathA path to the file.
cancellationTokenA cancellation token.
Returns
A file information.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetFileInfosAsync() [1/2]

Task<FileListResult> GetFileInfosAsync ( IFileListContinuation  fileListContinuation,
CancellationToken  cancellationToken 
)

Asynchronously lists file informations.

Parameters
fileListContinuationA file list continuation.
cancellationTokenA cancellation token.
Returns
A file list result.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetFileInfosAsync() [2/2]

Task<FileListResult> GetFileInfosAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously lists file informations.

Parameters
pathA path to the folder.
cancellationTokenA cancellation token.
Returns
A file list result.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetFolderInfoAsync()

Task<FolderInfo> GetFolderInfoAsync ( string  path,
CancellationToken  cancellationToken 
)

Asychronously gets folder information.

Parameters
pathA path to the folder.
cancellationTokenA cancellation token.
Returns
A folder information.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetFolderInfosAsync() [1/2]

Task<FolderListResult> GetFolderInfosAsync ( IFolderListContinuation  folderListContinuation,
CancellationToken  cancellationToken 
)

Asynchronously lists folder informations.

Parameters
folderListContinuationA folder list continuation.
cancellationTokenA cancellation token.
Returns
A folder list result.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetFolderInfosAsync() [2/2]

Task<FolderListResult> GetFolderInfosAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously lists folder informations.

Parameters
pathA path to the folder.
cancellationTokenA cancellation token.
Returns
A folder list result.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ GetUrlAsync()

Task<string> GetUrlAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously gets resource URL. May return null if URL is not available.

Parameters
pathA path to the resource.
cancellationTokenA cancellation token.
Returns
An URL to the resource or null if URL is not available.

Implemented in FtpStorage, AmazonStorage, LocalStorage, AzureStorage, and DropboxStorage.

◆ MoveFileAsync()

Task MoveFileAsync ( string  srcPath,
string  destPath,
CancellationToken  cancellationToken 
)

Asynchronously moves a file.

Parameters
srcPathA path to the file.
destPathA path to the destination file.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ MoveFolderAsync() [1/2]

Task MoveFolderAsync ( string  srcPath,
string  destPath,
Action< int, int >  progressAction,
CancellationToken  cancellationToken 
)

Asynchronously moves a folder.

Parameters
srcPathA path to the folder.
destPathA path to the destination folder.
progressActionAn action fired when progress is updated.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ MoveFolderAsync() [2/2]

Task MoveFolderAsync ( string  srcPath,
string  destPath,
CancellationToken  cancellationToken 
)

Asynchronously moves a folder.

Parameters
srcPathA path to the folder.
destPathA path to the destination folder.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ ReadAsync()

Task<Stream> ReadAsync ( string  path,
CancellationToken  cancellationToken 
)

Asynchronously reads file content.

Parameters
pathA path to the file.
cancellationTokenA cancellation token.
Returns
A stream with file content.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.

◆ WriteAsync()

Task WriteAsync ( Stream  fileStream,
string  path,
CancellationToken  cancellationToken 
)

Asynchronously writes file content.

Parameters
fileStreamA stream with content to write.
pathA path to the file.
cancellationTokenA cancellation token.

Implemented in AmazonStorage, FtpStorage, AzureStorage, LocalStorage, and DropboxStorage.


The documentation for this interface was generated from the following file: