...
The media download functionality allows users to download a selection of assets from a portal as a ZIP file. The process involves creating a download request and then retrieving the file through a download link.
The zip will not be created on the server but directly sent to the request flow.
Registering the download request
...
The
download
service lets users retrieve the ZIP file from aportaldownload
instance.The download link uses the UUID of the
portaldownload
instance created during theregister
step.API Example:
GET api/packaged/portals/zip/download/{portalDownloadUUID}
Optional parameter :
filename: Custom name for the ZIP file
Configuration Entry Points
The bulk download functionality on portals uses specific configuration entry points within the cart’s download services to centralize configuration sources.
Profile Settings
When downloading a selection of assets in the portal, the service defaults to the configuration set in the previewsProfiles
parameter of the WXMCART_2
plugin. If this parameter is not accessible, the service will fall back to the following variations, in order: original
and default
.
Info |
---|
The security domain |
Zip File Size Limits
To ensure manageable downloads, the following parameters from the WXMCART_2
plugin define the zip file size thresholds:
zip.maxLength
(Default: 4096 MB): This parameter sets the maximum allowable size for a zip file generated when downloading assets. If the zip exceeds this size, the download is halted.
...
zip.warnLength
(Default: 300 MB): When the zip file size reaches this threshold, a confirmation modal will appear to let the user decide whether to continue with the download.
Info |
---|
When only one asset is selected for download, the service will follow the warning process even if the zip size reaches the |
Internationalization Bundle
The WXMCART_2
plugin provides the internationalization resources used within the zip files downloaded from portals. This ensures that all text and messages within the zip adhere to the localized settings defined by the plugin.
Registered Services
Below is a list of notable services used within the plugin PACKAGED_Portals for the portals feature.
...