ArchiveWriter Module

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter module allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

SecureBlackbox.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Creating or opening the archive.

Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• AddFile - adds an entry with the contents of a local file.
• AddFiles - adds a set of files from a local directory.
• AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.

Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

ArchiveType Property (ArchiveWriter Module)

The type of the archive.

Syntax

• Swift
• Objective-C

public var archiveType: ArchiveWriterArchiveTypes {
  get {...}
}

public enum ArchiveWriterArchiveTypes: Int32 {
  case aftUnknown = 0
  case aftZip = 1
  case aftGzip = 2
  case aftBzip2 = 3
  case aftTar = 4
  case aftTarGzip = 5
  case aftTarBzip2 = 6
  case aftSFX = 7
}

@property (nonatomic,readonly,assign,getter=archiveType) int archiveType;

- (int)archiveType;

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

CompressionAlgorithm Property (ArchiveWriter Module)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

• Swift
• Objective-C

public var compressionAlgorithm: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=compressionAlgorithm,setter=setCompressionAlgorithm:) int compressionAlgorithm;

- (int)compressionAlgorithm;
- (void)setCompressionAlgorithm :(int)newCompressionAlgorithm;

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

CompressionLevel Property (ArchiveWriter Module)

The compression level to apply to the archived data.

Syntax

• Swift
• Objective-C

public var compressionLevel: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=compressionLevel,setter=setCompressionLevel:) int compressionLevel;

- (int)compressionLevel;
- (void)setCompressionLevel :(int)newCompressionLevel;

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

DecryptionCertificates Property (ArchiveWriter Module)

A collection of decryption certificates.

Syntax

• Swift
• Objective-C

public var decryptionCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=decryptionCertCount,setter=setDecryptionCertCount:) int decryptionCertCount;

- (int)decryptionCertCount;
- (void)setDecryptionCertCount :(int)newDecryptionCertCount;

- (NSData*)decryptionCertBytes:(int)decryptionCertIndex;

- (long long)decryptionCertHandle:(int)decryptionCertIndex;
- (void)setDecryptionCertHandle:(int)decryptionCertIndex :(long long)newDecryptionCertHandle;

Default Value

""

Remarks

DecryptionPassword Property (ArchiveWriter Module)

The decryption password.

Syntax

• Swift
• Objective-C

public var decryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=decryptionPassword,setter=setDecryptionPassword:) NSString* decryptionPassword;

- (NSString*)decryptionPassword;
- (void)setDecryptionPassword :(NSString*)newDecryptionPassword;

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

EncryptionAlgorithm Property (ArchiveWriter Module)

Specifies the encryption algorithm to apply to the archive.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm;

- (NSString*)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Class supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

EncryptionCertificate Property (ArchiveWriter Module)

The encryption certificate.

Syntax

• Swift
• Objective-C

public var encryptionCertificate: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=encryptionCertBytes) NSData* encryptionCertBytes;

- (NSData*)encryptionCertBytes;

@property (nonatomic,readwrite,assign,getter=encryptionCertHandle,setter=setEncryptionCertHandle:) long long encryptionCertHandle;

- (long long)encryptionCertHandle;
- (void)setEncryptionCertHandle :(long long)newEncryptionCertHandle;

 

Default Value

""

Remarks

EncryptionKeyLength Property (ArchiveWriter Module)

The length of the encryption key.

Syntax

• Swift
• Objective-C

public var encryptionKeyLength: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionKeyLength,setter=setEncryptionKeyLength:) int encryptionKeyLength;

- (int)encryptionKeyLength;
- (void)setEncryptionKeyLength :(int)newEncryptionKeyLength;

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

EncryptionPassword Property (ArchiveWriter Module)

Specifies the archive encryption password.

Syntax

• Swift
• Objective-C

public var encryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionPassword,setter=setEncryptionPassword:) NSString* encryptionPassword;

