KDownloadRequest<TDecoded> class

Inheritance

• Object
• KRestRequest<TDecoded>
• KDownloadRequest

Constructors

KDownloadRequest(KRestApi _api, {required String path, required dynamic savePath, bool usePrimary = true, Options? options, Map<String, dynamic>? queryParams, CancelToken? cancelToken, void onReceiveProgress(int, int)?, FileAccessMode fileAccessMode = FileAccessMode.write, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, LogOptions? logOptions, bool useBaseUrl = true, FutureOr<KDownloadRequest<TDecoded>> resolve(KDownloadRequest<TDecoded>)?})

KDownloadRequest.from(KRestRequest<TDecoded> r, {required dynamic savePath, String lengthHeader = Headers.contentLengthHeader, FutureOr<KDownloadRequest<TDecoded>> resolve(KDownloadRequest<TDecoded>)?})

factory

Properties

cancelToken → CancelToken?

final, inherited

data → Object?

final, inherited

decoder → TDecoded Function(dynamic data, Response _)?

Converts the raw Dio response payload into the client-facing output type. data == Response.data

final, inherited

deleteOnError → bool

final

fileAccessMode → FileAccessMode

final

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>?

It will replace the one in Options.headers, don't provide if you wish to use the one in the Options

final, inherited

lengthHeader → String

final

logOptions → LogOptions?

final, inherited

onReceiveProgress → void Function(int, int)?

final, inherited

options → Options?

final, inherited

path → String

final, inherited

queryParams → Map<String, dynamic>?

final, inherited

resolve → FutureOr<KDownloadRequest<TDecoded>> Function(KDownloadRequest<TDecoded>)?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

savePath → dynamic

final

transformedPath → String

no setter, inherited

useBaseUrl → bool

Set to true by default. You can set to false if you don't want to append with the baseUrl from the parent KRestApiBase and want to provide a full URL in path instead. Doesn't have any effect if the KRestApiBase doesn't have a baseUrl configured, in which case the path is used as-is regardless of this flag.

final, inherited

usePrimary → bool

final, inherited

Methods

copyWith({String? pathTransform(String)?, bool? usePrimary, dynamic savePath, Options? options, Map<String, dynamic>? queryParams, CancelToken? cancelToken, void onReceiveProgress(int, int)?, bool? deleteOnError, String? lengthHeader, FileAccessMode? fileAccessMode, LogOptions? logOptions, bool? useBaseUrl}) → KDownloadRequest<TDecoded>

download() → Future<void>

downloadResponse() → Future<KResponse<dynamic, TDecoded>>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDeleteRequest() → KDeleteRequest<TDecoded>

inherited

toDownloadRequest({required dynamic savePath}) → KDownloadRequest<TDecoded>

inherited

toGetRequest() → KGetRequest<TDecoded>

inherited

toPatchRequest() → KPatchRequest<TDecoded>

inherited

toPostRequest() → KPostRequest<TDecoded>

inherited

toPutRequest() → KPutRequest<TDecoded>

inherited

toRequest() → KRequest<TDecoded>

inherited

toString() → String

A string representation of this object.

inherited

tryDownload() → Future<void>

tryDownloadResponse() → Future<KResponse<dynamic, TDecoded>>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

method → const String