Click or drag to resize

FileHold.LibraryManager Namespace

Library Manager service
Classes
  ClassDescription
Public classAdminStatusReportCriteria
Public classAdvancedSearchSettings
Misc settings for a user
Public classAlertInfo
Information about document or folder alert.
Public classAlertSettings
Alert settings for current user.
Public classAllowedConversions
Information about allowed type conversions for a document.
Public classAnnotationPresetDetails
Public classAnnotationPresetInfo
Public classAnnotationProperty
Public classAssembleBatchJobData
Public classAssembleConfiguration
Public classAssembleDocument
Public classAssembleWatermark
Public classAuditLog
Public classAuditLogEntry
Public classAutoFilingManager
Service for managing auto-filing scripts and for performing auto-filing
Public classAutoTagging
Auto-tagging settings for a cabinet or folder.
Public classAutoTaggingField
Single metadata field value in auto-tagging settings.
Public classBatchJob
Batch job data used in processing.
Public classBatchJobT
Batch job data used in processing with additonal configuration data specific for job type.
Public classBatchJobData
Public classBatchJobDetails
Detailed batch job information.
Public classBatchJobDocument
Public classBatchJobInfo
Batch job information for report.
Public classBatchJobsManager
Summary description for BatchJobsManager
Public classBatchJobSummary
Batch job summary with only necessary data to perform post-process user actions.
Public classBatchTask
Public classBatchUserAction
Public classCabinet
Class representing a cabinet in the library.
Public classCalendarEntry
Public classCategory
Class representing a folder group (a.k.a. category) in the library.
Public classColumnSelector
A single column to sort or group by.
Public classColumnsWithValues
Search result containing both column definitions and documents.
Public classConnectionStatus
Public classControlFieldDefinition
Definition of a document or version control field.
Public classControlFieldInfo
Information about a document or version control field.
Public classControlFieldOverview
Overview of a document or version control field.
Public classControlFieldSettings
System settings related to document and version control fields.
Public classConvertDate
Public classCultureInfoHelper
Public classCustomDataProvider
Public classCustomNamingPattern
Definition of a custom naming pattern related to a document schema.
Public classDashboardManager
Summary description for DashboardManager
Public classDateTimeFormatCache
Public classDefaultView
Information about default view for given container or object.
Public classDestination
Public classDigitalSignatureManager
Service for managing digital signature settings and agreements.
Public classDisplayFormat
Specification of display formatting for a field definition.
Public classDocumentData
Class representing a single document in search results.
Public classDocumentFinder
Service for searching and retrieving information about documents
Public classDocumentFinderFtsErrorExtendedInfo
Public classDocumentFinderSnapshot
Public classDocumentFinderUnindexedDocumentInformation
Public classDocumentIds
Public classDocumentInfo
Class representing a document to be added.
Public classDocumentInSchema
Helper class for GetDocumentsInSchemas method
Public classDocumentManager
Service for performing operations on documents
Public classDocumentSchema
Class storing definition of a document schema.
Public classDocumentSchemaItem
Class storing name and identifier of a schema.
Public classDocumentSchemaManager
Service for managing document schemas and metadata fields.
Public classDocumentSchemaOverview
Class storing overview of a document schema.
Public classDocumentStatusReportCriteria
Public classDocumentSystemFields
System fields of a document.
Public classDocumentToDownload
Public classDocumentUrlSettings
Document URL settings.
Public classDocumentWithType
Helper class for GetSchemaTypesFromSelection method
Public classDownloadDocument
Information about a document for download.
Public classDrawer
Class representing a drawer in the library
Public classDrilldownFieldChoice
Item of a drill-down metadata field.
Public classDropdownChanges
Public classDropdownFieldChoice
Item of a drop-down metadata field.
Public classEasyPortalAccess
Public classEasyPortalDocument
Public classEasyPortalField
Public classEasyPortalHeader
Public classEasyPortalService
Summary description for EasyPortalService
Public classEasyPortalSession
Public classEasyPortalWorkflow
Public classEasyPortalWorkflowDocument
Public classEasyWorkflowDetails
Public classEasyWorkflowDocumentDetails
Public classEasyWorkflowField
Public classEasyWorkflowLogEntry
Public classEasyWorkflowManager
Service for managing easy workflows.
Public classEasyWorkflowMatrixDetails
Public classEasyWorkflowNotification
Public classEasyWorkflowRecipient
Public classEasyWorkflowRecipientDetails
Public classEasyWorkflowStatusCriteria
Public classEasyWorkflowTaskDetails
Public classEasyWorkflowTemplate
Public classEffectivePermissionEntry
Public classEffectivePermissionsList
Public classEmailDocumentInfo
Information about a document for sending via e-mail
Public classEmailSettings
System settings for outgoing e-mails
Public classEventDefinition
Definition of a scheduled event
Public classEventInfo
Basic information about a scheduled event
Public classEventOverview
Overview of a scheduled event
Public classExistingWorkflowSettings
Public classExternalPortalManager
Summary description for ExternalPortalManager
Public classExtractionManager
Service for managing extraction rules.
Public classExtractionMapping
Public classExtractionMappingItem
Public classExtractionRule
Public classExtractionTemplate
Public classExtractionTemplateItem
Public classExtractionTemplateSet
Public classFastFindSettings
Fast Find settings for a user
Public classFDAAdvancedSettings
FDA Advanced settings for a user
Public classFieldDefinition
Information about a metadata field in search results
Public classFieldInfo
Class storing basic information a field in schema
Public classFieldOverview
Overview of a metadata view
Public classFieldWithValue
Class which stores the id and value of a metadata field.
Public classFileExtension
Helper class for GetFileExtensions method
Public classFolder
Class representing a folder in the library
Public classGlobal
Public classGlobalFieldDefinition
Definition of a metadata field
Public classGlobalSettingsManager
Service for managing system settings.
Public classHostConnectionSettings
Class which stores information necessary to connect to the network host.
Public classImportationJob
Definition of an importation job.
Public classImportationManager
Service for managing and executing Automatic Document Import jobs.
Public classImportJobEntryPathAndId
Public classIncomingEmailSettings
Defines connection settings to the email server.
Public classInternalService
Internal service for communication with other FileHold services.
Public classLibraryObjectInfo
Helper class for ChangeLibraryObjectsOwner method
Public classLibraryObjectStatistics
Class storing statisctics of a library object (folder, folder group, drawer or cabinet)
Public classLibraryStructureManager
Service for managing the library structure.
Public classLibraryStructureManagerADAMOwner
Public classLibraryStructureManagerSearchUsersCriteria
Public classLibraryStructureObject
Base class for all library objects
Public classLoadCriteria
Public classLookupMapping
Public classLookupParameter
Public classLookupSettings
Public classMargin
Structure for margin values
Public classMarkupData
Class representing a viewer markup
Public classMemberInRole
Public classMiscSettings
Misc settings for a user
Public classNamingPatternItem
Public classNodeInfo
Helper class for SaveExpandedNodes method
Public classNotifications
Public classOcrLogCriteria
Public classOcrLogEntry
Public classOcrManager
Summary description for OcrManager
Public classOcrManagerDocumentToOcr
Public classOcrManagerOcrDbObject
Public classOcrManagerOcrTaskQueue
Public classOneWorkflowStatusCriteria
Public classPreviousNextIds
Public classProviderInfo
Public classProviderParam
Public classQueryParameter
Public classQueryParameterDescription
Public classRecipientResponse
Public classReminder
Definition of a document reminder
Public classReminderInfo
Information about a document reminder
Public classReportData
Class representing a Reporting Services report
Public classReportFolder
Class representing a Reporting Services folder
Public classReportForm
Public classReportManager
Service providing integration with Reporting Services.
Public classReportObject
Base class for Reporting Services objects
Public classRestartedWorkflowsReportCriteria
Public classScanningManager
Service for web based scanning and viewing
Public classScanningManagerPublishDocumentInfo
Public classScanningManagerScanningSetting
Public classScanningManagerSubmitDocumentInfo
Public classScheduledTaskManager
Public classScriptManager
Service for managing library scripts
Public classSearchCondition
Class defining a single criterion for a search. There are strict rules of what combinations of type / operators / operands are allowed.
Public classSearchCriteria
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.
Public classSearchLogEntry
Public classSelection
Class used to describe which documents are selected for performing a batch operation. It may include documents from one or more snaphshots.
Public classSelectionItem
Class storing information about a single selected document
Public classSignOffSheetEntry
Public classSmartFolder
Class representing a personal or public smart folder (a.k.a. saved search)
Public classSnapshotSelection
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.
Public classSourceSettings
Public classSqlFunctions
Public classSystemSettings
Structure storing various system settings
Public classTaskInfo
Public classTaskParticipantInfo
Public classTaskParticipantReportCriteria
Public classTaskStatusReportCriteria
Public classUsageLogCriteria
Class used to filter usage log
Public classUsageLogEntry
Class storing information about a signle usage log item
Public classUsageLogParams
Public classUserEmailData
Public classUserFormPanelState
Public classUserLogEntry
Public classUserPreferences
Service for managing user preferences.
Public classUserPreferencesTimeZoneItem
Public classUserProfile
Class storing user preferences
Public classUserStatusReportCriteria
Public classUserWorkflowDetailsPreferences
Public classViewColumn
Class representing a single column of a view.
Public classViewDefinition
Definition of a personal or public view consisting of visible columns, sort order and page size.
Public classViewerDocument
Public classViewerManager
Service for handling document viewer markups.
Public classViewerNotification
Public classViewerNotificationDefinition
Public classViewerNotificationMessage
Public classVirtualFolder
Class representing a personal or public virtual folder
Public classVirtualFolderManager
Service for managing virtual and smart folders and document tray.
Public classWatchedFolder
Watched folder definition for importation job.
Public classWatchedFtpSite
Watched FTP site definition for importation job.
Public classWatermark
Public classWatermarkTemplate
Public classWatermarkTemplateDefinition
Watermark properties definition.
Public classWatermarkTemplateInfo
Public classWindowTemplate
Definition of a template used by the FastFind module
Public classWindowTemplateManager
Service for handling FastFind templates.
Public classWorkflowDashboardItem
Public classWorkflowDashboardReportCriteria
Public classWorkflowDetails
Information about a workflow instance
Public classWorkflowDetailsWithDocumentCount
Public classWorkflowHelpers
Public classWorkflowHistoryDetails
Public classWorkflowHistoryInfo
Public classWorkflowHistoryReportCriteria
Public classWorkflowHistoryTask
Public classWorkflowInitiatorInfo
Public classWorkflowInitiatorsReportCriteria
Public classWorkflowItem
Public classWorkflowManager
Service for managing workflows.
Public classWorkflowManagerWorkflowHistoryChangeEntry
Public classWorkflowNotificationsSettings
Workflow notification setting for a user
Public classWorkflowTaskDetails
Information about a single task in a workflow
Public classWorkflowTaskDetailsWithInternationalization
Internationalization helper for WorkflowTaskDetails
Public classWorkflowTaskParticipantInfoAndCount
Public classWorkflowTemplateInfo
Structures
Enumerations
  EnumerationDescription