- (NSString*)encryptionPassword;
- (void)setEncryptionPassword :(NSString*)newEncryptionPassword;

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

EncryptionType Property (ArchiveWriter Module)

The type of encryption to apply to the archive.

Syntax

• Swift
• Objective-C

public var encryptionType: ArchiveWriterEncryptionTypes {
  get {...}
  set {...}
}

public enum ArchiveWriterEncryptionTypes: Int32 {
  case aetDefault = 0
  case aetNoEncryption = 1
  case aetGeneric = 2
  case aetWinZip = 3
  case aetStrong = 4
}

@property (nonatomic,readwrite,assign,getter=encryptionType,setter=setEncryptionType:) int encryptionType;

- (int)encryptionType;
- (void)setEncryptionType :(int)newEncryptionType;

Default Value

0

Remarks

Specifies the encryption type for the archive.

FileData Property (ArchiveWriter Module)

The contents of the file being added to the archive.

Syntax

• Swift
• Objective-C

public var fileData: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fileData,setter=setFileData:) NSData* fileData;

- (NSData*)fileData;
- (void)setFileData :(NSData*)newFileData;

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

Files Property (ArchiveWriter Module)

Lists the contents of the archive.

Syntax

• Swift
• Objective-C

public var files: Array<ArchivedFile> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=fileCount,setter=setFileCount:) int fileCount;

- (int)fileCount;
- (void)setFileCount :(int)newFileCount;

- (int)fileAction:(int)fileIndex;
- (void)setFileAction:(int)fileIndex :(int)newFileAction;

- (NSString*)fileAttributes:(int)fileIndex;
- (void)setFileAttributes:(int)fileIndex :(NSString*)newFileAttributes;

- (long long)fileCompressedSize:(int)fileIndex;

- (int)fileDataSource:(int)fileIndex;
- (void)setFileDataSource:(int)fileIndex :(int)newFileDataSource;

- (BOOL)fileDirectory:(int)fileIndex;

- (NSString*)fileEncryptionAlgorithm:(int)fileIndex;

- (int)fileEncryptionKeyLength:(int)fileIndex;

- (int)fileEncryptionType:(int)fileIndex;

- (NSString*)fileFileName:(int)fileIndex;
- (void)setFileFileName:(int)fileIndex :(NSString*)newFileFileName;

- (NSString*)fileFolder:(int)fileIndex;

- (NSString*)fileLocalPath:(int)fileIndex;
- (void)setFileLocalPath:(int)fileIndex :(NSString*)newFileLocalPath;

- (NSString*)fileMTime:(int)fileIndex;
- (void)setFileMTime:(int)fileIndex :(NSString*)newFileMTime;

- (BOOL)fileNewFile:(int)fileIndex;

- (NSString*)filePath:(int)fileIndex;

- (int)fileSignatureCount:(int)fileIndex;

- (BOOL)fileSigned:(int)fileIndex;

- (long long)fileSize:(int)fileIndex;

Default Value

""

Remarks

FIPSMode Property (ArchiveWriter Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (ArchiveWriter Module)

Specifies the hash algorithm to be used to generate the signature.

Syntax

• Swift
• Objective-C

public var hashAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hashAlgorithm,setter=setHashAlgorithm:) NSString* hashAlgorithm;

- (NSString*)hashAlgorithm;
- (void)setHashAlgorithm :(NSString*)newHashAlgorithm;

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

NewArchive Property (ArchiveWriter Module)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

• Swift
• Objective-C

public var newArchive: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=newArchive) BOOL newArchive;

- (BOOL)newArchive;

Default Value

False

Remarks

This property is set to true if the archive is new, or to false if the class control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Opened Property (ArchiveWriter Module)

Indicates whether module is currently in edit mode.

Syntax

• Swift
• Objective-C

public var opened: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=opened) BOOL opened;

- (BOOL)opened;

Default Value

