Click or drag to resize

DocumentManager Class

Service for performing operations on documents
Inheritance Hierarchy

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

The DocumentManager type exposes the following members.

Constructors
  NameDescription
Public methodDocumentManager
Initializes a new instance of the DocumentManager class
Top
Properties
  NameDescription
Public propertyCustomUser
Top
Methods
  NameDescription
Public methodAddAssembleDocumentsJob
Creates assemble documents job according to provided configuration.
Public methodAddDocument
Adds document to library manager and commits it in document repository. This method is obsolete; AddDocumentInfo() should be used instead.
Public methodAddDocumentInfo(DocumentInfo)
Adds document to library manager with advanced options and commits it in document repository
Public methodAddDocumentInfo(DocumentInfo, Database, DbTransaction)
Public methodAddDocumentLinks
Public methodAddDocumentWithAutoFiling
Adds document to library manager using auto filing script. This method is obsolete; AddDocumentInfo() should be used instead.
Public methodAddLinks
Creates links between documents from selection and specified document
Public methodAddMoveFilesJob(MoveFilesJobData)
Public methodAddMoveFilesJob(MoveFilesJobData, NullableInt32, Database, DbTransaction)
Public methodAddRemoveFavourites
Adds or removes document from favourites
Public methodAddShortcut
Create a shortcut to a document in the given folder.
Public methodAddSnapshotSelection
Public methodAddToFavourites
Public methodAddUsageLogEntry(ActionType, Int32)
Public methodAddUsageLogEntry(ActionType, Int32, Database, DbTransaction, NullableInt32)
Public methodAddUsageLogEntry(ActionType, Int32, String, Database, DbTransaction)
Public methodAddUsageLogEntry(ActionType, Int32, Database, DbTransaction, UsageLogParams, NullableInt32)
Public methodAddUsageLogEntry(ActionType, Int32, Int32, Int32, Database, DbTransaction)
Public methodAddUsageLogEntryForDocument
Add usage log entry for document
Public methodAddUsageLogEntryWithDetails
Public methodArchive
Move the selected document to the Library Archive.
Public methodArchiveDocumentData
Archive all documents on the list. Add batch job to relocate files.
Public methodArchiveDocuments
Public methodArchiveSearchCriteria
Public methodCanCheckOutDocumentsInSelection
Tests if selected documents can be checked out without exceptions.
Public methodChangeDocumentOwner
Public methodChangeDocumentsOwner
Changes owner of the selected documents.
Public methodChangeDocumentType(Int32, DocumentSchemaType)
Change type of single document between electronic document and record.
Public methodChangeDocumentType(Int32, DocumentSchemaType, Database, DbTransaction)
Public methodChangeType
Change type of selected documents between electronic document and record.
Public methodChangeVersionNumber
Public methodCheckAccess
Public methodCheckAccessToDocumentMetadataVersions(Int32, DocumentDataPropertiesToCheck, Boolean)
Public methodCheckAccessToDocumentMetadataVersions(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean)
Public methodCheckAccessToDocumentsAndShortcuts(Int32, DocumentDataPropertiesToCheck, Boolean)
Public methodCheckAccessToDocumentsAndShortcuts(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean, ActionDocumentFinderSnapshot, DocumentData)
Public methodCheckAccessToDocumentVersions(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean)
Public methodCheckAccessToDocumentVersions(Principal, Int32, Boolean, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean)
Public methodCheckAllCanChangeType
Check if all documents can be converted between documents and records.
Public methodCheckAllCanConvertToElectronic
Check if all documents can be converted from offline to electronic.
Public methodCheckAllCanUnArchive
Checks if all selected documents can be un-archived.
Public methodCheckDocumentsInWorkflow
Checks if selected document have an active workflow or are supporting documents.
Public methodCheckDocumentType
Return information about format of given documents.
Public methodCheckIn
Adds new version of document and commits it in document repository
Public methodCheckInDocument(Guid, DocumentManagerCheckInOptions, String, String, Int32, Boolean, Boolean, NullableDocumentSchemaType, Int64, Boolean, NullableDateTime, Database, DbTransaction)
Public methodCheckInDocument(Guid, DocumentManagerCheckInOptions, String, String, Int32, Boolean, Boolean, NullableDocumentSchemaType, Int64, Boolean, Boolean, UsageLogParams, NullableDateTime, Database, DbTransaction)
Public methodCheckInDocumentsWithNoChanges
Cancel check out of selected documents.
Public methodCheckNewOwnerPermissons
Public methodCheckOut
Checks out specified document. Checks all necessary permissions based on calculation from DocumentFinder service.
Public methodCheckOutDocuments
Checks out selected documents
Public methodCheckSelectionContent
Checks whether there are documents in given state in selection
Public methodCheckSelectionDeleted
Check if selection contains any deleted documents.
Public methodCheckSelectionDocumentNumber
Checks if selected documents have document numbers.
Public methodCheckSelectionDocumentType
Return information about format of documents in selection.
Public methodCheckSelectionLocation
Retrieves information about location of document from selection.
Public methodCheckSelectionSchemaType
This method is obsolete.
Public methodCheckShortcutsExist
Return true if at least one shortcut exists in the system.
Public methodCleanUpRemovedDocuments
Permanently delete all documents marked for deletion, their versions, references to them (like virtual folders) etc. Deletes the binary files of the deleted documents. Removes the files from the FTS index.
Public methodConvertToElectronic
Convert offline document to electronic document by checking in a new version.
Public methodConvertToOffline
Convert selected documents to offline documents and delete files from repository.
Public methodConvertToOfflineById
Convert a document to offline document and delete file from repository.
Public methodConvertUtcToLocalDates
Converts UTC to local date and times
Public methodCopy
Copies documents from selection to specified folder
Public methodCopyAllDocumentsInFolder
Public methodCopyAndEdit
Copies documents from selection to specified folder and edit metadata
Public methodCopyDocument
Public methodCopyDocuments
Copies documents to specified folder and optionally change metadata
Public methodCopySelection
Public methodCopyShortcuts
Copies shortcuts to specified folder This method does not check visibility permissions to documents!
Public methodCreateArchiveFolder
Public methodCreateLocation
Public methodCreateSelection(Selection)
Creates selection based on snapshot
Public methodCreateSelection(Selection, Database, DbTransaction)
Public methodCreateSelectionForMetadataVersionIds
Public methodCreateWorkingDocumentSelection
Returns a selection containing the last version of the given document if the given version number is the latest version.
Public methodDeleteDocuments
Deletes documents form selection
Public methodStatic memberFormatValue
Public methodGenerateDocumentNumber
Public methodGetActiveEasyViewWorkflowDocumentsFromSelection
Retrieves names of documents from selection which are associated with Courier view transmissions
Public methodGetActiveWorkflowDocumentsForCheckOut
Public methodGetActiveWorkflowDocumentsFromSelection
Retrieves names of documents from selection which are associated with active workflows
Public methodGetAssembleConfiguration
Provides recently used configuration for documents assembly.
Public methodGetAssembleDocumentsForCourierAction
Retrieves metadata versions of the assembly output documents to be sent in courier transmission.
Public methodGetAssembleDocumentsForViewAction
Retrieves assembly output documents to be opened in viewer.
Public methodGetAssembleDocumentsForWorkflowAction
Retrieves metadata versions of the assembly output documents to be added to workflow.
Public methodGetAssembleDocumentsJob
Provides configuration details of existing assemble job.
Public methodGetAutoTaggingForDocument
Get auto-tagging settings of the folder in which the document is located.
Public methodGetAutoTaggingForFolders(Int32)
Check auto-tagging settings for folders.
Public methodGetAutoTaggingForFolders(Int32, Boolean, Database, DbTransaction)
Public methodGetAutoTaggingForSelection
Check auto-tagging settings for all documents in selection.
Public methodGetBinaryVersionsFromSelection
Returns binary version ids of documents form selection
Public methodGetCheckedOutDocumentsFromSelection
Retrieves names of checked out documents from selection
Public methodGetDocumentFileMetadata(Int32, Int64, String, Int64, DateTime, Int32, Database, DbTransaction)
Public methodGetDocumentFileMetadata(Int32, Int64, String, String, Int64, DateTime, Int32, Database, DbTransaction)
Public methodGetDocumentFileMetadataByDocumentVersionId
Public methodStatic memberGetDocumentFolder
Public methodStatic memberGetDocumentFolderAndName(Int32, String, Int32)
Public methodStatic memberGetDocumentFolderAndName(Int32, String, Int32, Database, DbTransaction)
Public methodGetDocumentId(Int32)
Return the id of the document.
Public methodGetDocumentId(Int32, Database, DbTransaction)
Public methodGetDocumentIdByDocumentVersionId(Int32)
Return the id of the document associated with document version.
Public methodGetDocumentIdByDocumentVersionId(Int32, Database, DbTransaction)
Public methodGetDocumentLatestVersionInfo(Int32)
Return the basic information of the latest version's document.
Public methodGetDocumentLatestVersionInfo(Int32, Database, DbTransaction)
Public methodGetDocumentLink
Returns the URL of the given document in either Web Client or FDA.
Public methodGetDocumentLocation(Int32)
Get cabinet, drawer, (optional) folder group and folder of the document.
Public methodStatic memberGetDocumentLocation(Int32, Boolean, Database, DbTransaction)
Public methodGetDocumentLocationAndArchive
Public methodGetDocumentName(Int32)
Return the name of the given document.
Public methodGetDocumentName(Int32, Database, DbTransaction)
Public methodGetDocumentNameAndSchema
Return the document and schema names of the given metadata version.
Public methodStatic memberGetDocumentNameWithLinks(Int32, String, String, Boolean, Boolean)
Public methodStatic memberGetDocumentNameWithLinks(Int32, Int32, String, String, Boolean, Boolean)
Public methodGetDocumentOwnerGuid(Int32)
Return document owner guid
Public methodGetDocumentOwnerGuid(Int32, Database, DbTransaction)
Public methodGetDocumentsAssociatedWithWorkflows
Public methodGetDocumentSchemaFromSelection
Check document schema in selection (only documents, ignore shortcuts)
Public methodGetDocumentsForUsageLog
Public methodGetDocumentsInSchemas
Returns information about documents from selection in terms of belonging to document schemas
Public methodGetDocumentsInSchemaType
Returns list of documents from selection of particular schema type
Public methodGetDocumentsToAssemble
Checks whether documents in selection can be assembled and returns them in convenient format.
Public methodGetDocumentsToCheckIn
Checks if the selected documents can be checked in and returns detailed information.
Public methodGetDocumentsToDownload
Checks if the selected documents can be downloaded and returns detailed information.
Public methodGetDocumentsToSend
Returns brief information about documents from selection.
Public methodGetDocumentsToView
Checks if the selected documents can be downloaded and returns detailed information.
Public methodGetDocumentsWithCustomNaming
Return a list of documents with custom naming.
Public methodGetDocumentUrl
Returns the URL of the given document in the Web Client.
Public methodGetDocumentUrlByLinkType
Returns the URL of the given document using a predefined document link setting.
Public methodGetDocumentVersionId(Int32, Int32)
Return the version id of the document. If the versionNumber value equals 0 returns the latest one.
Public methodGetDocumentVersionId(Int32, Int32, Database, DbTransaction)
Public methodGetDocumentVersionName(Int32)
Return the name of the given document version.
Public methodGetDocumentVersionName(Int32, Database, DbTransaction)
Public methodGetDocumentVersionsForSelection
Retrieves document versions for selection
Public methodGetDropdownChanges
Public methodGetFileExtensions
Returns collection of file extensions available in the system
Public methodGetFileExtensions(Database, DbTransaction)
Public methodGetFilteredLibraryAuditLogs
Returns information from the library audit log
Public methodGetFTSServiceStatus
Return status of Full Text Search
Public methodGetIdsFromSelection(String, String, Guid, Database, DbTransaction)
Public methodGetIdsFromSelection(String, String, Guid, Boolean, Database, DbTransaction)
Public methodGetLastVisibleVersionsFromSelection
Retrieves names of documents from selection which are in the last visible version and it is not the really last version
Public methodGetLibraryAuditLogs
Returns information from the library audit log
Public methodGetLockedMarkupDocumentsFromSelection
Retrieves names of documents from selection which are associated with locked markups
Public methodGetMoveFilesJobData
Public methodGetNamesFromSelection(Guid, Int32, String, Int32, String)
Public methodGetNamesFromSelection(Guid, Int32, String, Int32, String, Boolean)
Public methodGetNotLastVersionsFromSelection
Retrieves names of documents from selection which are not the last version
Public methodStatic memberGetObjectUrl(String, DocumentManagerNotificationClientType, DocumentManagerNotificationObjectType)
Public methodStatic memberGetObjectUrl(String, Boolean, DocumentManagerNotificationObjectType)
Returns link to a specified object
Public methodStatic memberGetObjectUrl(String, Boolean, Boolean, DocumentManagerNotificationObjectType)
Returns link to a specified object
Public methodStatic memberGetObjectUrlByLinkType
Returns link to a specified object
Public methodGetRepFileDetails
Public methodGetRepFileId
Public methodGetRepFilesSummary
Public methodGetScalarFromSelection
Public methodGetSchemaTypesFromSelection
Returns schemas for all documents from selection
Public methodGetSelectionContent
Returns information about all documents from specified selection
Public methodGetShortcutsFromSelection
Returns list of shortcuts in selection
Public methodGetSingleDocumentToDownload
Checks if the document can be viewed and returns detailed information.
Public methodGetSqlDate
Get current date and time from SQL Server.
Public methodStatic memberGetUrlForDownloads(Boolean)
Public methodStatic memberGetUrlForDownloads(DocumentManagerNotificationClientType)
Public methodGetUserCulture
Public methodGetUtcSqlDate
Get current UTC date and time from SQL Server
Public methodStatic memberGetWC3PathBase
Public methodStatic memberGetWrappedWC2Url
Public methodInternalPrepareDocuments
Public methodInvokeUserAction
Invoke a user action from plug-in.
Public methodIsCheckedOut
Return true if the document is checked out.
Public methodIsCheckedOutBy(Int32)
Return name of the user who checked out the document.
Public methodIsCheckedOutBy(Int32, Int32, String)
Public methodIsCheckedOutBy(Int32, Int32, String, Database, DbTransaction)
Public methodIsDocumentValidAssembleTemplate
Checks whether selected document can be used as template in assemble process.
Public methodIsDocumentVersionDeleted
Public methodMove
Moves documents from selection to specified destination
Public methodMoveAndEdit
Moves documents from selection to specified destination and edit their metadata
Public methodMoveDocuments
Public methodMoveSelection
Public methodMoveShortcuts
Public methodNotifyUsers
Public methodPrepareDocumentsToDownload
Prepares documents to download and creates download token for them.
Public methodPrepareMultipleDocumentsToDownload
Retrieves information about specified documents and creates download tokens for them
Public methodPrepareSingleDocumentToDownload
Retrieves information about specified document and creates download token for it
Public methodPrepareSingleDocumentToDownloadByDocumentVersionId
Retrieves information about specified document and creates download token for it
Public methodPrepareToRename
Public methodRecover
Recovers documents specified by selection
Public methodRecoverDocuments
Public methodReinstateAsLatestVersion(Int32, Boolean)
Reinstate the given binary version as the latest version of the document.
Public methodReinstateAsLatestVersion(Int32, Boolean, Boolean, Database, DbTransaction)
Public methodReinstateAsLatestVersion(Int32, Boolean, Boolean, Boolean, Database, DbTransaction)
Public methodReinstateAsLatestVersionWithMarkup
Reinstate the given binary version as the latest version of the document.
Public methodRemoveAllDocumentVersions
Public methodRemoveDocumentLinks
Public methodRemoveDocumentsAndShortcuts
Public methodRemoveDocumentVersion
Public methodRemoveDocumentVersions
Public methodRemoveFromFavourites
Public methodRemoveLinks
Removes links between documents from selection and specified document
Public methodRemoveSelection
Removes specified selection
Public methodRemoveShortcuts(Int32)
Public methodRemoveShortcuts(IEnumerableInt32, Database, DbTransaction)
Public methodRenameDocuments
Public methodRenamePreparedDocuments
Public methodSendEmail
Public methodSendEmailWithDocuments(String, String, String, String, String, Int32, Int32, Boolean, String)
Sends email with specified documents attached
Public methodSendEmailWithDocuments(String, String, String, String, String, Int32, Int32, Boolean, CultureInfo, Boolean, Database, DbTransaction)
Public methodSetMetadata(Int32, Int32, String, FieldWithValue, Boolean, String)
Adds new or overwrites previous version of document's metadata
Public methodSetMetadata(Int32, Int32, String, FieldWithValue, Boolean, String, Database, DbTransaction)
Public methodSetMultiMetadata
Sets metadata of documents from selection
Public methodUpdateAssembleDocumentsJob
Updates configuration of existing assemble job and moves it to the back of queue. Allowed only for paused jobs.
Public methodUpdateAutoTaggedDocuments
Public methodUpdateDocumentName
Public methodUpdateOriginalFileName
Public methodUpdateRepFileId
Public methodVerifyDocumentsToAssemble
Checks whether documents in selection can be assembled.
Top
Extension Methods
See Also