Namespace Singulink.Net.Http.Api.Service.Uploads
Classes
ChunkedUploadEndpointOptions
Provides the options of an upload endpoint mapped with MapChunkedUpload.
ChunkedUploadOptions
Provides options for chunked uploads: where the directory store keeps them, their sizes and chunk sizes, the limits of open uploads, and how long uploads and their outcomes are kept.
StoredUpload
Represents an upload in an IUploadStore with its current state: its record, when its last chunk was written, the state of its handler's run and its outcome.
UploadContent
Represents the complete file of an upload as an IUploadStore provides it: a stream that reads it, and the path of a file that has it, if the store keeps one in a file system.
UploadErrorData
Gets the limits and the property that the errors of chunked uploads (see UploadErrorCodes) name in their messages, of the errors that its methods list, which the errors keep in their Data. An exception handler gets the errors with their values (see MapApiExceptionAsync(HttpContext, ApiException)).
UploadKeyReservation
Represents the reservation of an idempotency key of a user for an upload in an IUploadStore, which ReserveKeyAsync(string, string, string, CancellationToken) returns.
UploadRecord
Represents what an IUploadStore keeps of an upload from its creation: its ID, its owner, its length and chunk size, its creation time and the service's metadata.
UploadRequest
Represents the creation of a chunked upload, which the validator of the upload takes as a parameter: the file's name, length and content type as the client sent them.
UploadRequest<TCommand>
Represents the creation of a chunked upload with the app's command, which the validator of the upload takes as a parameter.
UploadedFile
Represents the complete file of a chunked upload, which the handler of the upload takes as a parameter.
UploadedFile<TCommand>
Represents the complete file of a chunked upload with the app's command from the upload's creation, which the handler of the upload takes as a parameter.
Interfaces
IUploadRunClaim
Represents a server's claim of the run of an upload's handler, which TryClaimRunAsync(UploadRecord, TimeSpan, CancellationToken) returns.
IUploadStore
Represents the storage of chunked uploads, which keeps everything the service knows about them: their records, their chunks, the claims of their handler runs and their outcomes. Chunked uploads use a store in a directory by default (see Directory), and a store that the app registers as a singleton IUploadStore service instead.
Enums
ChunkWriteResult
Specifies the result of writing a chunk of an upload to an IUploadStore (see WriteChunkAsync(UploadRecord, int, Stream, CancellationToken)).
UploadRunState
Specifies the state of the claim of an upload's handler run in an IUploadStore.