api_pilot
library
Classes
ApiCache
Core caching manager for EasyApiKit.
ApiClient
Low-level HTTP engine managing connection lifecycles, interceptors, retries, and logging.
ApiConfig
Configuration options for EasyApiKit client instances.
ApiFailure <T >
Failed outcome wrapper.
ApiInterceptor
Abstract interceptor class for modifying requests, responses, or errors in flight.
ApiLogger
Formatted logger for EasyApiKit operations with strict production security.
ApiRequest
Encapsulates all data and parameters for an outgoing API request.
ApiResponse <T >
Standard wrapper returned by all EasyApi Kit requests.
ApiResult <T >
Functional result type representing either a success value T or an ApiError .
ApiSuccess <T >
Successful outcome wrapper.
AuthInterceptor
Interceptor that automatically injects Authorization headers into requests.
ByteBuffer
A sequence of bytes underlying a typed data object.
ByteData
A fixed-length, random-access sequence of bytes that also provides random
and unaligned access to the fixed-width integers and floating point
numbers represented by those bytes.
BytesBuilder
Builds a list of bytes, allowing bytes and lists of bytes to be added at the
end.
CacheEntry <T >
Wraps a cached HTTP response payload with expiration metadata.
CancellationToken
A token that can be passed to API requests to cancel them in-flight.
ConnectivityChecker
Utility for checking device network connectivity before making API calls.
EasyApi
Primary public facade for EasyApiKit.
EasyApiController <T >
Helper controller for managing API request lifecycle state in Flutter widgets.
Endian
Endianness of number representation.
Float32List
A fixed-length list of IEEE 754 single-precision binary floating-point
numbers that is viewable as a TypedData .
Float32x4
Four 32-bit floating point values.
Float32x4List
A fixed-length list of Float32x4 numbers that is viewable as a
TypedData .
Float64List
A fixed-length list of IEEE 754 double-precision binary floating-point
numbers that is viewable as a TypedData .
Float64x2
Float64x2 immutable value type and operations.
Float64x2List
A fixed-length list of Float64x2 numbers that is viewable as a
TypedData .
Int16List
A fixed-length list of 16-bit signed integers that is viewable as a
TypedData .
Int32List
A fixed-length list of 32-bit signed integers that is viewable as a
TypedData .
Int32x4
Int32x4 and operations.
Int32x4List
A fixed-length list of Int32x4 numbers that is viewable as a
TypedData .
Int64List
A fixed-length list of 64-bit signed integers that is viewable as a
TypedData .
Int8List
A fixed-length list of 8-bit signed integers.
MemoryCache
In-memory cache store for HTTP response payloads.
Configurable parser for extracting paginated response metadata.
Contains paginated items and navigation metadata.
RetryPolicy
Evaluates and handles request retry logic for transient failures.
SimpleInterceptor
A functional implementation of ApiInterceptor allowing quick inline callbacks.
TypedData
A typed view of a sequence of bytes.
TypedDataList <E >
A TypedData fixed-length List -view on the bytes of buffer .
Uint16List
A fixed-length list of 16-bit unsigned integers that is viewable as a
TypedData .
Uint32List
A fixed-length list of 32-bit unsigned integers that is viewable as a
TypedData .
Uint64List
A fixed-length list of 64-bit unsigned integers that is viewable as a
TypedData .
Uint8ClampedList
A fixed-length list of 8-bit unsigned integers.
Uint8List
A fixed-length list of 8-bit unsigned integers.
UploadFile
Represents a file payload for multipart uploads.
Enums
ApiErrorType
Categorizes API errors into specific actionable types.
ApiLogLevel
Specifies the verbosity of terminal logs.
BodyType
Defines the encoding type for the HTTP request body.
CachePolicy
Specifies the caching strategy for HTTP GET requests.
HttpMethod
Represents supported HTTP request methods in EasyApiKit.
MultipartFileStrategy
Defines how multiple files under the same key are named in multipart requests.
Exceptions / Errors
ApiError
Base exception class for all errors generated or handled by EasyApiKit.
CancelledError
Occurs when a request is explicitly cancelled using a CancellationToken .
ForbiddenError
Occurs when the server returns 403 Forbidden.
NetworkError
Occurs when the device cannot establish a network connection to the server.
NotFoundError
Occurs when the server returns 404 Not Found.
OfflineError
Occurs when device has no active network connectivity.
ParsingError
Occurs when JSON parsing fails while converting HTTP response into a strongly typed Dart model.
ServerError
Occurs when the server returns a 5xx HTTP status code.
TimeoutError
Occurs when a request exceeds the configured connect, receive, or send timeout.
UnauthorizedError
Occurs when the server returns 401 Unauthorized.
UnknownApiError
Catch-all ApiError for unclassified exceptions.
UploadError
Occurs when uploading multipart files fails.
ValidationError
Occurs when the server returns 422 Unprocessable Entity or 400 Bad Request validation failure.
