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.
AnyExpression
AppendActionDocuments
Cabinet specific document info needed for document append action
AppendActionParameters
Specific data for append action
ApplicationProperties
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.
AssignedItem
An assigned item.
AssignmentOperation
Add or remove assignments.
AssignToHistoryStep
A history step for Assign to activity.
AttachFileField
AttachFileInfo
AuditEvent
Define auditing information property
AutoNumberField
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.
BatchDeleteDocumentsSource
BatchDeleteFailedResultItem
BatchDeleteResult
BatchRestoreDocumentsSource
BatchRestoreFailedResultItem
BatchRestoreResult
BatchUpdateDialogExpressionSource
BatchUpdateDocumentsSource
BatchUpdateIndexFieldsResult
Structure for the result of batch update operations.
BatchUpdateProcess
A class which contains data for batch update processes.
BatchUpdateProcessData
BatchUpdateResultItem
BatchUpdateSource
The base for defining a sequence of documents to be updated.
Behavior
Definition of a behavior for forms
BehaviorAction
BehaviorCondition
Definition of a behavior condition
Behaviors
List of behaviors
BitmapStamp
Stamp that applies an image.
BitmapStampEntry
Bitmap stamp. Png encoded image.
BooleanConstant
CFSSpecificValue
CFSStatisticGeneral
CFSStatisticSpecific
CheckGroup
CheckInActionParameters
Parameters for CheckIn action
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
Column
A column for a workflow.
ColumnOptions
ColumnsDefinition
A columns definition.
ColumnSortOrder
A sort by a specific column.
ColumnValue
A value in a column for a task.
ColumnValues
Values in columns for a task.
CommonFormField
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.
ContentType
ContentTypeList
ContentTypeListComplexType
ContentTypeListContentType
ContentTypeListSchemaType
ContentTypeMapping
Maps content types to file extensions.
CopyTemplateInput
CopyTemplateResult
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.
CreateFormsFileResult
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
DateConstant
DateField
DateTableColumnOptions
Additional options for a date or datetime column in a table field
DateTimeConstant
DecimalConstant
Decision
A workflow decision.
DecisionFormFieldValue
DecisionHistoryStep
DecisionOperations
Operations which can be executed on a decision.
Decisions
Decisions which can be taken for a task.
DecisionsStampSettings
Workflow decision stamps
DecisionStampPlacement
DeleteEntry
Entry that delete annotation spcified by its Id
DeleteTemplatesInput
DeleteTemplatesResult
DescriptionFormField
A description form.
Dialog
DialogExpression
Query definition for a dialog result list
DialogExpressionCondition
Condition for specific database name (field)
DialogField
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.
Document
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
DocumentIndexField
DocumentIndexFieldExtensions
Defines extenstion methods for DocumentIndexField
DocumentIndexFieldKeywords
List of keywords.
DocumentIndexFields
List of index fields.
DocumentIndexFieldTable
List of column values for table field.
DocumentIndexFieldTableRow
List of column values for table field.
DocumentIndexFieldValue
DocumentIndexFieldValueBase
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
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.
DocumentVersion
Document version info
DocumentWordSearchResult
DocumentWordSearchResultSectionHits
DolphinAttribute
Marks that this link or this property or this function is available since DocuWare 6.6.
DoubleConstant
DropDownList
DWPoint
DWRectangle
DWSize
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.
ExportConfigInput
ExportConfigResult
ExportQuery
ExportSettings
ExportTemplateInput
ExportTemplateResult
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
FieldValueExpression
FieldValueStatistics
Value with statistics.
FieldValueStatisticsExpression
The expression for field statistics.
FieldValueStatisticsResult
FileCabinet
Models a DocuWare file cabinet or a web basket(document tray).
FileCabinetExtensionsBase
Extensions for the file cabinet.
FileCabinetField
FileCabinetFieldBase
Base file cabinet field definition
FileCabinetFields
List of file cabinet fields.
FileCabinetHistoryField
FileCabinets
Lsit of file cabinets or document trays(web baskets).
FileCabinetTransferInfo
FileDownload
Define how a document can be downloaded
FileDownloadBase
Define how a page of a document can be downloaded
FileDownloadPage
FixedText
FlagConditions
Filter documents with specific flags
Font
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
FormsInput
Input used to submit form and store in DocuWare
FormTemplate
Definition of the Save Template
FormTemplates
Array of form templates
FoxAttribute
Marks that this link or this property or this function is available since DocuWare 6.8.
FunctionDescription
FunctionDescriptions
FunctionExpression
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.
GetTemplateImageInput
GetTemplateImageResult
Group
Defines a DocuWare group
Groups
A collection of groups
HawkAttribute
Marks that this link or this property or this function is available since DocuWare 6.10.
Headline
HistoryField
HistoryFieldOptions
HistoryStep
A history step.
HistoryStepInfo
Additional information for the history step according to the type of the step.
HistoryStepInfoBase
HistorySteps
List of history steps for an instance.
HttpMethodList
IdentityServiceInfo
IdentityServiceInfoConnectionData
Additional data to pass to the identity service info call.
ImageField
ImpalaAttribute
Marks that this link or this property or this function is available since Impala 6.11.
ImportConfigInput
ImportConfigResult
ImportEntryVersion
Defines the result of the imported archive.
ImportResult
Defines the result of the imported archive.
ImportResultEntry
Defines the result of the imported archive.
ImportSettings
ImportTemplateInput
ImportTemplateResult
InputDocument
InputFlags
InputSection
InputSections
Instance
InstanceHistory
List of history steps for an instance.
IntConstant
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.
LinkInvoke
LinkParameter
A link parameter.
LinkRelation
LinkRelations
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
LogicalOperator
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
MultiLineTextField
MultipleConditionHistorySteps
List of condition history steps.
MultiValueField
A multi value field.
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
NumberField
NumberTableColumnOptions
Additional options for a numeric column in a table field
NumericHistoryFieldOptions
Organization
Definition for DocuWare organization.
Organizations
List of organizations
OrganizationUser
Defines a user in specific organization
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.
ParameterDescription
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.
PointAndShootInfo
PolyLineEntry
PloyLine annotation. Conatins 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
QueryParamater
QueryParamatersList
QuokkaAttribute
Marks that this link or this property or this function is available since Porcupine 7.50
RaccoonAttribute
RadioGroup
ReadStatus
ReassignHistoryStep
A history step for Reassign operation.
ReassignmentData
Data to reassign a task.
RectEntry
Rectangle or Ellipse annotation
RegionalSettings
Defines user locale
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.
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.
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
RotatePageParameters
Parameters for RotatePage action
SaveTemplateInput
Save Template
SaveTemplateResult
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
SelectListFilter
SelectListInfo
Select list information object.
SelectListInfos
List of select list information objects.
SelectListResult
Select list values.
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.
SelectListValueToCheck
Represents value to be used for checking existance of value 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.
ServiceConnectionExtensions
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.
ServiceDescriptionDocumentation
ServiceDescriptionStatistics
ServiceDescriptionTests
SignatureField
SingleColumnSelectListValues
SortedField
Defines a sort by a field.
SortedFieldsList
Defines a list of sorted fields.
SpacerField
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.
StampField
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
Stamps
List of stamps.
StartHistoryStep
A history step for Start activity.
StopHistoryStep
A history step for Stop workflow operation.
StringConstant
Stroke
Sequence of points that define a PloyLine.
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.
SuggestionCellValue
SuggestionField
SuggestionFields
SuggestionTable
SuggestionTableField
SuggestionTableFields
SuggestionValue
SynchronizationSettings
SystemVariableExpression
TableColumnOptions
TableColumnsDefinition
A common column options for a table field.
TableFieldColumns
List of file cabinet fields.
TableHistoryFieldOptions
TableResultHeader
Header for a column table result from document query
TableResultRow
Define a row of the table result from document query
TableSelectListFilter
TaskDateTimeField
A dateTime field.
TaskFieldValue
TaskFieldValueBase
TaskFormField
TaskNumberField
A number field.
TaskOperations
Operations on a workflow task.
TasksQuery
TaskTableColumn
TaskTableColumnBase
TaskTableField
A table field.
TaskTableFieldInitialValues
TaskTableNumberField
A table number field.
TaskTextField
A text field.
TextColumn
Additional options for a text column in a workflow
TextEntry
Annotation that contains text
TextField
TextHistoryFieldOptions
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.
ToggleBehaviorAction
TokenDescription
Define a purpose of the token. Can define some restrictions
TrashBin
Definition for trash bin.
TrashBinDocumentsTableResult
Defines trash bin table result from document query
TrashBinQuery
Defines a query for trash bin documents.
TrashBinTableHeader
Header for a column for trash bin table result from document query
TrashBinTableRow
Defines a row of the table result from document query
UpdateIndexFieldsInfo
Structure for updating index fields, including the index fields values and the dialog used for updating.
UploadedFileChunk
UploadTemplateInput
UploadTemplateResult
User
User details and settings
UserDefinedSearchInfo
Options for creating user defined search based on result list.
UserField
A user field.
UserInfo
Information related to a user
Users
Defines a list of users
UserValidation
User details needed for validation user login
ValidationCondition
Definition of a validation condition
ViewerDialog
WaitHistoryStep
A history step for wait activity.
WebFormControl
Base class for web form fields
WebFormControls
List of web form fields
WebFormField
WebFormListOptions
List of options for a drop down
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.
WFFormFieldValue
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.
WorkflowBehaviorOptions
WorkflowDocumentHistory
A workflow history for a document.
WorkflowRequests
Workflows
List of workflows.
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
XmlDSigContentType
XmlSchema
XmlSchemas
Zone
Definition of a Template Zone
Zones
Array of template Zones
Interfaces
IChunkable
An interface for items which can be uploaded in chunks.
Enums
ActivityTypeEnum
AlignmentType
AssignedItemTypeEnum
AssignmentOperationType
Types of the assignment operation.
AssignmentType
CFSTableNames
CheckInReturnDocument
The CheckInRequestDocument enumeration specifies the document that has to be returned by check in operation.
ChecksumStatusType
Define a result from a checksum
ColumnTypeEnum
ColumnValueTypeEnum
ColumnWidthType
ComparisonType
ConfigurationRight
ContentDivideOperation
Subset of content operations.
ContentMergeOperation
Subset of content operations.
Continuation
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.)
DWFieldType
Type of a DocuWare file cabinet field. Please Do Not Change order because it matches DocuWare.FileCabinet.Settings.DocuWareType
DWSystemVariableName
DynamicValueType
FileCabinetFieldScope
The scope of the file cabinet field.
FileDownloadType
Define the format that will be used to download a document
FileSource
FormTypeEnum
HistoryFormTypeEnum
HttpMethod
ImportEntryStatus
ImportEntryVersionStatus
IntellixFieldTrust
IntellixTrust
Define how much the intellix result is reliable
ItemChoiceType
ItemChoiceType1
LetterCase
Operator
OrientationType
PlatformImageFormat
Define a supported image formats in platform
PredefinedEntryType
QueryParamaterType
RedirectType
ResultDialogFunctionType
Right
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.
StepTypeEnum
SynchronizationOperation
Define the operation that will be applied on synchronizing.
TableColumnValueTypeEnum
TableResultFieldKind
Kind of the field
TaskTableFieldJoinTypeEnum
TokenUsage
Usage of the token.
VersionManagementMode
VersionManagementStatus
Define the version management status of a document
ViewerDialogModes
Mode in which the viewer is opened to display a document