False

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Overwrite Property (ArchiveWriter Module)

Whether the module should overwrite existing files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

Enable this property to force overwriting of existing files.

SigningCertificate Property (ArchiveWriter Module)

The certificate to be used for signing.

Syntax

• Swift
• Objective-C

public var signingCertificate: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=signingCertBytes) NSData* signingCertBytes;

- (NSData*)signingCertBytes;

@property (nonatomic,readwrite,assign,getter=signingCertHandle,setter=setSigningCertHandle:) long long signingCertHandle;

- (long long)signingCertHandle;
- (void)setSigningCertHandle :(long long)newSigningCertHandle;

 

Default Value

""

Remarks

SigningChain Property (ArchiveWriter Module)

The signing certificate chain.

Syntax

• Swift
• Objective-C

public var signingChain: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=signingChainCount,setter=setSigningChainCount:) int signingChainCount;

- (int)signingChainCount;
- (void)setSigningChainCount :(int)newSigningChainCount;

- (NSData*)signingChainBytes:(int)signingChainIndex;

- (long long)signingChainHandle:(int)signingChainIndex;
- (void)setSigningChainHandle:(int)signingChainIndex :(long long)newSigningChainHandle;

Default Value

""

Remarks

AddEmptyDir Method (ArchiveWriter Module)

Adds an empty folder to the archive.

Syntax

• Swift
• Objective-C

public func addEmptyDir(path: String) throws -> Int32

- (int)addEmptyDir:(NSString*)path;

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

AddFile Method (ArchiveWriter Module)

Adds a file to the archive.

Syntax

• Swift
• Objective-C

public func addFile(path: String, localPath: String) throws -> Int32

- (int)addFile:(NSString*)path :(NSString*)localPath;

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

AddFiles Method (ArchiveWriter Module)

Adds a group of files to the archive.

Syntax

• Swift
• Objective-C

public func addFiles(folder: String, localPath: String, recursive: Bool) throws -> Void

- (void)addFiles:(NSString*)folder :(NSString*)localPath :(BOOL)recursive;

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

AddVirtual Method (ArchiveWriter Module)

Adds a file placeholder to the archive.

Syntax

• Swift
• Objective-C

public func addVirtual(path: String) throws -> Int32

- (int)addVirtual:(NSString*)path;

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Close Method (ArchiveWriter Module)

Closes the archive.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

- (void)close;

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Config Method (ArchiveWriter Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (ArchiveWriter Module)

Creates a new archive.

Syntax

• Swift
• Objective-C

public func createNew(archiveType: Int32) throws -> Void

- (void)createNew:(int)archiveType;

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

DoAction Method (ArchiveWriter Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Open Method (ArchiveWriter Module)

Opens an archive file.

Syntax

• Swift
• Objective-C

public func open(archiveType: Int32, archiveName: String) throws -> Void

- (void)open:(int)archiveType :(NSString*)archiveName;

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

OpenBytes Method (ArchiveWriter Module)

Loads an archive file from a byte array.

Syntax

• Swift
• Objective-C

public func openBytes(archiveType: Int32, archiveBytes: Data) throws -> Void

- (void)openBytes:(int)archiveType :(NSData*)archiveBytes;

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

Remove Method (ArchiveWriter Module)

Removes file(s) and/or folder(s) from the archive.

Syntax

• Swift
• Objective-C

public func remove(path: String) throws -> Void

- (void)remove:(NSString*)path;

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Reset Method (ArchiveWriter Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

Save Method (ArchiveWriter Module)

Compresses the archive and saves it to a file.

Syntax

• Swift
• Objective-C

public func save(archiveName: String) throws -> Void

- (void)save:(NSString*)archiveName;

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

SaveBytes Method (ArchiveWriter Module)

Compresses the archive and saves it to a byte array.

Syntax

• Swift
• Objective-C

public func saveBytes() throws -> Data

- (NSData*)saveBytes;

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the Save method for the details.

UpdateFile Method (ArchiveWriter Module)

Updates an existing compressed entry with a fresher local version.

Syntax

• Swift
• Objective-C

public func updateFile(path: String, localPath: String) throws -> Void

- (void)updateFile:(NSString*)path :(NSString*)localPath;

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

UpdateFiles Method (ArchiveWriter Module)

Updates a selection of files in the archive.

Syntax

• Swift
• Objective-C

public func updateFiles(folder: String, localPath: String, addMissingFiles: Bool, removeMissingFiles: Bool, recursive: Bool) throws -> Void

- (void)updateFiles:(NSString*)folder :(NSString*)localPath :(BOOL)addMissingFiles :(BOOL)removeMissingFiles :(BOOL)recursive;

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

UpdateVirtual Method (ArchiveWriter Module)

Updates an entry in the archive with on-the-fly content.

Syntax

• Swift
• Objective-C

public func updateVirtual(path: String) throws -> Void

- (void)updateVirtual:(NSString*)path;

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

ActionNeeded Event (ArchiveWriter Module)

Requests a decision from the application in case of a conflict.

Syntax

• Swift
• Objective-C

func onActionNeeded(whatFor: Int32, entryPath: String, destPath: String, description: String, action: inout Int32)

- (void)onActionNeeded:(int)whatFor :(NSString*)entryPath :(NSString*)destPath :(NSString*)description :(int*)action;

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (ArchiveWriter Module)

Marks the completion of compression of a file.

Syntax

• Swift
• Objective-C

func onAfterCompressFile(path: String, fileSize: Int64, dataSource: Int32)

- (void)onAfterCompressFile:(NSString*)path :(long long)fileSize :(int)dataSource;

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

BeforeCompressFile Event (ArchiveWriter Module)

Marks the start of compression of a file.

Syntax

• Swift
• Objective-C

func onBeforeCompressFile(path: String, fileSize: Int64, dataSource: Int32)

- (void)onBeforeCompressFile:(NSString*)path :(long long)fileSize :(int)dataSource;

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (ArchiveWriter Module)

Fires when the component needs a password to decrypt the archive.

Syntax

• Swift
• Objective-C

func onDecryptionPasswordNeeded(passwordTarget: String, cancel: inout Bool)

- (void)onDecryptionPasswordNeeded:(NSString*)passwordTarget :(int*)cancel;

Remarks

Class fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveWriter Module)

Reports information about errors during archive assembling.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveWriter Module)

This event notifies the application about an underlying control flow event.

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (ArchiveWriter Module)

Fires for every file to be compressed before the compression starts.

Syntax

• Swift
• Objective-C

func onPrepareFile(path: String, fileSize: Int64, dataSource: inout Int32, localPath: inout String, action: inout Int32)

- (void)onPrepareFile:(NSString*)path :(long long)fileSize :(int*)dataSource :(NSString**)localPath :(int*)action;

Remarks

Class fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

The Action parameter, which is also tuneable, indicates the action for class to take on the file:

Progress Event (ArchiveWriter Module)

Reports the progress of data compression.

Syntax

• Swift
• Objective-C

func onProgress(processed: Int64, total: Int64, overallProcessed: Int64, overallTotal: Int64, cancel: inout Bool)

- (void)onProgress:(long long)processed :(long long)total :(long long)overallProcessed :(long long)overallTotal :(int*)cancel;

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveWriter Module)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

• Swift
• Objective-C

func onRecipientFound(publicKeyHash: String, certFound: Bool)

- (void)onRecipientFound:(NSString*)publicKeyHash :(BOOL)certFound;

Remarks

The class fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: class won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

ArchivedFile Type

Provides information about the compressed file.

Remarks

Use this type to access compressed file details.

Fields

Constructors

public init()

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public init(stream: )

public init()

Config Settings (ArchiveWriter Module)

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Module)