[WebServiceAttribute(Namespace = "http://filehold.com/librarymanager/documentmanager/")]
[WebServiceBindingAttribute(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class DocumentManager : WebService
DocumentManager | Initializes a new instance of the DocumentManager class |
AddAssembleDocumentsJob | Creates assemble documents job according to provided configuration. |
AddDocument | Adds document to library manager and commits it in document repository. This method is obsolete; AddDocumentInfo() should be used instead. |
AddDocumentInfo(DocumentInfo) | Adds document to library manager with advanced options and commits it in document repository |
AddDocumentInfo(DocumentInfo, Database, DbTransaction) | |
AddDocumentLinks | |
AddDocumentWithAutoFiling | Adds document to library manager using auto filing script. This method is obsolete; AddDocumentInfo() should be used instead. |
AddLinks | Creates links between documents from selection and specified document |
AddMoveFilesJob(MoveFilesJobData) | Creates a repository batch job according to provided configuration. |
AddMoveFilesJob(MoveFilesJobData, NullableInt32, Database, DbTransaction) | |
AddRemoveFavourites | Adds or removes document from favourites |
AddShortcut | This method is obsolete and always throws an error. |
AddSnapshotSelection | |
AddToFavourites | |
AddUsageLogEntry(ActionType, Int32) | |
AddUsageLogEntry(ActionType, Int32, Int32, Int32, Database, DbTransaction) | |
AddUsageLogEntry(ActionType, Int32, Int32, Database, DbTransaction, UsageLogParams, NullableInt32) | |
AddUsageLogEntryByDocumentVersionId(Int32, ActionType) | Add usage log entry for document |
AddUsageLogEntryByDocumentVersionId(ActionType, Int32, Database, DbTransaction, UsageLogParams, NullableInt32) | |
AddUsageLogEntryByMetadataVersionId(ActionType, Int32, Database, DbTransaction, NullableInt32) | |
AddUsageLogEntryByMetadataVersionId(ActionType, Int32, String, Database, DbTransaction) | |
AddUsageLogEntryByMetadataVersionId(ActionType, Int32, Database, DbTransaction, UsageLogParams, NullableInt32) | |
AddUsageLogEntryForDocument | Add usage log entry for document |
AddUsageLogEntryWithDetails | |
Archive | Move the selected document to the Library Archive. |
ArchiveDocumentData | Archive all documents on the list. Add batch job to relocate files. For use with application server plug-ins only. |
ArchiveDocuments | |
ArchiveSearchCriteria | |
CanCheckOutDocumentsInSelection | Tests if selected documents can be checked out without exceptions. |
CanCheckOutDocumentsInSelectionV2 | Tests if selected documents can be checked out and do not throw exception. |
ChangeDocumentOwner | |
ChangeDocumentsOwner | Changes owner of the selected documents. |
ChangeDocumentType(Int32, DocumentSchemaType) | Change type of single document between electronic document and record. |
ChangeDocumentType(Int32, DocumentSchemaType, Database, DbTransaction) | |
ChangeType | Change type of selected documents between electronic document and record. |
ChangeVersionNumber | |
CheckAccess | |
CheckAccessToDocumentMetadataVersions(Int32, DocumentDataPropertiesToCheck, Boolean) | |
CheckAccessToDocumentMetadataVersions(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean) | |
CheckAccessToDocumentsAndShortcuts(Int32, DocumentDataPropertiesToCheck, Boolean) | |
CheckAccessToDocumentsAndShortcuts(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean, ActionDocumentFinderSnapshot, DocumentData) | |
CheckAccessToDocumentVersions(Int32, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean) | |
CheckAccessToDocumentVersions(Principal, Int32, Boolean, DocumentDataPropertiesToCheck, Database, DbTransaction, Boolean) | |
CheckAllCanChangeType | Check if all documents can be converted between documents and records. |
CheckAllCanConvertToElectronic | Check if all documents can be converted from offline to electronic. |
CheckAllCanUnArchive | Checks if all selected documents can be un-archived. |
CheckDocumentsInWorkflow | Checks if selected document have an active workflow or are supporting documents. |
CheckDocumentType | Return information about format of given documents. |
CheckIn | Adds new version of document and commits it in document repository |
CheckInDocument(Guid, DocumentManagerCheckInOptions, String, String, Int32, Boolean, Boolean, NullableDocumentSchemaType, Int64, Boolean, NullableDateTime, Database, DbTransaction) | |
CheckInDocument(Guid, DocumentManagerCheckInOptions, String, String, Int32, Boolean, Boolean, NullableDocumentSchemaType, Int64, Boolean, Boolean, UsageLogParams, NullableDateTime, Database, DbTransaction) | |
CheckInDocumentsWithNoChanges | Cancel check out of selected documents. |
CheckNewOwnerPermissons | |
CheckOut | Checks out specified document. For use with application server plug-ins only. Checks all necessary permissions based on calculation from DocumentFinder service. |
CheckOutDocuments | Checks out selected documents |
CheckSelectionContent | Checks whether there are documents in given state in selection |
CheckSelectionDeleted | Check if selection contains any deleted documents. |
CheckSelectionDocumentNumber | Checks if selected documents have document numbers. |
CheckSelectionDocumentType | Return information about format of documents in selection. |
CheckSelectionLocation | Retrieves information about location of document from selection. |
CheckSelectionSchemaType | This method is obsolete. |
CheckShortcutsExist | This method is obsolete and always returns false. |
CleanUpRemovedDocuments | Permanently delete all documents marked for deletion, their versions, references to them (like virtual folders) etc. For use with application server plug-ins only. Deletes the binary files of the deleted documents. Removes the files from the FTS index. |
ConvertToElectronic | Convert offline document to electronic document by checking in a new version. |
ConvertToOffline | Convert selected documents to offline documents and delete files from repository. |
ConvertToOfflineById | Convert a document to offline document and delete file from repository. |
ConvertUtcToLocalDates | Converts UTC to local date and times |
Copy | Copies documents from selection to specified folder |
CopyAllDocumentsInFolder | |
CopyAndEdit | Copies documents from selection to specified folder and edit metadata |
CopyDocument | |
CopyDocuments | Copies documents to specified folder and optionally change metadata. For use with application server plug-ins only. |
CopySelection | |
CreateArchiveFolder | |
CreateLocation | Create library location using an auto-filing script. |
CreateSelection(Selection) | Creates selection based on snapshot |
CreateSelection(Selection, Database, DbTransaction) | |
CreateSelectionForMetadataVersionIds | Create a selection based on metadata version IDs. |
CreateWorkingDocumentSelection | Returns a selection containing the last version of the given document if the given version number is the latest version. |
DeleteDocuments | Deletes documents form selection |
FormatValue | |
GenerateDocumentNumber | |
GetActiveEasyViewWorkflowDocumentsFromSelection | Retrieves names of documents from selection which are associated with Courier view transmissions |
GetActiveWorkflowDocumentsForCheckOut | |
GetActiveWorkflowDocumentsFromSelection | Retrieves names of documents from selection which are associated with active workflows |
GetAssembleConfiguration | Provides recently used configuration for documents assembly. |
GetAssembleDocumentsForCourierAction | Retrieves metadata versions of the assembly output documents to be sent in courier transmission. |
GetAssembleDocumentsForViewAction | Retrieves assembly output documents to be opened in viewer. |
GetAssembleDocumentsForWorkflowAction | Retrieves metadata versions of the assembly output documents to be added to workflow. |
GetAssembleDocumentsJob | Provides configuration details of existing assemble job. |
GetAutoTaggingForDocument | Get auto-tagging settings of the folder in which the document is located. |
GetAutoTaggingForFolders(Int32) | Check auto-tagging settings for folders. |
GetAutoTaggingForFolders(Int32, Boolean, Database, DbTransaction) | |
GetAutoTaggingForSelection | Check auto-tagging settings for all documents in selection. |
GetBinaryVersionsFromSelection | Returns binary version ids of documents form selection |
GetCheckedOutDocumentsFromSelection | Retrieves names of checked out documents from selection |
GetDocumentFileMetadata(Int32, Int64, String, Int64, DateTime, Int32, Database, DbTransaction) | |
GetDocumentFileMetadata(Int32, Int64, String, String, Int64, DateTime, Int32, Database, DbTransaction) | |
GetDocumentFileMetadataByDocumentVersionId | |
GetDocumentFolder | |
GetDocumentFolderAndName(Int32, String, Int32) | |
GetDocumentFolderAndName(Int32, String, Int32, Database, DbTransaction) | |
GetDocumentId(Int32) | Return the id of the document. |
GetDocumentId(Int32, Database, DbTransaction) | |
GetDocumentIdByDocumentVersionId(Int32) | Return the id of the document associated with document version. |
GetDocumentIdByDocumentVersionId(Int32, Database, DbTransaction) | |
GetDocumentLatestVersionInfo(Int32) | Return the basic information of the latest version's document. |
GetDocumentLatestVersionInfo(Int32, Database, DbTransaction) | |
GetDocumentLink | Returns the URL of the given document in either Web Client or FDA. |
GetDocumentLocation(Int32) | Get cabinet, drawer, (optional) folder group and folder of the document. |
GetDocumentLocation(Int32, Boolean, Database, DbTransaction) | |
GetDocumentLocationAndArchive | Get cabinet, drawer, (optional) folder group and folder of the document. |
GetDocumentName(Int32) | Return the name of the given document. |
GetDocumentName(Int32, Database, DbTransaction) | |
GetDocumentNameAndSchema | Return the document and schema names of the given metadata version. |
GetDocumentNameForLink | Returns the filename for the given document version. |
GetDocumentNameWithLinks(Int32, String, String, Boolean, Boolean) | |
GetDocumentNameWithLinks(Int32, Int32, String, String, Boolean, Boolean) | |
GetDocumentOwnerGuid(Int32) | Return document owner guid |
GetDocumentOwnerGuid(Int32, Database, DbTransaction) | |
GetDocumentsAssociatedWithWorkflows | |
GetDocumentSchemaFromSelection | Check document schema in selection (only documents, ignore shortcuts) |
GetDocumentsForUsageLog | |
GetDocumentsInSchemas | Returns information about documents from selection in terms of belonging to document schemas |
GetDocumentsInSchemaType | Returns list of documents from selection of particular schema type |
GetDocumentsToAssemble | Checks whether documents in selection can be assembled and returns them in convenient format. |
GetDocumentsToCheckIn | Checks if the selected documents can be checked in and returns detailed information. |
GetDocumentsToDownload | Checks if the selected documents can be downloaded and returns detailed information. |
GetDocumentsToSend | Returns brief information about documents from selection. |
GetDocumentsToView | Checks if the selected documents can be downloaded and returns detailed information. |
GetDocumentsWithCustomNaming | Return a list of documents with custom naming. |
GetDocumentUrl | Returns the URL of the given document in the Web Client. |
GetDocumentUrlByLinkType | Returns the URL of the given document using a predefined document link setting. |
GetDocumentVersionId(Int32, Int32) | Return the version id of the document. If the versionNumber value equals 0 returns the latest one. |
GetDocumentVersionId(Int32, Int32, Database, DbTransaction) | |
GetDocumentVersionName(Int32) | Return the name of the given document version. |
GetDocumentVersionName(Int32, Database, DbTransaction) | |
GetDocumentVersionsForSelection | Retrieves document versions for selection |
GetDropdownChanges | Returns information from the library audit log dropdown changes |
GetFileExtensions | Returns collection of file extensions available in the system |
GetFileExtensions(Database, DbTransaction) | |
GetFilteredLibraryAuditLogs | Returns information from the library audit log |
GetFTSServiceStatus | Return status of Full Text Search |
GetIdsFromSelection(String, String, Guid, Database, DbTransaction) | |
GetIdsFromSelection(String, String, Guid, Boolean, Database, DbTransaction) | |
GetLastVisibleVersionsFromSelection | Retrieves names of documents from selection which are in the last visible version and it is not the really last version |
GetLibraryAuditLogs | Returns information from the library audit log |
GetLockedMarkupDocumentsFromSelection | Retrieves names of documents from selection which are associated with locked markups |
GetMoveFilesJobData | Get details of a repository batch job. |
GetNamesFromSelection(Guid, Int32, String, Int32, String) | |
GetNamesFromSelection(Guid, Int32, String, Int32, String, Boolean) | |
GetNotLastVersionsFromSelection | Retrieves names of documents from selection which are not the last version |
GetObjectUrl(String, Boolean, DocumentManagerNotificationObjectType) | Returns link to a specified object. For use with application server plug-ins only. |
GetObjectUrl(String, DocumentManagerNotificationClientType, DocumentManagerNotificationObjectType, String) | |
GetObjectUrl(String, Boolean, Boolean, DocumentManagerNotificationObjectType) | Returns link to a specified object. For use with application server plug-ins only. |
GetObjectUrlByLinkType | Returns link to a specified object. For use with application server plug-ins only. |
GetRepFileDetails | Get library location for a given file in the repository. |
GetRepFileId | |
GetRepFilesSummary | Returns information about files in the given repository location. |
GetScalarFromSelection | |
GetSchemaTypesFromSelection | Returns schemas for all documents from selection |
GetSelectionContent | Returns information about all documents from specified selection |
GetShortcutsFromSelection | This method is deprecated. |
GetSingleDocumentToDownload | Checks if the document can be viewed and returns detailed information. |
GetSqlDate | Get current date and time from SQL Server. |
GetUrlForDownloads(Boolean) | |
GetUrlForDownloads(DocumentManagerNotificationClientType) | |
GetUserCulture | |
GetUtcSqlDate | Get current UTC date and time from SQL Server |
GetWC3PathBase | |
GetWrappedWC2Url | |
InternalPrepareDocuments | |
InvokeUserAction | Invoke a user action from plug-in. |
IsCheckedOut | Return true if the document is checked out. |
IsCheckedOutBy(Int32) | Return name of the user who checked out the document. |
IsCheckedOutBy(Int32, Int32, String) | |
IsCheckedOutBy(Int32, Int32, String, Database, DbTransaction) | |
IsDocumentValidAssembleTemplate | Checks whether selected document can be used as template in assemble process. |
IsDocumentVersionDeleted | Check if the given document version is deleted. This includes soft-deleted and hard-deleted versions. |
Move | Moves documents from selection to specified destination |
MoveAndEdit | Moves documents from selection to specified destination and edit their metadata |
MoveDocuments | |
MoveSelection | |
NotifyUsers | |
PrepareDocumentsToDownload | Prepares documents to download and creates download token for them. |
PrepareMultipleDocumentsToDownload | Retrieves information about specified documents and creates download tokens for them |
PrepareSingleDocumentToDownload | Retrieves information about specified document and creates download token for it |
PrepareSingleDocumentToDownloadByDocumentVersionId | Retrieves information about specified document and creates download token for it |
PrepareToRename | |
Recover | Recovers documents specified by selection |
RecoverDocuments | |
ReinstateAsLatestVersion(Int32, Boolean) | Reinstate the given binary version as the latest version of the document. |
ReinstateAsLatestVersion(Int32, Boolean, Boolean, Database, DbTransaction) | |
ReinstateAsLatestVersion(Int32, Boolean, Boolean, Boolean, Database, DbTransaction) | |
ReinstateAsLatestVersionWithMarkup | Reinstate the given binary version as the latest version of the document. |
RemoveAllDocumentVersions | |
RemoveDocumentLinks | |
RemoveDocumentsAndShortcuts | |
RemoveDocumentVersion | |
RemoveDocumentVersions | |
RemoveFromFavourites | |
RemoveLinks | Removes links between documents from selection and specified document |
RemoveSelection | Removes specified selection |
RenameDocuments | |
RenamePreparedDocuments | |
SendEmail | |
SendEmailWithDocuments(String, String, String, String, String, Int32, Int32, Boolean, String) | Sends email with specified documents attached |
SendEmailWithDocuments(String, String, String, String, String, Int32, Int32, Boolean, CultureInfo, Boolean, Boolean, Database, DbTransaction) | |
SetMetadata(Int32, Int32, String, FieldWithValue, Boolean, String) | Adds new or overwrites previous version of document's metadata |
SetMetadata(Int32, Int32, String, FieldWithValue, Boolean, String, Database, DbTransaction) | Adds new or overwrites previous version of document's metadata. For use with application server plug-ins only. |
SetMultiMetadata | Sets metadata of documents from selection |
UpdateAssembleDocumentsJob | Updates configuration of existing assemble job and moves it to the back of queue. Allowed only for paused jobs. |
UpdateAutoTaggedDocuments | |
UpdateDocumentName | |
UpdateOriginalFileName | |
UpdateRepFileId | |
VerifyDocumentsToAssemble | Checks whether documents in selection can be assembled. |
ConvertT | (Defined by ObjectExtension) |
GetUserIdentityName | (Defined by WebServiceExtension) |
ToJson | (Defined by ObjectExtension) |