Click or drag to resize

IDocStorageService Interface

The interface for services that implement document storage. Note that objects implementing this interface should also implement the IServiceInfo interface required of all platform services.

At this time there are two document storage implementations based on this interface:

  • DBDocStorageViaMapper - Documents are stored in a database using an IMapper configured on the service.
  • S3DocumentStorage - Documents are ultimately stored in Amazon Simple Storage Service (Amazon S3) with local database caching.

Namespace:  NetQuarry.Services
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public interface IDocStorageService

The IDocStorageService type exposes the following members.

Properties
  NameDescription
Public propertyMapperKey
Gets mapper key for this Doc Storage Service.
Public propertyStorageDB
Gets storage database ID for this Doc Storage Service.
Top
Methods
  NameDescription
Public methodDeleteDocuments(IAppContext, ListString)
Deletes documents from the document storage repository.
Public methodDeleteDocuments(IAppContext, String)
Deletes a document from the document storage repository.
Public methodGetDocName
Get the filename of the specified document.
Public methodLoadAttachment
Loads a specific document into a Attachment object.
Public methodLoadAttachmentCollection
Loads documents related to the relatedID param into a collection of Attachment objects.
Public methodLoadDoc
Retieve the specified document as an array of bytes
Public methodSaveDoc(IAppContext, String, String, String, String, String, String, String)
Save a document to the document storage repository. Note, prior to platform v3.5.9 the default behaviour of this method was to delete the source file. Beginning with platform v3.5.9 the default behaviour is to not delete the original source file. Use SaveDoc(IAppContext, String, String, String, String, String, String, String, DocStorageOptions) with DeleteSourceFile if you do want the source file deleted.
Public methodSaveDoc(IAppContext, Stream, InputStreamType, String, String, String, String, String, String)
Save a document to the document storage repository.
Public methodSaveDoc(IAppContext, String, String, String, String, String, String, String, DocStorageOptions)
Save a document to the document storage repository.
Public methodSaveDocumentFromUrl
Save a document to the document storage repository where the source is a URL
Public methodSaveFile
Saves a file to the document storage repository
Public methodSetDocumentType
Sets the application-specific document type for the specified document.
Public methodWriteDocToResponse(IAppContext, String, String, String, Boolean)
Retieve the specified document and write it to the response.
Public methodWriteDocToResponse(IAppContext, String, String, String, Boolean, Int32)
Retieve the specified document and write it to the response.
Top
See Also