Catalyst Fire Ignition Documentation
Document
Provides access to DocumentMetadata entities and their corresponding physical files, which are found in various locations throughout iWeb.
Definition
Namespace: Ignition.DocumentManagement
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public class DocumentRepositoryVB
Public Class DocumentRepositoryC++
public ref class DocumentRepositoryF#
type DocumentRepository = class end- Inheritance
- Object DocumentRepository
Remarks
This repository stores physical files in a completely separate location from the one used by iWeb.
Files saved using this repository can only be retrieved via Ignition. The document metadata will be visible in iWeb, but the file itself
will not be downloadable. The reverse is true for documents uploaded via iWeb. The metadatas for those files will be accessible here, but
the physical files will not.
Constructors
| DocumentRepository | Default constructor |
Methods
| GetMetadataByDocumentParent | Retrieves a single DocumentMetadata by an entity that references a single document and implements the IHasDocumentMetadata interface |
| GetMetadataById | Retrieves a single DocumentMetadata by id |
| GetPhysicalFileByDocumentParent | Retrieves a single physical file by an entity that references a single document and implements the IHasDocumentMetadata interface |
| GetPhysicalFileById | Retrieves a single physical file by the id of the DocumentMetadata that represents it |
| SaveCustomerData | Saves a physical file to a special subfolder containing per-customer documents. |
| SaveEventData | Saves a physical file to a special subfolder containing per-event Marketing documents. |
| SaveEventFacultyData | Saves a physical file to a special subfolder containing per-event Faculty documents. |
| SaveEventSponsorData | Saves a physical file to a special subfolder containing per-event Sponsor documents. |
| SaveExhibitSponsorData | Saves a physical file to a special subfolder containing per-exhibit Sponsor documents. |
| TryGetPhysicalFile(DocumentMetadata, PhysicalFile) | Attempts to retrieve the physical file related to a DocumentMetadata |
| TryGetPhysicalFile(IHasDocumentMetadata, PhysicalFile) | Attempts to retrieve a file by an entity that references a the file's DocumentMetadata |