Class Workflow

---

Inheritance

System.Object

Workflow

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Workflow : IRelationsWithProxy

Properties

AccessDateTime

Declaration

public System.DateTime AccessDateTime { get; set; }

Property Value

Type	Description
System.DateTime

FileCabinetId

Declaration

public string FileCabinetId { get; set; }

Property Value

Type	Description
System.String

FileCabinetRelationLink

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

Declaration

public string FileCabinetRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “fileCabinet” 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.

Id

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

TasksCount

Declaration

public int TasksCount { 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.

Methods

GetFileCabinetFromFileCabinetRelation()

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

Declaration

public FileCabinet GetFileCabinetFromFileCabinetRelation()

Returns

Type	Description
FileCabinet	The content of the response.

GetFileCabinetFromFileCabinetRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromFileCabinetRelationAsync()

Returns

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

Remarks

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

GetFileCabinetFromFileCabinetRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<FileCabinet>> GetFileCabinetFromFileCabinetRelationAsync(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<FileCabinet>>	A task which runs the request.

Remarks

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

GetTasksFromTasksRelation()

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

Declaration

public Tasks GetTasksFromTasksRelation()

Returns

Type	Description
Tasks	The content of the response.

GetTasksFromTasksRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Tasks>> GetTasksFromTasksRelationAsync()

Returns

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

Remarks

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

GetTasksFromTasksRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Tasks>> GetTasksFromTasksRelationAsync(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<Tasks>>	A task which runs the request.

Remarks

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

PostToTasksRelationForTasks(TaskQuery)

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

Declaration

public Tasks PostToTasksRelationForTasks(TaskQuery dataToSend)

Parameters

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

Returns

Type	Description
Tasks	The content of the response.

PostToTasksRelationForTasksAsync(TaskQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Tasks>> PostToTasksRelationForTasksAsync(TaskQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToTasksRelationForTasksAsync(System.Threading.CancellationToken, TaskQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Tasks>> PostToTasksRelationForTasksAsync(System.Threading.CancellationToken cancellationToken, TaskQuery dataToSend)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Tasks>>	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.