IImageFile Interface Reference

An image file interface. More...

Inheritance diagram for IImageFile:

Public Member Functions
Task< Size >	GetImageSizeAsync (CancellationToken cancellationToken)
	Asynchronously gets image dimensions. More...
Task< ImageFactory >	GetImageAsync (CancellationToken cancellationToken)
	Asynchronously gets image factory (from ImageProcessor library). More...
Task< ResizedImageFile >	GetOrCreateResizedAsync (Size requestedSize, CancellationToken cancellationToken)
	Asynchronously gets or creates resized image. More...
Task< IReadOnlyCollection< ResizedImageFile > >	GetResizedImagesAsync (CancellationToken cancellationToken)
	Asynchronously gets all existing resized images. More...
Public Member Functions inherited from IThumbnailedFile
Task< ThumbnailFile >	GetOrCreateThumbnailAsync (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< IFile >	AutoRenameAsync (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

An image file interface.

Member Function Documentation

GetImageAsync()

Task<ImageFactory> GetImageAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets image factory (from ImageProcessor library).

Parameters

cancellationToken

A cancellation token.

Returns

An ImageFactory.

GetImageSizeAsync()

Task<Size> GetImageSizeAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets image dimensions.

Parameters

cancellationToken

A cancellation token.

Returns

An image size.

GetOrCreateResizedAsync()

Task<ResizedImageFile> GetOrCreateResizedAsync	(	Size	requestedSize,
		CancellationToken	cancellationToken
	)

Asynchronously gets or creates resized image.

Parameters

requestedSize	A new size.
cancellationToken	A cancellation token.

Returns

A ResizedImageFile instance.

GetResizedImagesAsync()

Task<IReadOnlyCollection<ResizedImageFile> > GetResizedImagesAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets all existing resized images.

Parameters

cancellationToken

A cancellation token.

Returns

A collection of ResizedImageFile instances.

---

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

• IImageFile.cs