CKFinder 3 – ASP.NET Connector Documentation
IThumbnailedFile Interface Reference

A file with thumbnail interface. More...

Inheritance diagram for IThumbnailedFile:
IFile INode IImageFile

Public Member Functions

Task< ThumbnailFileGetOrCreateThumbnailAsync (Size requestedSize, CancellationToken cancellationToken)
 Asynchronously gets or creates thumbnail image. More...
 
Task< IReadOnlyCollection< ThumbnailFile > > GetThumbnailsAsync (CancellationToken cancellationToken)
 Asynchronously gets all existing thumbnails. More...
 
- Public Member Functions inherited from IFile
Task< IFileAutoRenameAsync (CancellationToken cancellationToken)
 Asynchronously does automatic file rename, such that no file with the same name exists in the ResourceType. More...
 
Task CopyAsync (IFile destinationFile, bool allowOverwrite, CancellationToken cancellationToken)
 Asynchronously copies file. More...
 
Task MoveAsync (IFile destinationFile, bool allowOverwrite, CancellationToken cancellationToken)
 Asynchronously moves file. More...
 
Task DeleteAsync (CancellationToken cancellationToken)
 Asynchronoulsy deletes file. More...
 
Task< bool > ExistsAsync (CancellationToken cancellationToken)
 Asynchronously checks if file exists. More...
 
Task< Stream > ReadAsync (CancellationToken cancellationToken)
 Asynchronously reads file content. More...
 
Task WriteAsync (Stream stream, CancellationToken cancellationToken)
 Asynchronously writes file content. More...
 
Task< FileInfo > GetFileInfoAsync (CancellationToken cancellationToken)
 Asynchronously gets file information. More...
 
Task< string > GetUrlAsync (CancellationToken cancellationToken)
 Asynchronously gets file url. More...
 
bool HasValidExtension ()
 Checks if the extension is valid on the ResourceType. More...
 
bool HasValidExtension (bool checkDoubleExtension)
 Checks if the extension is valid on the ResourceType. More...
 
bool IsHidden ()
 Checks if file is hidden on the ResourceType. More...
 
Task< string > GetHashAsync (CancellationToken cancellationToken)
 Asynchronously calculates file hash. More...
 

Additional Inherited Members

- Properties inherited from IFile
string Name [get]
 Gets the file name. More...
 
string Extension [get]
 Gets the file extension. More...
 
string NameWithoutExtension [get]
 Gets the file name without the extension. More...
 
string Path [get]
 Gets ResourceType relative path to the file. More...
 
string FullPath [get]
 Gets the absolute path to the file. More...
 
ResourceType ResourceType [get]
 Gets the ResourceType. More...
 
IFolder ParentFolder [get]
 Gets parent folder instance. More...
 

Detailed Description

A file with thumbnail interface.

Member Function Documentation

◆ GetOrCreateThumbnailAsync()

Task<ThumbnailFile> GetOrCreateThumbnailAsync ( Size  requestedSize,
CancellationToken  cancellationToken 
)

Asynchronously gets or creates thumbnail image.

Parameters
requestedSizeA thumbnail size.
cancellationTokenA cancellation token.
Returns
A ThumbnailFile instance.

◆ GetThumbnailsAsync()

Task<IReadOnlyCollection<ThumbnailFile> > GetThumbnailsAsync ( CancellationToken  cancellationToken)

Asynchronously gets all existing thumbnails.

Parameters
cancellationTokenA cancellation token.
Returns
A collection of ThumbnailFile instances.

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