getFiles method

Future<Response<List<File>>> getFiles({
  1. String? tag,
  2. @Deprecated('userId is deprecated') String? userId,
  3. int? n = 60,
  4. int? offset,
  5. CancelToken? cancelToken,
  6. Map<String, dynamic>? headers,
  7. Map<String, dynamic>? extra,
  8. ValidateStatus? validateStatus,
  9. ProgressCallback? onSendProgress,
  10. ProgressCallback? onReceiveProgress,
})

List Files Returns a list of files

Parameters:

  • tag - Tag, for example "icon" or "gallery", not included by default.
  • userId - UserID, will always generate a 500 permission error.
  • n - The number of objects to return.
  • offset - A zero-based offset from the default object sorting from where search results start.
  • cancelToken - A CancelToken that can be used to cancel the operation
  • headers - Can be used to add additional headers to the request
  • extras - Can be used to add flags to the request
  • validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
  • onSendProgress - A ProgressCallback that can be used to get the send progress
  • onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a List<File> as data Throws DioException if API call or serialization fails

Implementation

Future<Response<List<File>>> getFiles({
  String? tag,
  @Deprecated('userId is deprecated') String? userId,
  int? n = 60,
  int? offset,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/files';
  final _options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'apiKey',
          'name': 'authCookie',
          'keyName': 'auth',
          'where': '',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final _queryParameters = <String, dynamic>{
    if (tag != null) r'tag': tag,
    if (userId != null) r'userId': userId,
    if (n != null) r'n': n,
    if (offset != null) r'offset': offset,
  };

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    queryParameters: _queryParameters,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  List<File>? _responseData;

  try {
    final rawData = _response.data;
    _responseData = rawData == null
        ? null
        : deserialize<List<File>, File>(rawData, 'List<File>',
            growable: true);
  } catch (error, stackTrace) {
    throw DioException(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioExceptionType.unknown,
      error: error,
      stackTrace: stackTrace,
    );
  }

  return Response<List<File>>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}