ImportationJob Class |
Definition of an importation job.
Inheritance HierarchyNamespace: FileHold.LibraryManager
Assembly: FileHold.LibraryManager (in FileHold.LibraryManager.dll) Version: 17.0.0.0
SyntaxC#
public class ImportationJob
The ImportationJob type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ImportationJob | Initializes a new instance of the ImportationJob class |
Properties| Name | Description | |
|---|---|---|
 | Action |
Action which should be performed after successful importation.
|
| CompletedDocuments |
Number of completed documents associated with the job.
|
| CompletedDocumentsSize |
Size of completed documents associated with the job.
|
| ConfigurationErrors |
List of configuration errors.
|
| CreatedBy |
Name of the user who created the job definition.
|
| CurrentDocumentName |
Name of the currently processed document.
|
| CurrentDocumentSize |
Size of the currently processed document.
|
| CurrentDocumentStarted |
Date and time when the current document started processing.
|
| CurrentSourcePath |
Path of the currently processed document.
|
| DateCreated |
Date and time when job definiton was created.
|
| DateModified |
Date and time when job definition was last modified.
|
| Description |
Optional description of the job.
|
| DocumentsPerTrigger |
Optional maximum number of documents imported per trigger. 0 means no limit.
|
| ErrorDocuments |
Number of errors associated with the job.
|
| ErrorDocumentsSize |
Size of documents with errors associated with the job.
|
| HasTimeFrame |
Time limitation. If true, HourFrom and HourTo must be set.
|
| HourFrom |
Start hour of the job (from 0 to 23).
|
| HourTo |
End hour of the job (from 0 to 23).
|
| Id |
Identifier of the job.
|
| IsEnabled |
Enabled/disabled state of the job.
|
| ModifiedBy |
Name of the user who last modified the job definition.
|
| Name |
Name of the job.
|
| PendingDocuments |
Number of pending documents in the job queue.
|
| PendingDocumentsSize |
Size of pending documents in the job queue.
|
| Type |
Type of the job (watched folder or API).
|
| UserContext |
The guid of the user on whose behalf documents are imported.
|
| WatchedFolder |
Definition of watched folder if job type is watched folder.
When job type is watched FTP site, it defines local file processing settings.
|
| WatchedFtpSite |
Definition of watched FTP site if job type is watched FTP site.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertT | (Defined by ObjectExtension.) |
| ToJson | (Defined by ObjectExtension.) |
See Also