Namespace DocuWare.Platform.ServerClient
Classes
- AdditionalOrganizationInfo
Additional information for organization
- AdhocRenderingFile
Main class for managing adhoc rendering file.
- AdhocRenderingFiles
A list of uploaded files prepared for adhoc rendering.
- AdhocRenderingQuery
Specifies how a file is to be rendered.
- Annotation
Annotation element. Contains all annotations for a specific page in up to 5 layers
- AnnotationPoint
Define point of annotation.
- AnnotationRectangle
Define rectangular annotation.
- AnnotationsPlacement
Describes how to place a set of annotations and stamps on a page.
- AppendActionDocuments
Cabinet specific document info needed for document append action
- AppendActionParameters
Specific data for append action
- ApplicationProperty
Define application specific property
- AreValuesInSelectListsQuery
Query for checking whether one or more select lists contain one or more values
- AreValuesInSelectListsResult
Result returned when checking for value existance in select lists
- AssignDataHistoryStep
A history step for Assign data activity.
- AssignToHistoryStep
A history step for Assign to activity.
- AssignedItem
An assigned item.
- AssignmentOperation
Add or remove assignments.
- AuditEvent
Define auditing information property
- BaseDecisionOperations
Base operations which can be executed on a decision.
- BaseForm
A base form.
- BaseTaskOperations
Operations available for all users.
- BatchAppendKeywordValues
Contract for batch append of keywords to multiple documents.
- BatchUpdateIndexFieldsResult
Structure for the result of batch update operations.
- BatchUpdateProcess
A class which contains data for batch update processes.
- BatchUpdateSource
The base for defining a sequence of documents to be updated.
- Behavior
Definition of a behavior for forms
- BehaviorCondition
Definition of a behavior condition
- Behaviors
List of behaviors
- BitmapStamp
Stamp that applies an image.
- BitmapStampEntry
Bitmap stamp. Png encoded image.
- Calendar
Calendar of the organization.
- CheckInActionParameters
Parameters for CheckIn action
- CheckMarkEntry
Check mark annotation
- CheckOutActionParameters
Parameters for CheckOut action
- CheckOutResult
Result from a checkout. Contains link where document can be downloaded
- CheckOutToFileSystemInfo
Empty structure for checkout to file system operation
- CheckoutCheckinBase
Checkin and checkout operations
- ChecksumInfo
Contains the value and the algorithm of the checksum
- Column
A column for a workflow.
- ColumnSortOrder
A sort by a specific column.
- ColumnValue
A value in a column for a task.
- ColumnValues
Values in columns for a task.
- ColumnsDefinition
A columns definition.
- ConditionHistoryStep
A history step for Condition activity.
- ConfigurationRights
List of rights.
- ConfirmedData
Data which is sent when a user confirm a task.
- ConfirmedField
Value of form field
- ContentDivideOperationInfo
Models a DocuWare content divide operation.
- ContentMergeOperationInfo
Models a DocuWare content merge operation.
- ContentTypeMapping
Maps content types to file extensions.
- CountExpression
The expression for counting a documents.
- CountPlusValue
Define unstrict count. If HasMore is true it is possible to have more items
- CountResult
Result set of of item counts
- CountResultItem
Result of item count
- CreatedInfo
Info about creation of item.
- CrossMarkEntry
Cross mark annotation
- CsvExpression
Query csv file.
- CustomFieldValidation
Definition of a custom field validation for forms
- DateColumn
Additional options for a date or datetime column in a workflow
- DateTableColumnOptions
Additional options for a date or datetime column in a table field
- Decision
A workflow decision.
- DecisionOperations
Operations which can be executed on a decision.
- Decisions
Decisions which can be taken for a task.
- DecisionsStampSettings
Workflow decision stamps
- DeleteEntry
Entry that delete annotation spcified by its Id
- DescriptionFormField
A description form.
- DesignerInstance
Model a designer workflow instance.
- DesignerInstances
List of workflow instances.
- DesignerWaitingInstance
Model a waiting instance for the designer of the workflow.
- DesignerWaitingInstances
List of waiting instances.
- DesignerWorkflow
Model a designer workflow.
- DesignerWorkflowVersion
Model a designer workflow version.
- DesignerWorkflowVersions
List of a workflow versions.
- DesignerWorkflows
List of workflows which current user is Designer.
- DialogExpression
Query definition for a dialog result list
- DialogExpressionCondition
Condition for specific database name (field)
- DialogFieldBase
Base dialog field definition
- DialogFields
List of dialog fields.
- DialogInfo
General properties of any dialog.
- DialogInfos
List of dialog infos.
- DialogProperties
Specific properties for each dialog type
- DialogPropertiesResultList
Dialog properties specific for Result List
- DialogPropertiesSearch
Dialog properties specific for Search Dialog
- DialogPropertiesTaskList
Dialog properties specific for Task lists
- DialogPropertiesTreeView
Dialog properties specific for Tree list
- DialogTableFieldColumns
List of columns of dialog table field.
- DocumentActionInfo
Information about the action pereformed on document
- DocumentActionParameters
Basic parameters for specific action
- DocumentAnnotations
Descripes how to place a set of annotations and stamps on a document.
- DocumentAnnotationsPlacement
Descripes how to place a set of annotations and stamps on a document.
- DocumentApplicationProperties
Define application specific properties. Different applications store specific application here
- DocumentApplicationProperty
Define application specific property
- DocumentAuditEvent
Define auditing information property
- DocumentAuditEventInformation
Defines a list of audit event properties.
- DocumentAuditEventProperty
Defines the description of auditing event property.
- DocumentAuditEventTableProperty
Defines the description of auditing event table property.
- DocumentAuditEventTablePropertyColumn
Defines the description of auditing event table property column.
- DocumentAuditEventTablePropertyValues
Defines the description of auditing event table property values.
- DocumentAuditInformation
Defines auditing information for a document.
- DocumentAuditQuery
Defines a query for requesting document auditing information
- DocumentFlags
Define possible flags for a document
- DocumentIndexFieldExtensions
Defines extenstion methods for DocumentIndexField
- DocumentIndexFieldKeywords
List of keywords.
- DocumentIndexFieldTable
List of column values for table field.
- DocumentIndexFieldTableRow
List of column values for table field.
- DocumentIndexFields
List of index fields.
- DocumentLink
Define a query that link one document to another document from same or different file cabinet
- DocumentLinkExpressionQuery
Query definition for a result list of a document link
- DocumentLinks
Define all document links that a vlid for a document
- DocumentVersion
Document version info
- DocumentlessTriggerData
Input data received when triggering a documentless workflow.
- DocumentsQuery
Defines a query for documents.
- DocumentsQueryExtensionsBase
Extensions for the document query.
- DocumentsQueryResult
Define a result from document query
- DocumentsQueryTableResult
Define table result from document query
- DocumentsTransferInfo
Defines the parameters of a documents transfer.
- DolphinAttribute
Marks that this link or this property or this function is available since DocuWare 6.6.
- EagleAttribute
Marks that this link or this property or this function is available since DocuWare 6.7.
- EasyCheckoutCheckinExtensionsBase
Some extensions for handling responses which can be stored as files.
- EasyCheckoutResult
The result of a checkout operation.
- EasyFileUploadExtensionsBase
Some extensions for simple file uploads.
- EmailHistoryStep
A history step for Email activity.
- EndHistoryStep
A history step for End activity.
- EnhanceImageParameters
Parameters for EnhanceImage action
- EntryBase
Base element for annotation entry.
- ErrorHistoryStep
A history step for Error exit.
- EventHistoryStep
A history step for Event activity.
- ExtendedConfigurationRights
Defines the extended rights of the user.
- ExtendedControllerOperations
Operations available for controllers of the task.
- ExtendedDecisionOperations
Operations which can be executed on a decision only from form interface.
- ExtendedUserOperations
Operations available for common users of the task.
- ExtendedUserRights
Defines the extended rights of the user.
- FieldMapping
Define fields mapping between source and destination file cabinets.
- FieldMappings
Define fields mapping between source and destination file cabinets.
- FieldMask
A text field mask.
- FieldValidations
List of field validations
- FieldValueStatistics
Value with statistics.
- FieldValueStatisticsExpression
The expression for field statistics.
- FileCabinet
Models a DocuWare file cabinet or a web basket(document tray).
- FileCabinetExtensionsBase
Extensions for the file cabinet.
- FileCabinetFieldBase
Base file cabinet field definition
- FileCabinetFields
List of file cabinet fields.
- FileCabinetSelectListExpression
Query definition for a select list of a fc
- FileCabinets
Lsit of file cabinets or document trays(web baskets).
- FileDownload
Define how a document can be downloaded
- FileDownloadBase
Define how a page of a document can be downloaded
- FileNameExtensions
A class to handle file name encoding
- FlagConditions
Filter documents with specific flags
- FormCondition
Definition of a condition
- FormFieldValue
Contains the value of form field
- FormFieldValues
The form field values which are applied when placing or rendering the stamp.
- FormInfo
Form object used for displaying form
- FormInfoHeader
Simple Form object used for displaying form in web client's forms area
- FormProperties
Definition of Form Properties
- FormTemplate
Definition of the Save Template
- FormTemplates
Array of form templates
- FormsInput
Input used to submit form and store in DocuWare
- FoxAttribute
Marks that this link or this property or this function is available since DocuWare 6.8.
- FunctionExpressionQuery
Query cabinet documents by function expression
- GeckoAttribute
Marks that this link or this property or this function is available since DocuWare 6.9.
- GeneralErrorDecisionHistoryStep
A history step for General error.
- Group
Defines a DocuWare group
- Groups
A collection of groups
- GroupsQuery
Filter groups by property.
- HawkAttribute
Marks that this link or this property or this function is available since DocuWare 6.10.
- HistoryInstance
Model a history workflow instance.
- HistoryInstances
List of workflow instances.
- HistoryStep
A history step.
- HistoryStepInfo
Additional information for the history step according to the type of the step.
- HistorySteps
List of history steps for an instance.
- IdentityServiceInfoConnectionData
Additional data to pass to the identity service info call.
- ImpalaAttribute
Marks that this link or this property or this function is available since Impala 6.11.
- ImportEntryVersion
Defines the result of the imported archive.
- ImportResult
Defines the result of the imported archive.
- ImportResultEntry
Defines the result of the imported archive.
- InstanceExpressionCondition
Condition for specific database name (field) in the instance list
- InstanceHistory
List of history steps for an instance.
- IntegerList
Define a list of integers values
- JellyfishAttribute
Marks that this link or this property or this function is available since Jellyfish 6.12.
- KeywordsField
A keyword field.
- KoalaAttribute
Marks that this link or this property or this function is available since Koala 7.00.
- Layer
Layer element. Contains annotations in a specific layer. Annotation can have up to 5 layers.
- LineEntry
Line/Arrow annotation
- LinkForm
A link form.
- LinkParameter
A link parameter.
- LobsterAttribute
Marks that this link or this property or this function is available since Lobster 7.10.
- LockInfo
Define how a document will be locked
- LoginInfo
Details abut user login
- MergeAnnotationsParameters
Parameters for MergeAnnotations action
- MinimalVersionAttribute
Marks the minimal version needed to have this link or this property or this function available.
- MooseAttribute
Marks that this link or this property or this function is available since Moose 7.20
- MultiColSelectListColumn
Multi column select list column definition
- MultiColSelectListExpressionCondition
Condition for specific multi column select list column
- MultiColSelectListInfo
Multi column select list object.
- MultiColSelectListInfos
List of multi column select list objects.
- MultiColSelectListRow
Multi column select list row.
- MultiColSelectListValuesQuery
Query for multi column select list values
- MultiColSelectListValuesResult
Specific properties for each dialog type
- MultiColumnSelectListExpressionCondition
Condition for specific field.
- MultiColumnSelectListValuesQuery
Query for multi column select list values
- MultiValueField
A multi value field.
- MultipleConditionHistorySteps
List of condition history steps.
- NewUser
User details.
- Notification
A data stucture for implementing simple notifications.
- Notifications
A data stucture for managing notifications.
- NullTableResultValue
Represents empty value in table result list.
- NumbatAttribute
Marks that this link or this property or this function is available since Numbat 7.30
- NumberColumn
Additional options for a numeric column in a workflow
- NumberTableColumnOptions
Additional options for a numeric column in a table field
- Organization
Definition for DocuWare organization.
- OrganizationCulture
Culture settings of the organization.
- OrganizationUser
Defines a user in specific organization
- Organizations
List of organizations
- OutOfOffice
Defines when a user is out of office
- OutOfOfficeHistoryStep
A history step for Out of office exit.
- OwnWorkflow
A workflow\instance for the initiator of the request.
- OwnWorkflows
List of requests for the initiator.
- Page
Gets information about specific page.
- PageData
Define a metadata for a page
- PageHits
Contains a set pages where of words are found
- Pages
Define a collection of pages
- PagesBlockQuery
A query for requesting page blocks.
- PartialDownloadExtensionBase
Extensions for partial section download.
- PlatformClientConfiguration
A interface which is used to calculate a hash to identify the machine or device the application is running.
- PolyLineEntry
PolyLine annotation. Contains a single stroke of points.
- PolyLineStampEntry
Tablet polyline stamp. Contains one or more strokes. Used as handwriting stamp
- PorcupineAttribute
Marks that this link or this property or this function is available since Porcupine 7.50
- Position
Size and positioning of controls
- QuokkaAttribute
Marks that this link or this property or this function is available since Porcupine 7.50
- ReassignHistoryStep
A history step for Reassign operation.
- ReassignmentData
Data to reassign a task.
- RectEntry
Rectangle or Ellipse annotation
- RegionalSettings
Defines user locale
- ReorderSectionsRequest
Request to reorder document sections by specifying the new order of section IDs
- RequestConfirmedData
A confirmation data for a request.
- RequestDataDecision
Taken decision visible in the initiator view.
- RequestDecision
A request decision for a common user.
- RequestDecisionHistoryStep
A history step for confirmed decision in request.
- RequestDecisionSettings
Decision in the request when we create it.
- RequestDecisionsStampSettings
Request decision stamps
- RequestDialogQuery
Array of dialog types.
- RequestEndHistoryStep
A history step for finish a request.
- RequestSettings
Data to trigger new request.
- RequestStartHistoryStep
A history step for trigger a request.
- RequestTask
A request task for a common user.
- RequestTasks
A list of request tasks for a common user.
- RestartWorkflowHistoryStep
A history step for Restart Workflow activity.
- ResultDialogFunction
Function of result list
- ResultListExtensions
Extensions for the result list.
- ResultListQuery
Base query definition for a result list
- Rights
List of rights.
- Role
Defines a DocuWare role
- RoleField
A role field.
- Roles
A collection of roles
- RolesQuery
Filter roles by property.
- RotatePageParameters
Parameters for RotatePage action
- SaveTemplateInput
Save Template
- SchemaExtensions
Extensions.
- SearchPositionQuery
Define a query for searching words in phrase
- Section
Define a single section of a document
- SectionAnnotation
Describes how to place a set of annotations and stamps on a section.
- SectionAnnotationsPlacement
Describes how to place a set of annotations and stamps on a section.
- Sections
Define all sections of a document
- SelectListExpression
Query definition for a select list
- SelectListInfo
Select list information object.
- SelectListInfos
List of select list information objects.
- SelectListResult
Select list values.
- SelectListValueToCheck
Represents value to be used for checking existance of value in select lists.
- SelectListValuesQuery
Query for select list values
- SelectListValuesResult
Specific properties for each dialog type
- SelectListValuesToCheck
Represents list of values to be used for checking existance in select lists.
- SequenceRequest
Defines the request next element of a sequence.
- SequenceResult
Defines the result for requested next element of a sequence.
- ServiceConnection
Encapsulates a connection to the platform.
- ServiceConnectionLicenseBoundData
License related connection creation data.
- ServiceConnectionLoginData
Provides additional date to log in with user credentials.
- ServiceConnectionTokenLoginData
Provides additional date to log in with a token.
- ServiceConnectionTransportData
Definitions of the HTTP message handling and message processing.
- ServiceDescription
Root object that define platform structure.
- SortedField
Defines a sort by a field.
- SortedFieldsList
Defines a list of sorted fields.
- Stamp
Models a DocuWare stamp.
- StampBase
Stamp base type. Inherited by 3 types: TextStamp, BitmapStamp, PolyLineStamp
- StampConfirmedData
Data which is sent when a user confirm a task using a stamp.
- StampFormField
A form field for variable text to a text stamp.
- StampFormFieldValues
The form field values which are applied when placing or rendering a specific stamp.
- StampPlacement
Describes how to place a stamp on a page.
- StampPositionData
Data which is sent when you want to get the best position for a workflow stamp
- StampRequestConfirmedData
Data which is sent when a user confirm a task using a stamp.
- Stamps
List of stamps.
- StartHistoryStep
A history step for Start activity.
- StopHistoryStep
A history step for Stop workflow operation.
- Stroke
Sequence of points that define a PolyLine.
- StrokeStamp
Stamp that allows you to add a signature using an electronic pen.
- SubmissionOptions
Settings for post submission options
- SubstitutionList
Defines a substitution list for an organization.
- SubstitutionLists
Defines a list from substitution list objects for an organization.
- SubstitutionRule
Defines a substitution list for an organization.
- SubstitutionRuleField
A substitution rule field.
- SubstitutionRules
Defines a list from substitution role objects.
- TableColumnsDefinition
A common column options for a table field.
- TableFieldColumns
List of file cabinet fields.
- TableResultHeader
Header for a column table result from document query
- TableResultRow
Define a row of the table result from document query
- TaskDateTimeField
A dateTime field.
- TaskExpressionCondition
Condition for specific database name (field) in the task list
- TaskNumberField
A number field.
- TaskOperations
Operations on a workflow task.
- TaskTableField
A table field.
- TaskTableNumberField
A table number field.
- TaskTextField
A text field.
- TextColumn
Additional options for a text column in a workflow
- TextEntry
Annotation that contains text
- TextStamp
Stamp that applies a defined text.
- TextStampEntry
Text stamp. Value contains the text.
- TextTableColumnOptions
Additional options for a text column in a table field
- TimeoutHistoryStep
A history step for Time out exit.
- TokenDescription
Define a purpose of the token. Can define some restrictions
- TrashBin
Definition for trash bin.
- TrashBinCondition
Condition for specific database name (field)
- TrashBinDocumentsTableResult
Defines trash bin table result from document query
- TrashBinExpression
Expression definition for trash bin
- TrashBinQuery
Defines a query for trash bin documents.
- TrashBinSelectListExpression
Query definition for a select list
- TrashBinTableHeader
Header for a column for trash bin table result from document query
- TrashBinTableRow
Defines a row of the table result from document query
- TriggerVariable
Value of the variable
- TypedSelectListResult
Typed select list values.
- UnicornAttribute
Marks that this link or this property or this function is available since Unicorn 7.100
- UpdateIndexFieldsInfo
Structure for updating index fields, including the index fields values and the dialog used for updating.
- User
User details and settings
- UserDefinedSearchInfo
Options for creating user defined search based on result list.
- UserField
A user field.
- UserGroupsQuery
Filter user groups by property.
- UserInfo
Information related to a user
- UserPropertyQuery
User property change model.
- UserRolesQuery
Filter user roles by property.
- UserValidation
User details needed for validation user login
- Users
Defines a list of users
- UsersByRole
Defines a list of users filtered by role id
- UsersQuery
Filter users by property.
- ValidationCondition
Definition of a validation condition
- WaitHistoryStep
A history step for wait activity.
- WebFormControl
Base class for web form fields
- WebFormControls
List of web form fields
- WebFormOption
An option for a check box or radio group
- WebFormOptions
List of options for a check box or radio group
- WebFormOptionsRows
List of options for a check box or radio group
- WebServiceHistoryStep
A history step for Web Service activity.
- WolfAttribute
Marks that this link or this property or this function is available since Wolf 7.120
- WordSearchResult
Define a a set of words and locations where they are found in a section
- WordSearchResultPageHit
Define a a set of words and locations where they are found in a page
- WordSearchResultWordHit
Define a word and specific location where it is found
- WordSearchResultWordHits
Define a a set of words and locations where they are found
- Workflow
Model a workflow.
- WorkflowDocumentHistory
A workflow history for a document.
- WorkflowInstancesCount
Total instances count for a workflow
- WorkflowStampsSettings
Stamp settings for a task.
- WorkflowTask
A specific task from the result.
- WorkflowTasks
List of workflow tasks.
- WorkflowTasksCount
Total tasks count in a workflow or requests
- Workflows
List of workflows.
- XenoceratopsAttribute
Marks that this link or this property or this function is available since Xenoceratops 7.130
- YakAttribute
Marks that this link or this property or this function is available since Yak 7.140
- Zone
Definition of a Template Zone
- Zones
Array of template Zones
Interfaces
- IChunkable
An interface for items which can be uploaded in chunks.
Enums
- AssignmentOperationType
Types of the assignment operation.
- CalendarType
Types of the calendar.
- CheckInReturnDocument
The CheckInRequestDocument enumeration specifies the document that has to be returned by check in operation.
- ChecksumStatusType
Define a result from a checksum
- ContentDivideOperation
Subset of content operations.
- ContentMergeOperation
Subset of content operations.
- DWFieldType
Type of a DocuWare file cabinet field. Please Do Not Change order because it matches DocuWare.FileCabinet.Settings.DocuWareType
- DialogExpressionOperation
Supported operations for dialog expression
- DialogTypes
Types of dialogs.
- DocumentAction
Actions pereformed on document (ReIntellix e.g.)
- DocumentSourceType
Specifies the source of documents which trigger jobs in the DocuWare Job Framework. Also used to identify the type of configuration edited in the Job Configurator (Printer Configurator, Import Configurator etc.)
- FileCabinetFieldScope
The scope of the file cabinet field.
- FileDownloadType
Define the format that will be used to download a document
- InstanceExpressionOperation
Supported operations for instance expression
- IntellixTrust
Define how much the intellix result is reliable
- PlatformImageFormat
Define a supported image formats in platform
- RoleTypes
A predefined DocuWare role types
- SelectListKind
Kind of the select list
- SelectListType
Type of the select list
- SignatureStatus
Define allowed operations when there is signature
- SortDirection
Define a sort direction
- StampSignatureType
Signature wise stamps.
- SynchronizationOperation
Define the operation that will be applied on synchronizing.
- TableResultFieldKind
Kind of the field
- TaskExpressionOperation
Supported operations for dialog expression
- TokenUsage
Usage of the token.
- TrashBinExpressionOperation
Supported operations for trash bin expression
- VersionManagementStatus
Define the version management status of a document
- ViewerDialogModes
Mode in which the viewer is opened to display a document