VenturoApiConfig constructor

VenturoApiConfig({
  1. String? method,
  2. String baseUrl = '',
  3. Duration? connectTimeout = CONNECTION_TIME_OUT,
  4. Duration? receiveTimeout = RECEIVE_TIME_OUT,
  5. Duration? sendTimeout = SEND_TIME_OUT,
  6. Map<String, dynamic>? queryParameters,
  7. Map<String, dynamic>? extra,
  8. Map<String, dynamic>? headers,
  9. bool? preserveHeaderCase = false,
  10. ResponseType? responseType = ResponseType.json,
  11. String? contentType,
  12. bool validateStatus(
    1. int?
    )?,
  13. bool? receiveDataWhenStatusError = RECEIVE_DATA_WHEN_ERROR,
  14. bool? followRedirects,
  15. int? maxRedirects,
  16. bool? persistentConnection,
  17. FutureOr<List<int>> requestEncoder(
    1. String,
    2. RequestOptions
    )?,
  18. FutureOr<String?> responseDecoder(
    1. List<int>,
    2. RequestOptions,
    3. ResponseBody
    )?,
  19. ListFormat? listFormat,
  20. VenturoApiSecurity? security,
  21. VenturoApiInterceptor configureInterceptor = const VenturoApiInterceptor(),
})

Factory method to create an instance of VenturoApiConfig

Parameters:

  • baseUrl: The base URL for API requests.
  • headers: Optional custom headers.
  • security: Optional security configurations.
  • configureInterceptor: Required interceptor configuration.

Usage Example:

final apiConfig = VenturoApiConfig(
  baseUrl: "https://api.example.com",
  configureInterceptor: VenturoApiInterceptor(),
);

Implementation

factory VenturoApiConfig({
  String? method,
  String baseUrl = '',
  Duration? connectTimeout = CONNECTION_TIME_OUT,
  Duration? receiveTimeout = RECEIVE_TIME_OUT,
  Duration? sendTimeout = SEND_TIME_OUT,
  Map<String, dynamic>? queryParameters,
  Map<String, dynamic>? extra,
  Map<String, dynamic>? headers,
  bool? preserveHeaderCase = false,
  ResponseType? responseType = ResponseType.json,
  String? contentType,
  bool Function(int?)? validateStatus,
  bool? receiveDataWhenStatusError = RECEIVE_DATA_WHEN_ERROR,
  bool? followRedirects,
  int? maxRedirects,
  bool? persistentConnection,
  FutureOr<List<int>> Function(String, RequestOptions)? requestEncoder,
  FutureOr<String?> Function(List<int>, RequestOptions, ResponseBody)? responseDecoder,
  ListFormat? listFormat,
  VenturoApiSecurity? security,
  VenturoApiInterceptor configureInterceptor = const VenturoApiInterceptor(),
}) {
  return VenturoApiConfig._(
    method: method,
    baseUrl: baseUrl,
    connectTimeout: connectTimeout,
    receiveTimeout: receiveTimeout,
    sendTimeout: sendTimeout,
    queryParameters: queryParameters,
    extra: extra,
    headers: headers ?? DEFAULT_HEADERS.data,
    preserveHeaderCase: preserveHeaderCase,
    responseType: responseType,
    contentType: contentType,
    validateStatus: validateStatus,
    receiveDataWhenStatusError: receiveDataWhenStatusError,
    followRedirects: followRedirects,
    maxRedirects: maxRedirects,
    persistentConnection: persistentConnection,
    requestEncoder: requestEncoder,
    responseDecoder: responseDecoder,
    listFormat: listFormat,
    security: security,
    configureInterceptor: configureInterceptor,
  );
}