Class UserWorkflows

Inheritance

System.Object

UserWorkflows

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class UserWorkflows : IRelationsWithProxy

Properties

AccessDateTime

Declaration

public System.DateTime AccessDateTime { get; set; }

Property Value

Type	Description
System.DateTime

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SingleTaskRelationLink

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

Declaration

public string SingleTaskRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

TasksCount

Declaration

public int TasksCount { get; set; }

Property Value

Type	Description
System.Int32

WorkflowListRelationLink

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

Declaration

public string WorkflowListRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

WorkflowRelationLink

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

Declaration

public string WorkflowRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetWorkflowsFromWorkflowListRelation()

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

Declaration

public Workflows GetWorkflowsFromWorkflowListRelation()

Returns

Type	Description
Workflows	The content of the response.

GetWorkflowsFromWorkflowListRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflows>> GetWorkflowsFromWorkflowListRelationAsync()

Returns

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

Remarks

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

GetWorkflowsFromWorkflowListRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

PostToSingleTaskRelationForSingleTaskInformation(SingleTaskUrlParameters)

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

Declaration

public SingleTaskInformation PostToSingleTaskRelationForSingleTaskInformation(SingleTaskUrlParameters dataToSend)

Parameters

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

Returns

Type	Description
SingleTaskInformation	The content of the response.

PostToSingleTaskRelationForSingleTaskInformationAsync(SingleTaskUrlParameters)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleTaskInformation>> PostToSingleTaskRelationForSingleTaskInformationAsync(SingleTaskUrlParameters dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSingleTaskRelationForSingleTaskInformationAsync(System.Threading.CancellationToken, SingleTaskUrlParameters)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SingleTaskInformation>> PostToSingleTaskRelationForSingleTaskInformationAsync(System.Threading.CancellationToken cancellationToken, SingleTaskUrlParameters dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToWorkflowRelationForWorkflow(String)

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

Declaration

public Workflow PostToWorkflowRelationForWorkflow(string dataToSend)

Parameters

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

Returns

Type	Description
Workflow	The content of the response.

PostToWorkflowRelationForWorkflowAsync(String)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>> PostToWorkflowRelationForWorkflowAsync(string dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToWorkflowRelationForWorkflowAsync(System.Threading.CancellationToken, String)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Workflow>> PostToWorkflowRelationForWorkflowAsync(System.Threading.CancellationToken cancellationToken, string dataToSend)

Parameters

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

Returns

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

Remarks

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

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.