Public enumerationAdminStatusReportCriteriaOptionTypes
Workflow Status Report filter options
Public enumerationAlertFrequency
Frequency of alert notifications.
Public enumerationAlignDate
Date alignment used in the definition of event
Public enumerationBlankSpaceAction
Public enumerationCalendarEntryType
Public enumerationControlFieldType
Type of control field.
Public enumerationDateTimeFormat
Public enumerationDefaultViewObjectType
Type of object for which the default view is set.
Public enumerationDelegationStatus
Public enumerationDeletionMode
Public enumerationDigitalSignatureManagerSignatureUrlDestination
Public enumerationDocumentDataPropertiesToCheck
Public enumerationDocumentFinderSnapshotState
Public enumerationDocumentManagerCheckInOptions
Specify the behavior of the CheckIn() method.
Public enumerationDocumentManagerNotificationClientType
Public enumerationDocumentManagerNotificationObjectType
Public enumerationEasyPortalStatus
Public enumerationEasyWorkflowActionType
Public enumerationEasyWorkflowCompletion
Public enumerationEasyWorkflowLogAction
Public enumerationEasyWorkflowLogStatus
Public enumerationEmailEasyWorkflowActionType
Public enumerationEmailReminderFrequency
Frequency of reminder notifications.
Public enumerationEventPeriodType
Period used in the definition of event
Public enumerationEventType
Type of scheduled event
Public enumerationExistingWorkflowFilter
Public enumerationFolderColor
Enum representing color of the folder
Public enumerationLibraryObjectType
Public enumerationLibraryStructureManagerSearchMode
Public enumerationLocationType
Public enumerationLookupParameterType
Public enumerationMembershipType
Public enumerationNodeInfoType
Type of a node represented by NodeInfo structure
Public enumerationNotificationPeriod
Public enumerationNotificationRecipient
Public enumerationNotificationRecipients
Public enumerationNotificationsEasyWorkflowKey
Public enumerationNotificationsWorkflowKey
Public enumerationOcrManagerProcessingPriority
Public enumerationOperator
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
Public enumerationPermissionObjectType
Public enumerationRoleOrigin
Public enumerationRuleType
Public enumerationSearchLogStatus
Public enumerationSearchResultType
Public enumerationSearchType
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)
Public enumerationUserPreferencesDoubleClickActionType
Public enumerationUserPreferencesDownloadPreferences
Public enumerationWorkflowActionType
Public enumerationWorkflowActionTypes
Public enumerationWorkflowDashboardWorkflowSelectionType
Public enumerationWorkflowManagerWorkflowHistoryChangeEntryType
Public enumerationWorkingDocumentsDeleteTriggerConditions