Class Workflow

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Model a workflow.

public class Workflow : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Workflow

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ColumnDefinition

List of the visible columns of the workflow.

public ColumnsDefinition ColumnDefinition { get; set; }

Property Value

Type	Description
ColumnsDefinition

CountRelationLink

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

public string CountRelationLink { get; }

Property Value

Type	Description
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.

public string FileCabinetId { get; set; }

Property Value

Type	Description
string

HasDocumentFields

Indicates whether the task list contains document fields.

public bool HasDocumentFields { get; set; }

Property Value

Type	Description
bool

Id

Id of the workflow.

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Name of the workflow.

public string Name { get; set; }

Property Value

Type	Description
string

ResultListId

Id of the resultList needed to get context menu functions

public string ResultListId { get; set; }

Property Value

Type	Description
string

SelfRelationLink

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

public string SelfRelationLink { get; }

Property Value

Type	Description
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.

public int TaskCount { get; set; }

Property Value

Type	Description
int

TasksRelationLink

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

public string TasksRelationLink { get; }

Property Value

Type	Description
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.

public DateTime TimeStamp { get; set; }

Property Value

Type	Description
DateTime

WorkflowBehaviorOptions

public WorkflowBehaviorOptions WorkflowBehaviorOptions { get; set; }

Property Value

Type	Description
WorkflowBehaviorOptions

Methods

GetWorkflowFromSelfRelation()

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

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.

public Task<DeserializedHttpResponse<Workflow>> GetWorkflowFromSelfRelationAsync()

Returns

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

Remarks

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

GetWorkflowFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Workflow>> GetWorkflowFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksCountFromCountRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCountRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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”.

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.

public Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromTasksRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksFromTasksRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromTasksRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
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”.

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.

public 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
Task<DeserializedHttpResponse<WorkflowTasks>>	A task which runs the request.

Remarks

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

PostToTasksRelationForWorkflowTasksAsync(CancellationToken, TasksQuery)

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

public Task<DeserializedHttpResponse<WorkflowTasks>> PostToTasksRelationForWorkflowTasksAsync(CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

Type	Name	Description
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
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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient 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.