Click or drag to resize

ImportationManager Class

Service for managing and executing Automatic Document Import jobs.
Inheritance Hierarchy

Namespace:  FileHold.LibraryManager
Assembly:  FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
Syntax
C#
public class ImportationManager : WebService

The ImportationManager type exposes the following members.

Constructors
  NameDescription
Public methodImportationManager
Initializes a new instance of the ImportationManager class
Top
Methods
  NameDescription
Public methodAddImportationJob(ImportationJob)
Add an importation job.
Public methodAddImportationJob(ImportationJob, Database, DbTransaction)
Public methodAddImportedDocument(Int32, ImportedDocument)
Add a pending document to an API based import job.
Public methodAddImportedDocument(Int32, ImportedDocument, Database, DbTransaction)
Public methodAddIncomingEmailSettings
Public methodAddWatchedFolderSource
Public methodAddWatchedFtpSite
Public methodCheckImportedDocumentInQueue
Public methodClearCompletedDocuments
Clear completed documents associated with given job.
Public methodClearDocuments
Public methodClearErrorDocuments
Clear documents with error associated with given job.
Public methodDeleteImportationJob(Int32)
Delete an importation job and all pending documents.
Public methodDeleteImportationJob(Int32, Database, DbTransaction)
Public methodDeleteWatchedFolderSource
Public methodGetFirstDocumentFromQueue
Public methodGetImportationJobDetails(Int32)
Return the details of specified importation job.
Public methodGetImportationJobDetails(Int32, Database, DbTransaction)
Public methodGetImportationJobs
Return the list of importation jobs.
Public methodGetImportationJobs(Database, DbTransaction)
Public methodGetImportedDocumentDetails(Int32)
Return the details of a pending or imported document.
Public methodGetImportedDocumentDetails(Int32, Database, DbTransaction)
Public methodGetImportedDocumentPreviousNextIds(Int32, NullableImportedDocumentStatus, Int32, Boolean)
Returns previous and next document ids according to the current sort settings
Public methodGetImportedDocumentPreviousNextIds(Int32, NullableImportedDocumentStatus, Int32, Boolean, Database, DbTransaction)
Public methodGetImportedDocuments(Int32, Int32, Boolean, Int32, Int32)
Return the list of pending and imported documents associated with given job.
Public methodGetImportedDocuments(Int32, Int32, Boolean, Int32, Int32, Database, DbTransaction)
Public methodGetImportedDocumentsByStatus(Int32, ImportedDocumentStatus, Int32, Boolean, Int32, Int32)
Return the list of documents associated with given job and status.
Public methodGetImportedDocumentsByStatus(Int32, ImportedDocumentStatus, Int32, Boolean, Int32, Int32, Database, DbTransaction)
Public methodGetImportedDocumentsByStatusCount(Int32, ImportedDocumentStatus)
Return the number of documents associated with given job and status.
Public methodGetImportedDocumentsByStatusCount(Int32, ImportedDocumentStatus, Database, DbTransaction)
Public methodGetImportedDocumentsCount(Int32)
Return the number of pending and imported documents associated with given job.
Public methodGetImportedDocumentsCount(Int32, Database, DbTransaction)
Public methodGetImportedDocumentsSummary
Public methodGetWatchedFoldersToScan
Public methodImportDocumentToLibrary
Public methodProcessImportationJobs
Public methodRemoveImportedDocument
Public methodReprocessDocument
Public methodReprocessFailedDocuments
Makes failed documents back pending. If selected documents comes from watched folder, metadata fields are updated.
Public methodRescanFtpFolder
Public methodRescanWatchedFolder(Int32, WatchedFolder)
Public methodRescanWatchedFolder(Int32, WatchedFolder, PostImportAction)
Public methodRescanWatchedFolder(Int32, WatchedFolder, PostImportAction, WatchedFtpSite)
Public methodResetImportationJob(Int32)
Reset an importation job.
Public methodResetImportationJob(Int32, Database, DbTransaction)
Public methodRunJob
Rescan the watched folder associated with given job.
Public methodSetCurrentImportedDocument
Public methodSetImportedDocumentCompleted
Public methodSetImportedDocumentError
Public methodSetLastEmailLookup(WatchedFtpSite)
Public methodSetLastEmailLookup(WatchedFtpSite, Database, DbTransaction)
Public methodUpdateImportationJob(ImportationJob)
Update an existing importation job.
Public methodUpdateImportationJob(ImportationJob, Database, DbTransaction)
Public methodUpdateIncomingEmailSettings
Public methodUpdateWatchedFolderSource
Public methodUpdateWatchedFtpSite
Public methodUploadDocument
Public methodVerifyFtpConnection
Verifies connection to the FTP site.
Public methodVerifyPop3Connection
Top
Extension Methods
See Also