![]() |
Laserfiche.Repository.Api.Client.V2
1.0.2
|
Classes | |
| class | ApiExceptionExtensions |
| class | Attribute |
| Represents a trustee attribute. More... | |
| class | AttributeCollectionResponse |
| Response containing a collection of Attribute. More... | |
| class | AttributesClient |
| The Laserfiche Repository Attributes API client. More... | |
| class | AuditReason |
| Represents a user-defined audit reason for an audit event. More... | |
| class | AuditReasonCollectionResponse |
| Response containing a collection of AuditReason. More... | |
| class | AuditReasonsClient |
| class | BaseClient |
| The base class for each Laserfiche Repository resource API client. More... | |
| class | CancelTaskResult |
| Represents the result of cancelling a long operation task. More... | |
| class | CancelTasksParameters |
| Represents the request parameters for CancelTasks. More... | |
| class | CancelTasksResponse |
| Response containing a collection of CancelTaskResult. More... | |
| class | CopyEntryParameters |
| Represents the request parameters for CopyEntry. More... | |
| class | CopyEntryRequest |
| Request body for copying an entry. More... | |
| class | CreateEntryParameters |
| Represents the request parameters for CreateEntry. More... | |
| class | CreateEntryRequest |
| Request body for creating an entry. More... | |
| class | CreateMultipartUploadUrlsParameters |
| Represents the request parameters for CreateMultipartUploadUrls. More... | |
| class | CreateMultipartUploadUrlsRequest |
| Request body for creating multipart upload urls. More... | |
| class | CreateMultipartUploadUrlsResponse |
| Response for CreateMultipartUploadUrls. More... | |
| class | DeleteElectronicDocumentParameters |
| Represents the request parameters for DeleteElectronicDocument. More... | |
| class | DeletePagesParameters |
| Represents the request parameters for DeletePages. More... | |
| class | Document |
| Represents a document in a Laserfiche repository. More... | |
| class | EntriesClient |
| The Laserfiche Repository Entries API client. More... | |
| class | Entry |
| Base type for all types which represent entry objects in a Laserfiche repository. More... | |
| class | EntryCollectionResponse |
| Response containing a collection of Entry. More... | |
| class | ExportEntryParameters |
| Represents the request parameters for ExportEntry. More... | |
| class | ExportEntryRequest |
| Request body for exporting an entry. More... | |
| class | ExportEntryRequestImageOptions |
| Represents the options when exporting the image part of an entry. More... | |
| class | ExportEntryRequestTextOptions |
| Represents the options when exporting the text part of an entry. More... | |
| class | ExportEntryRequestWatermark |
| Represents the watermark added to the images when exporting an entry. More... | |
| class | ExportEntryResponse |
| Response containing a link to download the exported entry. More... | |
| class | Field |
| Represents a field set on an entry. More... | |
| class | FieldCollectionResponse |
| Response containing a collection of Field. More... | |
| class | FieldDefinition |
| Represents a field definition. More... | |
| class | FieldDefinitionCollectionResponse |
| Response containing a collection of FieldDefinition. More... | |
| class | FieldDefinitionsClient |
| The Laserfiche Repository Field Definitions API client. More... | |
| class | FieldToUpdate |
| Represents a field that will be assigned to the entry. More... | |
| class | FileParameter |
| Represents a file to be uploaded. More... | |
| class | Folder |
| Represents a folder (standard or record folder) in a Laserfiche repository. More... | |
| class | GetAttributeParameters |
| Represents the request parameters for GetAttribute. More... | |
| class | GetEntryByPathParameters |
| Represents the request parameters for GetEntryByPath. More... | |
| class | GetEntryByPathResponse |
| Response containing an entry or ancestor entry found by entry path. More... | |
| class | GetEntryParameters |
| Represents the request parameters for GetEntry. More... | |
| class | GetFieldDefinitionParameters |
| Represents the request parameters for GetFieldDefinition. More... | |
| class | GetLinkDefinitionParameters |
| Represents the request parameters for GetLinkDefinition. More... | |
| class | GetTagDefinitionParameters |
| Represents the request parameters for GetTagDefinition. More... | |
| class | GetTemplateDefinitionParameters |
| Represents the request parameters for GetTemplateDefinition. More... | |
| interface | IAttributesClient |
| The Laserfiche Repository Attributes API client. More... | |
| interface | IAuditReasonsClient |
| interface | IEntriesClient |
| The Laserfiche Repository Entries API client. More... | |
| interface | IFieldDefinitionsClient |
| The Laserfiche Repository Field Definitions API client. More... | |
| class | IHeaderDictionary |
| interface | ILinkDefinitionsClient |
| The Laserfiche Repository Link Definitions API client. More... | |
| class | ImportEntryParameters |
| Represents the request parameters for ImportEntry. More... | |
| class | ImportEntryRequest |
| Request body for importing an entry. More... | |
| class | ImportEntryRequestMetadata |
| Represents the metadata that will be assigned to the imported entry. More... | |
| class | ImportEntryRequestPdfOptions |
| PDF-related options for importing an entry. More... | |
| interface | IRepositoriesClient |
| The Laserfiche Repository Repositories API client. More... | |
| interface | IRepositoryApiClient |
| The Laserfiche Repository API client. More... | |
| interface | ISearchesClient |
| The Laserfiche Repository Searches API client. More... | |
| interface | ISimpleSearchesClient |
| interface | ITagDefinitionsClient |
| The Laserfiche Repository Tag Definitions API client. More... | |
| interface | ITasksClient |
| interface | ITemplateDefinitionsClient |
| The Laserfiche Repository Template Definitions API client. More... | |
| class | JsonInheritanceAttribute |
| class | JsonInheritanceConverter |
| class | LFColor |
| Represents an RGB color value with alpha channel. More... | |
| class | Link |
| Represents a link between a source entry and a target entry. More... | |
| class | LinkCollectionResponse |
| Response containing a collection of Link. More... | |
| class | LinkDefinition |
| Represents an entry link definition. More... | |
| class | LinkDefinitionCollectionResponse |
| Response containing a collection of LinkDefinition. More... | |
| class | LinkDefinitionsClient |
| The Laserfiche Repository Link Definitions API client. More... | |
| class | LinkToUpdate |
| Represents a link that will be assigned to the entry. More... | |
| class | ListAttributesParameters |
| Represents the request parameters for ListAttributes. More... | |
| class | ListAuditReasonsParameters |
| Represents the request parameters for ListAuditReasons. More... | |
| class | ListDynamicFieldValuesParameters |
| Represents the request parameters for ListDynamicFieldValues. More... | |
| class | ListDynamicFieldValuesRequest |
| Request body for listing dynamic field values for an entry. More... | |
| class | ListEntriesParameters |
| Represents the request parameters for ListEntries. More... | |
| class | ListFieldDefinitionsParameters |
| Represents the request parameters for ListFieldDefinitions. More... | |
| class | ListFieldsParameters |
| Represents the request parameters for ListFields. More... | |
| class | ListLinkDefinitionsParameters |
| Represents the request parameters for ListLinkDefinitions. More... | |
| class | ListLinksParameters |
| Represents the request parameters for ListLinks. More... | |
| class | ListRepositoriesParameters |
| Represents the request parameters for ListRepositories. More... | |
| class | ListSearchContextHitsParameters |
| Represents the request parameters for ListSearchContextHits. More... | |
| class | ListSearchResultsParameters |
| Represents the request parameters for ListSearchResults. More... | |
| class | ListTagDefinitionsParameters |
| Represents the request parameters for ListTagDefinitions. More... | |
| class | ListTagsParameters |
| Represents the request parameters for ListTags. More... | |
| class | ListTasksParameters |
| Represents the request parameters for ListTasks. More... | |
| class | ListTemplateDefinitionsParameters |
| Represents the request parameters for ListTemplateDefinitions. More... | |
| class | ListTemplateFieldDefinitionsByTemplateIdParameters |
| Represents the request parameters for ListTemplateFieldDefinitionsByTemplateId. More... | |
| class | ListTemplateFieldDefinitionsByTemplateNameParameters |
| Represents the request parameters for ListTemplateFieldDefinitionsByTemplateName. More... | |
| class | RecordSeries |
| Represents a Laserfiche record series. More... | |
| class | RemoveTemplateParameters |
| Represents the request parameters for RemoveTemplate. More... | |
| class | RepositoriesClient |
| The Laserfiche Repository Repositories API client. More... | |
| class | Repository |
| Represents a Laserfiche repository. More... | |
| class | RepositoryApiClient |
| The Laserfiche Repository API client. More... | |
| class | RepositoryCollectionResponse |
| Response containing a collection of Repository. More... | |
| class | Rule |
| Represents a form logic rule associated with a Laserfiche template and field definition. More... | |
| class | SearchContextHit |
| Represents a context hit for a search result. More... | |
| class | SearchContextHitCollectionResponse |
| Response containing a collection of SearchContextHit. More... | |
| class | SearchEntryParameters |
| Represents the request parameters for SearchEntry. More... | |
| class | SearchEntryRequest |
| Request body for searching entries. More... | |
| class | SearchesClient |
| The Laserfiche Repository Searches API client. More... | |
| class | SetFieldsParameters |
| Represents the request parameters for SetFields. More... | |
| class | SetFieldsRequest |
| Request body for assigning fields to an entry. More... | |
| class | SetLinksParameters |
| Represents the request parameters for SetLinks. More... | |
| class | SetLinksRequest |
| Request body for assigning links to an entry. More... | |
| class | SetTagsParameters |
| Represents the request parameters for SetTags. More... | |
| class | SetTagsRequest |
| Request body for assigning tags to an entry. More... | |
| class | SetTemplateParameters |
| Represents the request parameters for SetTemplate. More... | |
| class | SetTemplateRequest |
| Request body for assigning a template and template fields to an entry. More... | |
| class | Shortcut |
| Represents an entry shortcut in a Laserfiche repository. More... | |
| class | SimpleSearchesClient |
| class | StartCopyEntryParameters |
| Represents the request parameters for StartCopyEntry. More... | |
| class | StartCopyEntryRequest |
| Request body for starting an asynchronous copy entry task. More... | |
| class | StartDeleteEntryParameters |
| Represents the request parameters for StartDeleteEntry. More... | |
| class | StartDeleteEntryRequest |
| Request body for starting an asynchronous delete entry task. More... | |
| class | StartExportEntryParameters |
| Represents the request parameters for StartExportEntry. More... | |
| class | StartExportEntryRequest |
| Request body for starting an asynchronous export entry task. More... | |
| class | StartImportUploadedPartsParameters |
| Represents the request parameters for StartImportUploadedParts. More... | |
| class | StartImportUploadedPartsRequest |
| Request body for starting an asynchronous import entry task. More... | |
| class | StartSearchEntryParameters |
| Represents the request parameters for StartSearchEntry. More... | |
| class | StartSearchEntryRequest |
| Request body for starting an asynchronous search entry task. More... | |
| class | StartTaskResponse |
| Response containing a long operation task id. More... | |
| class | Tag |
| Represents a tag set on an entry. More... | |
| class | TagCollectionResponse |
| Response containing a collection of Tag. More... | |
| class | TagDefinition |
| Represents an entry tag definition. More... | |
| class | TagDefinitionCollectionResponse |
| Response containing a collection of TagDefinition. More... | |
| class | TagDefinitionsClient |
| The Laserfiche Repository Tag Definitions API client. More... | |
| class | TagDefinitionWatermark |
| Represents a watermark associated with a tag defintion. More... | |
| class | TaskCollectionResponse |
| Response containing a collection of TaskProgress. More... | |
| class | TaskProgress |
| Represents the progress of a long operation task. More... | |
| class | TaskResult |
| Represents the result of a long operation task. More... | |
| class | TasksClient |
| class | TemplateDefinition |
| Represents a template definition. More... | |
| class | TemplateDefinitionCollectionResponse |
| Response containing a collection of TemplateDefinition. More... | |
| class | TemplateDefinitionsClient |
| The Laserfiche Repository Template Definitions API client. More... | |
| class | TemplateFieldDefinition |
| Represents a template field definition. More... | |
| class | TemplateFieldDefinitionCollectionResponse |
| Response containing a collection of TemplateFieldDefinition. More... | |
| class | UpdateEntryParameters |
| Represents the request parameters for UpdateEntry. More... | |
| class | UpdateEntryRequest |
| Request body for updating an entry. More... | |
Typedefs | |
| using | System = global::System |
Enumerations | |
| enum class | AuditEventType { DeleteEntry = 0 , ExportDocument = 1 } |
| Enumeration of Laserfiche audit event types. More... | |
| enum class | CreateEntryRequestEntryType { Folder = 0 , Shortcut = 1 } |
| Enumeration of entry types for CreateEntry. More... | |
| enum class | EntryType { Folder = 0 , RecordSeries = 1 , Document = 2 , Shortcut = 3 } |
| Enumeration of entry types. More... | |
| enum class | ExportEntryRequestImageFormat { MultiPageTIFF = 0 , SinglePageTIFF = 1 , PNG = 2 , PDF = 3 , JPEG = 4 } |
| Enumeration of formats when exporting the image part of an entry. More... | |
| enum class | ExportEntryRequestPart { Image = 0 , Text = 1 , Edoc = 2 } |
| Enumeration of the entry parts to export. More... | |
| enum class | FieldFormat { None = 0 , ShortDate = 1 , LongDate = 2 , ShortDateTime = 3 , LongDateTime = 4 , ShortTime = 5 , LongTime = 6 , GeneralNumber = 7 , Currency = 8 , Percent = 9 , Scientific = 10 , Custom = 11 } |
| Enumeration of Laserfiche template field formats. More... | |
| enum class | FieldType { DateTime = 0 , Blob = 1 , Date = 2 , ShortInteger = 3 , LongInteger = 4 , List = 5 , Number = 6 , String = 7 , Time = 8 } |
| Enumeration of Laserfiche template field types. More... | |
| enum class | FuzzyType { None = 0 , Percentage = 1 , NumberOfLetters = 2 } |
| enum class | GeneratePagesImageType { BlackAndWhite = 0 , StandardColor = 1 , HighQualityColor = 2 } |
| Enumeration for the image types when generating pages. More... | |
| enum class | HitType { PageContent = 0 , Note = 1 , Callout = 2 , TextBox = 3 , Edoc = 4 , Prop = 5 , Name = 6 , Extension = 7 , VersionGroupNote = 8 , VersionComment = 9 , Field = 10 , SignatureComment = 11 , CertificateSubject = 12 , TagComment = 13 , AnnotationComment = 14 , Attachment = 15 } |
| The type of context hit. More... | |
| enum class | TaskStatus { NotStarted = 0 , InProgress = 1 , Completed = 2 , Failed = 3 , Cancelled = 4 } |
| An enumeration of possible statuses for a long operation task. More... | |
| enum class | TaskType { CopyEntry = 0 , DeleteEntry = 1 , ExportEntry = 2 , ImportUploadedParts = 3 , SearchEntry = 4 } |
| An enumeration of possible types for a long operation task. More... | |
| enum class | WatermarkPosition { TopLeft = 0 , TopCenter = 1 , TopRight = 2 , MiddleLeft = 3 , DeadCenter = 4 , MiddleRight = 5 , BottomLeft = 6 , BottomCenter = 7 , BottomRight = 8 } |
| An enumeration of possible positions on a page for watermarks. More... | |
|
strong |
Enumeration of Laserfiche audit event types.
|
strong |
Enumeration of entry types for CreateEntry.
|
strong |
Enumeration of entry types.
|
strong |
Enumeration of formats when exporting the image part of an entry.
|
strong |
Enumeration of the entry parts to export.
|
strong |
Enumeration of Laserfiche template field formats.
|
strong |
Enumeration of Laserfiche template field types.
|
strong |
Enumeration for the image types when generating pages.
|
strong |
The type of context hit.
|
strong |
An enumeration of possible statuses for a long operation task.
|
strong |
An enumeration of possible types for a long operation task.
|
strong |
An enumeration of possible positions on a page for watermarks.