Archive |
Archive top level content.
Inheritance HierarchySystemObject
OpenDiscoverSDK.Interfaces.ContentDocumentContent
OpenDiscoverSDK.Interfaces.ContentArchiveContent
OpenDiscoverSDK.Interfaces.ContentDocumentContent
OpenDiscoverSDK.Interfaces.ContentArchiveContent
Namespace: OpenDiscoverSDK.Interfaces.Content
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
SyntaxC#
[DataContractAttribute] public class ArchiveContent : DocumentContent
The ArchiveContent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ArchiveContent | Default constructor. |
| ArchiveContent(IdResult) | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | Attributes |
Document attributes. See DocumentAttributes for an enumeration of supported attributes.
(Inherited from DocumentContent) |
| ChildDocuments |
Child documents (attachments/embedded items). See remarks for the special cases of archives (.7z, zip, etc), media images, and mail stores (.pst, .ost, .mbox, etc.).
(Inherited from DocumentContent) |
| CustomMetadata |
Contains custom (user-defined) document metadata as a dictionary of metadata field names as keys and metadata field data as corresponding values.
(Inherited from DocumentContent) |
| EntityExtractionResult |
Document entity item extraction result.
(Inherited from DocumentContent) |
| ErrorMessage |
Gets or sets an error message associated with Result. This property is only set when Result is not set to Ok.
(Inherited from DocumentContent) |
| ErrorStackTrace |
Error (exception) stack trace associated with ErrorMessage. This property is only set when Result is not Ok
and if an internal exception was caught.
(Inherited from DocumentContent) |
| ExtractedText |
Extracted text, see remarks for limitations.
(Inherited from DocumentContent) |
| FileEntropy |
Shannon entropy of the document's bytes.
(Inherited from DocumentContent) |
| FormatId |
Document format identification result from prior file identification (this object value was an input to content extractor factory and
stored here for convenience).
(Inherited from DocumentContent) |
| HasEncryptedItems | True if any archive items are password protected (encrypted). |
| HyperLinks |
Document hyperlinks.
(Inherited from DocumentContent) |
| IsEmailType |
If true, this document is an email document. This DocumentContent object should be cast to a EmailDocumentContent to
get additional email document specific properties.
(Inherited from DocumentContent) |
| IsEncrypted |
Document is encrypted if this property is true.
(Inherited from DocumentContent) |
| IsHtmlType |
If true, document is an HTML document. This DocumentContent object should be cast to a HtmlDocumentContent to
get additional HTML document specific properties.
(Inherited from DocumentContent) |
| IsPdfType |
If true, document is an PDF document. This DocumentContent object should be cast to a PdfDocumentContent to
get additional PDF document specific properties.
(Inherited from DocumentContent) |
| ItemCount | The total archive item count. This count includes only file items and not directory items. |
| LanguageIdResults |
Extracted text language identification results.
(Inherited from DocumentContent) |
| MD5BinaryHash |
MD5 binary document hash (hash of all document bytes).
(Inherited from DocumentContent) |
| MD5ContentHash |
MD5 content hash is a proprietary hash on only the content of a document file format.
(Inherited from DocumentContent) |
| Metadata |
Contains standard (non-user-defined) document metadata as a dictionary of metadata field names as keys and metadata field data as corresponding values.
(Inherited from DocumentContent) |
| Password |
The password found to decrypt the document by cycling through supplied password list.
(Inherited from DocumentContent) |
| Result |
Gets or sets the result of the content extraction. Check this value to see if content extraction was successful.
(Inherited from DocumentContent) |
| Root | Archive internal directory (folders) structure. |
| SHA1BinaryHash |
SHA-1 binary document hash (hash of all document bytes).
(Inherited from DocumentContent) |
| SHA1ContentHash |
SHA-1 content hash is a proprietary hash on only the content part of document file format.
(Inherited from DocumentContent) |
| SHA256BinaryHash |
SHA-256 binary document hash (hash of all document bytes).
(Inherited from DocumentContent) |
| SHA256ContentHash |
SHA-256 content hash is a proprietary hash on only the content part of document file format.
(Inherited from DocumentContent) |
| TextSourceType |
Gets or sets the method of the acquired document text (if any).
(Inherited from DocumentContent) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Remarks
This class returns the folder internal hierarchy of an archive (if defined and supported by the format) and the count
of stored items contained in the archive. To extract the items contained by the archive see the various interface
methods defined in IArchiveExtractor.
See Also