Interface IThumbnailStorageStore

Interface for a storage store that handles thumbnails.

Namespace: DataWeb.Storage

Assembly: DataWeb.Core.dll

Syntax

public interface IThumbnailStorageStore

Properties

Name

Gets the name of the storage store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

DeleteThumbnailsAsync(CancellationToken)

Deletes all thumbnails in the storage store.

Declaration

Task DeleteThumbnailsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.

DownloadThumbnailStreamAsync(string, string, CancellationToken)

Downloads the stream of the thumbnail with the specified name and domain.

Declaration

Task<Stream> DownloadThumbnailStreamAsync(string thumbnailName, string thumbnailDomain, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	thumbnailName	The name of the thumbnail to download.
string	thumbnailDomain	The domain of the thumbnail to download.
CancellationToken	cancellationToken

Returns

Type	Description
Task<Stream>	A task that represents the asynchronous operation. The task result contains the stream of the downloaded thumbnail.

IsThumbnailUpToDateAsync(string, DateTimeOffset, CancellationToken)

Checks if a thumbnail with the specified name and domain is up-to-date based on the file date modified.

Declaration

Task<bool> IsThumbnailUpToDateAsync(string thumbnailName, DateTimeOffset fileDateModified, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	thumbnailName	The name of the thumbnail to check.
DateTimeOffset	fileDateModified	The date modified of the file to check against.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	A task that represents the asynchronous operation. The task result contains a value indicating whether the thumbnail is up-to-date based on the file date modified.

ThumbnailExistsAsync(string, string, CancellationToken)

Checks if a thumbnail with the specified name and domain exists in the storage store.

Declaration

Task<bool> ThumbnailExistsAsync(string thumbnailName, string thumbnailDomain, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	thumbnailName	The name of the thumbnail to check.
string	thumbnailDomain	The domain of the thumbnail to check.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	A task that represents the asynchronous operation. The task result contains a value indicating whether the thumbnail exists in the storage store.

UploadThumbnailStreamAsync(Stream, string, CancellationToken)

Uploads the stream of a thumbnail with the specified name.

Declaration

Task UploadThumbnailStreamAsync(Stream stream, string thumbnailName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Stream	stream	The stream of the thumbnail to upload.
string	thumbnailName	The name of the thumbnail to upload.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.