mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
2.5 KiB
2.5 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Download zip service | v2.0.0 | Active | 2019-01-08 |
Download zip service
Creates and manages downloads.
Class members
Methods
- cancelDownload(downloadId:
string)
Cancels a download.- downloadId:
string- ID of the target download node
- downloadId:
- createDownload(payload:
DownloadBodyCreate):Observable<DownloadEntry>
Creates a new download.- payload:
DownloadBodyCreate- Object containing the node IDs of the items to add to the ZIP file - Returns
Observable<DownloadEntry>- Status object for the download
- payload:
- getDownload(downloadId:
string):Observable<DownloadEntry>
Gets status information for a download node.- downloadId:
string- ID of the download node - Returns
Observable<DownloadEntry>- Status object for the download
- downloadId:
Details
Use createDownload to create a node that will represent the downloadable
ZIP data. The ZIP archive includes the content of all node IDs passed in via
the DownloadBodyCreate parameter.
The DownloadEntry object returned by createDownload has an
id field that you can use to identify the download node (eg,
to cancel it later or get the node URL when the download is complete) and
other information about the progress of the download.