$getFolderTree_Request method

@experimental Request $getFolderTree_Request({ String? path, int? depth, bool? oCSAPIRequest, })

Returns the folder tree of the user.

Returns a DynamiteRequest backing the getFolderTree operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• path The path relative to the user folder. Defaults to "/".
• depth The depth of the tree. Defaults to 1.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Folder tree returned successfully
• 401: Unauthorized
• 400: Invalid folder path
• 404: Folder not found

See:

• getFolderTree for a method executing this request and parsing the response.
• $getFolderTree_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getFolderTree_Request({
  String? path,
  int? depth,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var __path = _$jsonSerializers.serialize(path, specifiedType: const FullType(String));
  __path ??= '/';
  _parameters['path'] = __path;

  var __depth = _$jsonSerializers.serialize(depth, specifiedType: const FullType(int));
  __depth ??= 1;
  _parameters['depth'] = __depth;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/folder-tree{?path*,depth*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}