SocketRestorableChunkedFileHandler<ResponseType> class abstract

A common interface for any plugin that wants to handle file uploads using a socket client.

Implementers

Constructors

SocketRestorableChunkedFileHandler({required XFile file, required String presentPath, required ChunkPathCallback chunkPath, required StatusPathCallback statusPath, required PresentParser<ResponseType> presentParser, required StatusParser<ResponseType> statusParser, int? chunkSize, String presentMethod = kPresentMethod, String chunkMethod = kChunkMethod, String statusMethod = kStatusMethod, Map<String, String>? presentHeaders, RestorableChunkHeadersCallback? chunkHeaders, StatusHeadersCallback? statusHeaders, String? presentBody, String? chunkBody, String? statusBody, String fileKey = kFileKey, ChunkParser<ResponseType> chunkParser = kChunkParser})
set chunkSize to choose the size of the chunks else defaultChunkSize is used
const

Properties

chunkBody String?
http.Client.send body used on chunk upload
final
chunkHeaders RestorableChunkHeadersCallback?
http.Client.send headers used on chunk upload
final
chunkMethod String
http.Client.send method used on chunk upload
final
chunkParser → ChunkParser<ResponseType>
callback to validate chunk upload
final
chunkPath ChunkPathCallback
http.Client.send path used on chunk upload
final
chunkSize int?
chunk size, if null defaultChunkSize is used
finalinherited
file → XFile
file to handle
finalinherited
fileKey String
request key for file
final
hashCode int
The hash code for this object.
no setterinherited
presentBody String?
http.Client.send body used on presentation
final
presentHeaders Map<String, String>?
http.Client.send headers used on presentation
final
presentMethod String
http.Client.send method used on presentation
final
presentParser → PresentParser<ResponseType>
callback to convert ResponseType into FileUploadPresentationResponse
final
presentPath String
http.Client.send path used on presentation
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
statusBody String?
http.Client.send body used on status
final
statusHeaders StatusHeadersCallback?
http.Client.send headers used on status
final
statusMethod String
http.Client.send method used on status
final
statusParser → StatusParser<ResponseType>
callback to convert ResponseType into FileUploadStatusResponse
final
statusPath StatusPathCallback
http.Client.send path used on status
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
present() Future<FileUploadPresentationResponse>
the method to present the file; before uploading the chunks, the file is presented and needs FileUploadPresentationResponse.
inherited
status(FileUploadPresentationResponse presentation) Future<FileUploadStatusResponse>
the method that, given the presentation id, allows requesting the file's state.
inherited
toString() String
A string representation of this object.
inherited
uploadChunk(FileUploadPresentationResponse presentation, FileChunk chunk, {ProgressCallback? onProgress}) Future<void>
method to handle the upload of a FileChunk.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited