FileHold.LibraryManager Namespace

Library Manager service

Classes

AdminStatusReportCriteria 
AdvancedSearchSettings Misc settings for a user
AlertInfo Information about document or folder alert.
AlertSettings Alert settings for current user.
AllowedConversions Information about allowed type conversions for a document.
AnnotationPresetDetails 
AnnotationPresetInfo 
AnnotationProperty 
AssembleBatchJobData 
AssembleConfiguration 
AssembleDocument 
AssembleWatermark 
AuditLog 
AuditLogEntry 
AutoFilingManager Service for managing auto-filing scripts and for performing auto-filing
AutoTagging Auto-tagging settings for a cabinet or folder.
AutoTaggingField Single metadata field value in auto-tagging settings.
BatchJob Batch job data used in processing.
BatchJobT Batch job data used in processing with additonal configuration data specific for job type.
BatchJobData 
BatchJobDetails Detailed batch job information.
BatchJobDocument 
BatchJobInfo Batch job information for report.
BatchJobsManager Summary description for BatchJobsManager
BatchJobSummary Batch job summary with only necessary data to perform post-process user actions.
BatchTask 
BatchUserAction 
Cabinet Class representing a cabinet in the library.
CalendarEntry 
Category Class representing a folder group (a.k.a. category) in the library.
ColumnSelector A single column to sort or group by.
ColumnsWithValues Search result containing both column definitions and documents.
ConnectionStatus 
ControlFieldDefinition Definition of a document or version control field.
ControlFieldInfo Information about a document or version control field.
ControlFieldOverview Overview of a document or version control field.
ControlFieldSettings System settings related to document and version control fields.
ConvertDate 
CultureInfoHelper 
CustomDataProvider 
CustomNamingPattern Definition of a custom naming pattern related to a document schema.
CustomReport 
DashboardManager Summary description for DashboardManager
DateTimeFormatCache 
DefaultView Information about default view for given container or object.
DeltaResultT 
Destination 
DigitalSignatureManager Service for managing digital signature settings and agreements.
DisplayFormat Specification of display formatting for a field definition.
DocumentData Class representing a single document in search results.
DocumentFinder Service for searching and retrieving information about documents
DocumentFinderFtsErrorExtendedInfo 
DocumentFinderSnapshot 
DocumentFinderUnindexedDocumentInformation 
DocumentIds 
DocumentInfo Class representing a document to be added.
DocumentInSchema Helper class for GetDocumentsInSchemas method
DocumentManager Service for performing operations on documents
DocumentSchema Class storing definition of a document schema.
DocumentSchemaItem Class storing name and identifier of a schema.
DocumentSchemaManager Service for managing document schemas and metadata fields.
DocumentSchemaOverview Class storing overview of a document schema.
DocumentStatusReportCriteria 
DocumentSystemFields System fields of a document.
DocumentToDownload 
DocumentUrlSettings Document URL settings.
DocumentWithType Helper class for GetSchemaTypesFromSelection method
DownloadDocument Information about a document for download.
Drawer Class representing a drawer in the library
DrilldownFieldChoice Item of a drill-down metadata field.
DropdownChanges 
DropdownFieldChoice Item of a drop-down metadata field.
EasyPortalAccess 
EasyPortalDocument 
EasyPortalField 
EasyPortalHeader 
EasyPortalService Summary description for EasyPortalService
EasyPortalSession 
EasyPortalWorkflow 
EasyPortalWorkflowDocument 
EasyWorkflowDetails 
EasyWorkflowDocumentDetails 
EasyWorkflowField 
EasyWorkflowLogEntry 
EasyWorkflowManager Service for managing easy workflows.
EasyWorkflowMatrixDetails 
EasyWorkflowNotification 
EasyWorkflowRecipient 
EasyWorkflowRecipientDetails 
EasyWorkflowStatusCriteria 
EasyWorkflowTaskDetails 
EasyWorkflowTemplate 
EffectivePermissionEntry 
EffectivePermissionsList 
EmailDocumentInfo Information about a document for sending via e-mail
EmailSettings System settings for outgoing e-mails
EventDefinition Definition of a scheduled event
EventInfo Basic information about a scheduled event
EventOverview Overview of a scheduled event
ExistingWorkflowSettings 
ExternalPortalManager Summary description for ExternalPortalManager
ExtractionManager Service for managing extraction rules.
ExtractionMapping 
ExtractionMappingItem 
ExtractionRule 
ExtractionTemplate 
ExtractionTemplateItem 
ExtractionTemplateSet 
FastFindSettings Fast Find settings for a user
FDAAdvancedSettings FDA Advanced settings for a user
FieldDefinition Information about a metadata field in search results
FieldInfo Class storing basic information a field in schema
FieldOverview Overview of a metadata view
FieldWithValue Class which stores the id and value of a metadata field.
FileExtension Helper class for GetFileExtensions method
Folder Class representing a folder in the library
Global 
GlobalFieldDefinition Definition of a metadata field
GlobalSettingsManager Service for managing system settings.
HostConnectionSettings Class which stores information necessary to connect to the network host.
ImportationJob Definition of an importation job.
ImportationManager Service for managing and executing Automatic Document Import jobs.
ImportJobEntryPathAndId 
IncomingEmailSettings Defines connection settings to the email server.
InternalService Internal service for communication with other FileHold services.
LibraryIdentity 
LibraryObjectInfo Helper class for ChangeLibraryObjectsOwner method
LibraryObjectStatistics Class storing statisctics of a library object (folder, folder group, drawer or cabinet)
LibraryStructureManager Service for managing the library structure.
LibraryStructureManagerADAMOwner 
LibraryStructureManagerSearchUsersCriteria 
LibraryStructureObject Base class for all library objects
LifecycleDeleteQueueStatistic 
LifecycleEventProperties 
LifecycleEventStatistic 
LoadCriteria 
LookupMapping 
LookupParameter 
LookupSettings 
ManagedOptionsProvider 
Margin Structure for margin values
MarkupData Class representing a viewer markup
MemberInRole 
MiscSettings Misc settings for a user
NamingPatternItem 
NodeInfo Helper class for SaveExpandedNodes method
Notifications 
OcrLogCriteria 
OcrLogEntry 
OcrManager Summary description for OcrManager
OcrManagerDocumentToOcr 
OcrManagerOcrDbObject 
OcrManagerOcrTaskQueue 
OneWorkflowStatusCriteria 
PreviousNextIds 
ProviderInfo 
ProviderParam 
QueryParameter 
QueryParameterDescription 
RecipientResponse 
Reminder Definition of a document reminder
ReminderInfo Information about a document reminder
ReportData Class representing a Reporting Services report
ReportFolder Class representing a Reporting Services folder
ReportForm 
ReportManager Service providing integration with Reporting Services.
ReportObject Base class for Reporting Services objects
RestartedWorkflowsReportCriteria 
ScanningManager Service for web based scanning and viewing
ScanningManagerPublishDocumentInfo 
ScanningManagerScanningSetting 
ScanningManagerSubmitDocumentInfo 
ScheduledTaskManager 
ScriptManager Service for managing library scripts
SearchCondition Class defining a single criterion for a search. There are strict rules of what combinations of type / operators / operands are allowed.
SearchCriteria This class describes search criteria for DocumentFinder.GetDocument method. Search should be understood widely, providing documents from user's tray or details for a specific document are also some types of search. Objects of this class fully describe criteria for a request for getting some file list.
SearchLogEntry 
Selection Class used to describe which documents are selected for performing a batch operation. It may include documents from one or more snaphshots.
SelectionItem Class storing information about a single selected document
SignOffSheetEntry 
SimpleReport 
SimpleReportResult 
SmartFolder Class representing a personal or public smart folder (a.k.a. saved search)
SnapshotSelection Class used to describe which documents are selected in a single snapshot. It is possilbe to select some or all documents in the snapshot, or to select all documents exluding some unselected ones.
SourceSettings 
SqlFunctions 
SystemSettings Structure storing various system settings
TaskInfo 
TaskParticipantInfo 
TaskParticipantReportCriteria 
TaskStatusReportCriteria 
TeamsManager Service for managing connection with Microsoft Teams via Graph API
UsageLogCriteria Class used to filter usage log
UsageLogEntry Class storing information about a signle usage log item
UsageLogParams 
UserEmailData 
UserFormPanelState 
UserLogEntry 
UserPreferences Service for managing user preferences.
UserPreferencesTimeZoneItem 
UserProfile Class storing user preferences
UserStatusReportCriteria 
UserWorkflowDetailsPreferences 
ViewColumn Class representing a single column of a view.
ViewDefinition Definition of a personal or public view consisting of visible columns, sort order and page size.
ViewerDocument 
ViewerManager Service for handling document viewer markups.
ViewerNotification 
ViewerNotificationDefinition 
ViewerNotificationMessage 
VirtualFolder Class representing a personal or public virtual folder
VirtualFolderManager Service for managing virtual and smart folders and document tray.
WatchedFolder Watched folder definition for importation job.
WatchedFtpSite Watched FTP site definition for importation job.
Watermark 
WatermarkTemplate 
WatermarkTemplateDefinition Watermark properties definition.
WatermarkTemplateInfo 
WindowTemplate Definition of a template used by the FastFind module
WindowTemplateManager Service for handling FastFind templates.
WorkflowDashboardItem 
WorkflowDashboardReportCriteria 
WorkflowDetails Information about a workflow instance
WorkflowDetailsWithDocumentCount 
WorkflowHelpers 
WorkflowHistoryDetails 
WorkflowHistoryInfo 
WorkflowHistoryReportCriteria 
WorkflowHistoryTask 
WorkflowInitiatorInfo 
WorkflowInitiatorsReportCriteria 
WorkflowItem 
WorkflowManager Service for managing workflows.
WorkflowManagerWorkflowHistoryChangeEntry 
WorkflowNotificationsSettings Workflow notification setting for a user
WorkflowTaskDetails Information about a single task in a workflow
WorkflowTaskDetailsWithInternationalization Internationalization helper for WorkflowTaskDetails
WorkflowTaskParticipantInfoAndCount 
WorkflowTemplateInfo 

