$BatchRequest class

A request queued in a batch operation.

This class stores all the information needed to either send the request to the server or apply it to the local cache.

Constructors

$BatchRequest({required String method, required String collection, String? recordId, Map<String, dynamic> body = const {}, Map<String, dynamic> query = const {}, Map<String, String> headers = const {}, List<(String, String?, Uint8List)> files = const [], String? expand, String? fields}): const

body → Map<String, dynamic>: The request body data.
final
collection → String: The collection this request targets.
final
expand → String?: Expand parameter for the request.
final
fields → String?: Fields parameter for limiting response fields.
final
files → List<(String, String?, Uint8List)>: Files to upload, buffered in memory so they can be replayed offline.
final
hashCode → int: The hash code for this object.
no setterinherited
headers → Map<String, String>: Request headers.
final
isCreate → bool: Whether this is a create operation.
no setter
isDelete → bool: Whether this is a delete operation.
no setter
isUpdate → bool: Whether this is an update operation.
no setter
isUpsert → bool: Whether this is an upsert operation.
no setter
method → String: The HTTP method for this request (POST, PATCH, PUT, DELETE).
final
query → Map<String, dynamic>: Query parameters.
final
recordId → String?: The record ID: set for update/delete, and assigned on the client for creates and upserts without an id, so a retried batch or a later individual sync cannot create duplicates.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited