Back to Search Back to Search Results

OfflinePackage

Represents the status and metadata of an offline package.

Introduced in version 4.1.

Properties

String key
The unique key.
String portalKey
The key of the portal where the package was generated.
String packager
The name of the packager that created the package.
String createdBy
The ID of the authenticated user who built the package.
OfflinePackageDocumentInfo[] documents
The documents that were included in the package.
Map params
The parameters passed to the packager.
Status status
The current status of the package. Values are QUEUED, WORKING, FINISHED, and FAILED.
String scriptOutput
The output log of the packager script.
String filename
The filename used for the package.
String mimeType
The MIME type of the package.
boolean signContents
Whether to generate SHA-512/RSA signatures for each file in the package, as well as the package itself. The default is false . Introduced in version 4.2.
String signaturePathPrefix
If signing package contents, this specifies the path prefix to apply for signature files. this can be used to place signature files in their own folder in the archive. The default is no prefix. Introduced in version 4.2.
String signaturePathSuffix
If signing package contents, this specifies the suffix to add to signature files. The default is ".signature". Introduced in version 4.2.
String signatureAlgorithm
The signing algorithm to use for both the package itself and individual files within the package, if signContents is enabled. The value must match those available in Java; see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#Signature . The default is "SHA512withRSA" . Introduced in version 4.2.
Date createDate
The timestamp when the package was requested.
String statusMessage
The current status message for the package. The package script can update this message as it builds the package in real-time, so this message should reflect the current state of the packaging process.
String hash
The hexadecimal-encoded SHA-512 hash of the package archive. Introduced in version 4.2.
String signature
The hexadecimal-encoded SHA-512/RSA checksum for the zip itself. Introduced in version 4.2.
boolean makeXmlSignatures
Whether to make XML signatures.