ImportationManager Class

Service for managing and executing Automatic Document Import jobs.

Definition

Namespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.1.0.0
C#
[WebServiceAttribute(Namespace = "http://filehold.com/librarymanager/importationmanager/")]
[WebServiceBindingAttribute(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class ImportationManager : WebService
Inheritance
Object    MarshalByValueComponent    WebService    ImportationManager

Constructors

ImportationManagerInitializes a new instance of the ImportationManager class

Methods

AddImportationJob(ImportationJob) Add an importation job.
AddImportationJob(ImportationJob, Database, DbTransaction) 
AddImportedDocument(Int32, ImportedDocument) Add a pending document to an API based import job.
AddImportedDocument(Int32, ImportedDocument, Database, DbTransaction) 
AddIncomingEmailSettings 
AddWatchedFolderSource 
AddWatchedFtpSite 
CheckImportedDocumentInQueue 
ClearCompletedDocuments Clear completed documents associated with given job.
ClearDocuments 
ClearErrorDocuments Clear documents with error associated with given job.
DeleteImportationJob(Int32) Delete an importation job and all pending documents.
DeleteImportationJob(Int32, Database, DbTransaction) 
DeleteWatchedFolderSource 
GetFirstDocumentFromQueue 
GetImportationJobDetails(Int32) Return the details of specified importation job.
GetImportationJobDetails(Int32, Database, DbTransaction) 
GetImportationJobs Return the list of importation jobs.
GetImportationJobs(Database, DbTransaction) 
GetImportedDocumentDetails(Int32) Return the details of a pending or imported document.
GetImportedDocumentDetails(Int32, Database, DbTransaction) 
GetImportedDocumentPreviousNextIds(Int32, NullableImportedDocumentStatus, Int32, Boolean) Returns previous and next document ids according to the current sort settings
GetImportedDocumentPreviousNextIds(Int32, NullableImportedDocumentStatus, Int32, Boolean, Database, DbTransaction) 
GetImportedDocuments(Int32, Int32, Boolean, Int32, Int32) Return the list of pending and imported documents associated with given job.
GetImportedDocuments(Int32, Int32, Boolean, Int32, Int32, Database, DbTransaction) 
GetImportedDocumentsByStatus(Int32, ImportedDocumentStatus, Int32, Boolean, Int32, Int32) Return the list of documents associated with given job and status.
GetImportedDocumentsByStatus(Int32, ImportedDocumentStatus, Int32, Boolean, Int32, Int32, Database, DbTransaction) 
GetImportedDocumentsByStatusCount(Int32, ImportedDocumentStatus) Return the number of documents associated with given job and status.
GetImportedDocumentsByStatusCount(Int32, ImportedDocumentStatus, Database, DbTransaction) 
GetImportedDocumentsCount(Int32) Return the number of pending and imported documents associated with given job.
GetImportedDocumentsCount(Int32, Database, DbTransaction) 
GetImportedDocumentsSummary 
GetWatchedFoldersToScan 
ImportDocumentToLibrary 
ProcessImportationJobs 
RemoveImportedDocument 
ReprocessDocument 
ReprocessFailedDocuments Makes failed documents back pending. If selected documents comes from watched folder, metadata fields are updated.
RescanFtpFolder 
RescanWatchedFolder(Int32, WatchedFolder) 
RescanWatchedFolder(Int32, WatchedFolder, PostImportAction) 
RescanWatchedFolder(Int32, WatchedFolder, PostImportAction, WatchedFtpSite) 
ResetImportationJob(Int32) Reset an importation job.
ResetImportationJob(Int32, Database, DbTransaction) 
RunJob Rescan the watched folder associated with given job.
SetCurrentImportedDocument 
SetImportedDocumentCompleted 
SetImportedDocumentError 
SetLastEmailLookup(WatchedFtpSite) 
SetLastEmailLookup(WatchedFtpSite, Database, DbTransaction) 
UpdateImportationJob(ImportationJob) Update an existing importation job.
UpdateImportationJob(ImportationJob, Database, DbTransaction) 
UpdateIncomingEmailSettings 
UpdateWatchedFolderSource 
UpdateWatchedFtpSite 
UploadDocument 
VerifyFtpConnection Verifies connection to the FTP site.
VerifyPop3Connection 

Extension Methods

See Also