Structures

Enumerations

AdminStatusReportCriteriaOptionTypes Workflow Status Report filter options
AlertFrequency Frequency of alert notifications.
AlignDate Date alignment used in the definition of event
BlankSpaceAction 
CalendarEntryType 
ControlFieldType Type of control field.
DateTimeFormat 
DefaultViewObjectType Type of object for which the default view is set.
DelegationStatus 
DeletionMode 
DigitalSignatureManagerSignatureUrlDestination 
DocumentDataPropertiesToCheck 
DocumentFinderSnapshotState 
DocumentManagerCheckInOptions Specify the behavior of the CheckIn() method.
DocumentManagerNotificationClientType 
DocumentManagerNotificationObjectType 
EasyPortalStatus 
EasyWorkflowActionType 
EasyWorkflowCompletion 
EasyWorkflowLogAction 
EasyWorkflowLogStatus 
EmailEasyWorkflowActionType 
EmailReminderFrequency Frequency of reminder notifications.
EmailServerSettingsType 
EventPeriodType Period used in the definition of event
EventType Type of scheduled event
ExistingWorkflowFilter 
FolderColor Enum representing color of the folder
LibraryObjectType 
LibraryStructureManagerSearchMode 
LocationType 
LookupParameterType 
MembershipType 
NodeInfoType Type of a node represented by NodeInfo structure
NotificationPeriod 
NotificationRecipient 
NotificationRecipients 
NotificationsEasyWorkflowKey 
NotificationsWorkflowKey 
OcrManagerProcessingPriority 
Operator List of all operands. Operator decides (in addition to searchType) how many operands are required for the search condition. All operators except Between and InList require 1 operand. Between requires 2 operands, InList requires >0 operands. S-OP-110
PermissionObjectType 
RoleOrigin 
RuleType 
SearchLogStatus 
SearchResultType 
SearchType List of all condition types. Required operators and operands are described for each type in format (S-FM-100): allowed operator(s) / type of parameters (number of parameters is defined by the operator)
UserPreferencesDoubleClickActionType 
UserPreferencesDownloadPreferences 
WorkflowActionType 
WorkflowActionTypes 
WorkflowDashboardWorkflowSelectionType 
WorkflowManagerWorkflowHistoryChangeEntryType 
WorkingDocumentsDeleteTriggerConditions