UnZip¶

Extracts the files inside an archive file into the database and returns an array containing file information.

myFiles.UnZip(id: string, separator?: string):Array<FileInfo> (FileInfo)

Parameters¶

string id
    The ID of the archive file.

string separator optional
    The directory separator. Optional. The default value is "\".

Returns¶

An array of FileInfo objects representing the extracted files.

Remarks¶

This function is used to extract the contents of an archive file.

Each non-empty archive entry is saved as a standalone workflow file with application/octet-stream MIME type. Directory and empty entries are skipped, and extracted files are not attached to the source document.

Usage¶

1
2
3
4
5
6
7
8
9

var unzippedFiles = $Files.UnZip(zipFile.Id);
unzippedFiles.forEach(function(file) {
    var fileContent = $Files.GetString(file.Id);
    // do something with the file content
});

// It would be a good practice to delete the archive file when you are finished using it
// since the files in it are also saved by calling the UnZip method
$Files.Delete(zipFile.Id);

See Also¶

• FileInfo
• Array<FileInfo>