Returns a download URL for downloading a folder from the Media Manager.
The downloadFolder()
function returns a Promise that resolves to a download URL
for a Media Manager folder's files and sub-folders.
A compressed file is created and can be downloaded using the download URL. The compressed file can contain up to 1000 files. Sub-folders are included. The name of the top-level folder requested for download isn't included.
Call the wix-location.to()
function with
the returned download URL as the external web address. This opens the Download bar in your browser.
This function provides a permanent URL for downloading a folder.
To get a temporary download URL for a single file, use the getDownloadUrl()
function.
function downloadFolder(folderId: string): Promise<string>;
The ID of the folder to download. You can get the ID with the
folderId
property of the listFolders()
function.
import { Permissions, webMethod } from "wix-web-module";
import { mediaManager } from "wix-media-backend";
/* Sample folderId value:
* '0abec0_bed6f8efb53348379b2011514254e954'
*/
export const myDownloadFolderFunction = webMethod(
Permissions.Anyone,
(folderId) => {
return mediaManager
.downloadFolder(folderId)
.then((downloadUrl) => {
return downloadUrl;
})
.catch((error) => {
console.error(error);
});
},
);
/* Promise resolves to a download URL similar to:
* 'https://archive.wixmp.com/archive/wix/2d8d9ffc016c443387e42abf8e459c66'
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.