Class Workflow

Model a workflow.

Inheritance

System.Object

Workflow

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Workflow : IRelationsWithProxy

Properties

ColumnDefinition

List of the visible columns of the workflow.

Declaration

public ColumnsDefinition ColumnDefinition { get; set; }

Property Value

Type	Description
ColumnsDefinition

CountRelationLink

Gets the Uri of the link for the relation “count”.

Declaration

public string CountRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “count” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

FileCabinetId

Id of the file cabinet which has been connected with this workflow.

Declaration

public string FileCabinetId { get; set; }

Property Value

Type	Description
System.String

HasDocumentFields

Indicates whether the task list contains document fields.

Declaration

public bool HasDocumentFields { get; set; }

Property Value

Type	Description
System.Boolean

Id

Id of the workflow.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Name of the workflow.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ResultListId

Id of the resultList needed to get context menu functions

Declaration

public string ResultListId { get; set; }

Property Value

Type	Description
System.String

SelfRelationLink

Gets the Uri of the link for the relation “self”.

Declaration

public string SelfRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “self” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

TaskCount

Number of items of the query leading to this result.

Declaration

public int TaskCount { get; set; }

Property Value

Type	Description
System.Int32

TasksRelationLink

Gets the Uri of the link for the relation “tasks”.

Declaration

public string TasksRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “tasks” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

TimeStamp

TimeStamp of the result.

Declaration

public System.DateTime TimeStamp { get; set; }

Property Value

Type	Description
System.DateTime

WorkflowBehaviorOptions

Declaration

public WorkflowBehaviorOptions WorkflowBehaviorOptions { get; set; }

Property Value

Type	Description
WorkflowBehaviorOptions

Methods

GetWorkflowFromSelfRelation()

Calls the HTTP Get method on the link for the relation “self”.

Declaration

public Workflow GetWorkflowFromSelfRelation()

Returns

Type	Description
Workflow	The content of the response.

GetWorkflowFromSelfRelationAsync()

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>> GetWorkflowFromSelfRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

GetWorkflowFromSelfRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “self” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>> GetWorkflowFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>>	A task which runs the request.

Remarks

This method follows the link for the relation “self”.

GetWorkflowTasksCountFromCountRelation()

Calls the HTTP Get method on the link for the relation “count”.

Declaration

public WorkflowTasksCount GetWorkflowTasksCountFromCountRelation()

Returns

Type	Description
WorkflowTasksCount	The content of the response.

GetWorkflowTasksCountFromCountRelationAsync()

Calls the HTTP Get method on the link for the relation “count” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCountRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>>	A task which runs the request.

Remarks

This method follows the link for the relation “count”.

GetWorkflowTasksCountFromCountRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “count” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCountRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>>	A task which runs the request.

Remarks

This method follows the link for the relation “count”.

GetWorkflowTasksFromTasksRelation()

Calls the HTTP Get method on the link for the relation “tasks”.

Declaration

public WorkflowTasks GetWorkflowTasksFromTasksRelation()

Returns

Type	Description
WorkflowTasks	The content of the response.

GetWorkflowTasksFromTasksRelationAsync()

Calls the HTTP Get method on the link for the relation “tasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromTasksRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>>	A task which runs the request.

Remarks

This method follows the link for the relation “tasks”.

GetWorkflowTasksFromTasksRelationAsync(System.Threading.CancellationToken)

Calls the HTTP Get method on the link for the relation “tasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromTasksRelationAsync(System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>>	A task which runs the request.

Remarks

This method follows the link for the relation “tasks”.

PostToTasksRelationForWorkflowTasks(TasksQuery)

Calls the HTTP Post method on the link for the relation “tasks”.

Declaration

public WorkflowTasks PostToTasksRelationForWorkflowTasks(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
WorkflowTasks	The content of the response.

PostToTasksRelationForWorkflowTasksAsync(TasksQuery)

Calls the HTTP Post method on the link for the relation “tasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksRelationForWorkflowTasksAsync(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>>	A task which runs the request.

Remarks

This method follows the link for the relation “tasks”.

PostToTasksRelationForWorkflowTasksAsync(System.Threading.CancellationToken, TasksQuery)

Calls the HTTP Post method on the link for the relation “tasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksRelationForWorkflowTasksAsync(System.Threading.CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>>	A task which runs the request.

Remarks

This method follows the link for the relation “tasks”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.