Class FolderRenameParams

  • All Implemented Interfaces:
    io.imagekit.core.Params

    
    public final class FolderRenameParams
     implements Params
                        

    This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name.

    • Constructor Detail

    • Method Detail

      • folderPath

         final String folderPath()

        The full path to the folder you want to rename.

      • newFolderName

         final String newFolderName()

        The new name for the folder.

        All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and - will be replaced by an underscore i.e. _.

      • purgeCache

         final Optional<Boolean> purgeCache()

        Option to purge cache for the old nested files and their versions' URLs.

        When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota.

        Note: A purge cache request will be issued against https://ik.imagekit.io/old/folder/path* (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation.

        Default value - false

      • _headers

         Headers _headers()

        The full set of headers in the parameters, including both fixed and additional headers.

      • _queryParams

         QueryParams _queryParams()

        The full set of query params in the parameters, including both fixed and additional query params.