Description:
It is an extension to handing zip file, Create, Add, Extract, Update, Remove files from a zip file, add password protected zip files, Support AesKeyStrength, CompressionLevel, CompressionMethod and EncryptionMethod…more
Request Permissions:
READ_EXTERNAL_STORAGE
WRITE_EXTERNAL_STORAGE
Docs:
Events:-
OnStart
This event is triggered when a specific task identified by its `id` has started or initiated.
- id | text | return the unique identifier that is you initialized it for the zip file.
OnProgress
This event is triggered to report the progress of a specific task identified by its `id`.
- id | text | return the unique identifier that is you initialized it for the zip file.
- percentDone | number | return the percentage of completion for the task.
- fileName | text | return the name of the file or item being processed as part of the task.
- taskType | any | return the type of the task.
@tasks types available: [NONE | ADD_ENTRY | REMOVE_ENTRY | CALCULATE_CRC | EXTRACT_ENTRY | MERGE_ZIP_FILES | SET_COMMENT | RENAME_FILE]
TASK_TYPE_NONE
Returns the constant for the 'NONE' task type in the progress event.
TASK_TYPE_ADD_ENTRY
Returns the constant for the 'ADD_ENTRY' task type in the progress event, It indicates adding an entry to the zip archive.
TASK_TYPE_REMOVE_ENTRY
Returns the constant for the 'REMOVE_ENTRY' task type in the progress event, It indicates removing an entry from the zip archive.
TASK_TYPE_CALCULATE_CRC
Returns the constant for the 'CALCULATE_CRC' task type in the progress event, It indicates calculating CRC (Cyclic Redundancy Check) for an entry in the zip archive.
TASK_TYPE_EXTRACT_ENTRY
Returns the constant for the 'EXTRACT_ENTRY' task type in the progress event, It indicates extracting an entry from the zip archive.
TASK_TYPE_MERGE_ZIP_FILES
Returns the constant for the 'MERGE_ZIP_FILES' task type in the progress event, It indicates merging zip files.
TASK_TYPE_SET_COMMENT
Returns the constant for the 'SET_COMMENT' task type in the progress event, It indicates setting a comment for the zip archive.
TASK_TYPE_RENAME_FILE
Returns the constant for the 'RENAME_FILE' task type in the progress event, It indicates rename files.
OnFinish
This event is triggered when a specific task identified by its `id` has completed successfully.
- id | text | return the unique identifier that is you initialized it for the zip file.
OnFailed
This event is triggered when a specific task identified by its id has encountered an error or failure.
- id | text | return the unique identifier that is you initialized it for the zip file.
- message | text | return descriptive message providing information about the failure.
Methods :-
InitializeZipFile
Initializes a new zip file with the given ID and zip file path.
- id | text | the unique identifier for the zip file.
- zipFilePath | text | the file path where the zip file will be created or accessed.
SetCompressionMethod
Sets the compression method for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- compressionMethod | number | compression method type
@compression methods types available: [DEFLATE | STORE | AES_INTERNAL_ONLY]
COMPRESSION_METHOD_DEFLATE
Returns the constant for DEFLATE compression method.
COMPRESSION_METHOD_STORE
Returns the constant for STORE (no compression) compression method.
COMPRESSION_METHOD_AES_INTERNAL_ONLY
Returns the constant for AES_INTERNAL_ONLY compression method.
SetCompressionLevel
Returns the constant for no compression.
- id | text | the unique identifier that is you set it for the zip file.
- compressionLevel | any | compression level type
@compression level types available: [NO_COMPRESSION | FASTEST | FASTER | FAST | MEDIUM_FAST | NORMAL | HIGHER | MAXIMUM | PRE_ULTRA | ULTRA]
COMPRESSION_LEVEL_NO_COMPRESSION
Returns the constant for no compression.
COMPRESSION_LEVEL_FASTEST
Returns the constant for fastest compression.
COMPRESSION_LEVEL_FASTER
Returns the constant for faster compression.
COMPRESSION_LEVEL_FAST
Returns the constant for fast compression.
COMPRESSION_LEVEL_MEDIUM_FAST
Returns the constant for medium-fast compression.
COMPRESSION_LEVEL_NORMAL
Returns the constant for normal compression.
COMPRESSION_LEVEL_HIGHER
Returns the constant for higher compression.
COMPRESSION_LEVEL_MAXIMUM
Returns the constant for maximum compression.
COMPRESSION_LEVEL_PRE_ULTRA
Returns the constant for pre-ultra compression.
COMPRESSION_LEVEL_ULTRA
Returns the constant for ultra compression.
SetEncryptFiles
Sets whether to encrypt files for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- encryptFiles | boolean | that determines whether files within the specified zip archive should be encrypted or not.
SetEncryptionMethod
Sets the encryption method for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- encryptionMethod | any | encryption method type
@encryption methods types available: [NONE | ZIP_STANDARD | ZIP_STANDARD_VARIANT_STRONG | AES]
ENCRYPTION_METHOD_NONE
Returns the constant for no encryption.
ENCRYPTION_METHOD_ZIP_STANDARD
Returns the constant for standard ZIP encryption.
ENCRYPTION_METHOD_ZIP_STANDARD_VARIANT_STRONG
Returns the constant for strong variant of standard ZIP encryption.
ENCRYPTION_METHOD_AES
Returns the constant for AES encryption.
SetAesKeyStrength
Sets the AES key strength for encryption of the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- aesKeyStrength | any | aes key strength type
@aes key strength types available: [128-bit | 192-bit | 256-bit]
KEY_STRENGTH_128
Returns the AES key strength constant for 128-bit encryption.
KEY_STRENGTH_192
Returns the AES key strength constant for 192-bit encryption.
KEY_STRENGTH_256
Returns the AES key strength constant for 256-bit encryption.
GetFilesNamesList
Gets a list of file names within the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
Return type : list
IsPasswordProtected
Checks if the specified zip archive is password-protected.
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
IsSplitArchive
Checks if the specified zip archive is a split archive.
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
IsValidZipFile
Checks if the specified zip archive is a valid zip file.
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
AddFile
Adds a file to the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- filePath | text | the file path of the file that you want to add to the zip archive.
AddFiles
Adds multiple files to the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- filesPaths | list | the files paths of the files that you want to add to the zip archive.
AddFolder
Adds a folder to the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- folderPath | text | the folder path of the folder that you want to add to the zip archive.
UnZipAll
Extracts all contents of the specified zip archive to the specified destination path.
- id | text | the unique identifier that is you set it for the zip file.
- destinationPath | text | the destination path where the contents of the zip archive will be extracted.
UnZipSingleFileOrFolder
Extracts a single file or folder from the specified zip archive to the specified destination path.
- id | text | the unique identifier that is you set it for the zip file.
- fileOrFolderName | text | the name of the file or folder within the zip archive that you want to extract.
- destinationPath | text | the destination path where the extracted file or folder will be placed..
- newFileOrFolderName | text | a new name for the extracted file or folder.
DeleteFile
Deletes a file from the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- fileName | text | the name of the file within the zip archive that you want to delete.
DeleteFiles
Deletes multiple files from the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- filesNames | list | a list of file names (as texts) that you want to delete from the zip archive.
RenameFile
Renames a file within the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- fileNameToRename | text | the name of the file within the zip archive that you want to rename.
- newFileName | text | the new name that you want to assign to the file within the zip archive.
RenameFiles
Renames multiple files within the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- filesListToRename | list | a list of file names (as texts) that you want to rename within the zip archive.
- newFilesList | list | a list of new file names (as texts) that correspond to the files listed in filesListToRename. Each new name in this list corresponds to a file to be renamed.
CreateSplitZipFile
Creates a split zip file from a list of files.
- id | text | the unique identifier that is you set it for the zip file.
- filesPaths | list | list of file paths (as texts) representing the files to be included in the split zip file.
- splitArchive | boolean | indicating whether the zip archive should be split into multiple segments.
- splitLengthBytes | number | the size, in bytes, at which the zip archive should be split into segments.
CreateSplitZipFileFromFolder
Creates a split zip file from a folder.
- id | text | the unique identifier that is you set it for the zip file.
- folderPath | text | the path to the folder that will be compressed into a split zip file.
- splitArchive | boolean | indicating whether the zip archive should be split into multiple segments.
- splitLengthBytes | number | the size, in bytes, at which the zip archive should be split into segments.
MergeSplitFiles
Merges split archive segments into a single zip file.
- id | text | the unique identifier that is you set it for the zip file.
- mergedZipFile | text | the path to the output merged zip file.
convertStringToBytes
Converts a string value with unit suffix (KB, MB, GB) to bytes.
- value | text | string value to be converted to bytes.
Return type : number
setRunInThread
Sets whether the specified zip archive should run operations in a separate thread.
- id | text | the unique identifier that is you set it for the zip file.
- runInThread | boolean | indicating whether the zip archive should run operations in a separate thread or not.
IsRunInThread
Checks whether the specified zip archive's operations are configured to run in a separate thread.
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
SetPassword
Sets the password for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- password | text | password as a string to be set for the zip archive.
SetComment
Sets the comment for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- comment | text | comment as a string to be set for the zip archive.
GetComment
Gets the comment for the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
Return type : text
setUseUtf8CharsetForPasswords
Sets the usage of UTF-8 charset for passwords in the specified zip archive.
- id | text | the unique identifier that is you set it for the zip file.
- useUtf8 | boolean | indicating whether the zip archive should use UTF-8 charset for passwords or not.
IsUseUtf8CharsetForPasswords
Checks whether the specified zip archive uses UTF-8 charset for passwords.
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
idExists
Check is id initialized before or not
- id | text | the unique identifier that is you set it for the zip file.
Return type : boolean
AIX:
Paid Send PM to buy
Price : 8.5 ~ 10 [Depends on your country]