KPatchRequest<TDecoded> class

PATCH request wrapper with send-progress support and optional response decoding.

Inheritance

• Object
• KRestRequest<TDecoded>
• KPatchRequest

Constructors

KPatchRequest(KRestApi _api, {required String path, bool usePrimary = true, Map<String, String>? headers, Object? data, Options? options, Map<String, dynamic>? queryParams, CancelToken? cancelToken, void onReceiveProgress(int, int)?, void onSendProgress(int, int)?, TDecoded decoder(dynamic data, Response _)?, LogOptions? logOptions, bool useBaseUrl = true, FutureOr<KPatchRequest<TDecoded>> resolve(KPatchRequest<TDecoded>)?})

KPatchRequest.from(KRestRequest<TDecoded> r, {FutureOr<KPatchRequest<TDecoded>> resolve(KPatchRequest<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

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>?

final, inherited

logOptions → LogOptions?

final, inherited

onReceiveProgress → void Function(int, int)?

final, inherited

onSendProgress → void Function(int, int)?

final

options → Options?

final, inherited

path → String

final, inherited

queryParams → Map<String, dynamic>?

final, inherited

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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, Map<String, String>? headers, Object? data, Options? options, CancelToken? cancelToken, Map<String, dynamic>? queryParams, void onSendProgress(int, int)?, void onReceiveProgress(int, int)?, LogOptions? logOptions, bool? useBaseUrl, TDecoded decoder(dynamic data, Response _)?}) → KPatchRequest<TDecoded>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch() → Future<TDecoded?>

patchResponse<Raw>() → Future<KResponse<Raw, TDecoded>>

toDeleteRequest() → KDeleteRequest<TDecoded>

inherited

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

inherited

toGetRequest() → KGetRequest<TDecoded>

inherited

toPathRequest() → KPatchRequest<TDecoded>

inherited

toPostRequest() → KPostRequest<TDecoded>

inherited

toPutRequest() → KPutRequest<TDecoded>

inherited

toRequest() → KRequest<TDecoded>

inherited

toString() → String

A string representation of this object.

inherited

tryPatch() → Future<TDecoded?>

tryPatchResponse<Raw>() → Future<KResponse<Raw, TDecoded>>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

method → const String