Class DesignerWorkflow

Model a designer workflow.

Inheritance

System.Object

DesignerWorkflow

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DesignerWorkflow : IRelationsWithProxy

Properties

Id

Id of the workflow.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

InstanceCount

Number of items for all versions of the workflow.

Declaration

public int InstanceCount { get; set; }

Property Value

Type	Description
System.Int32

InstanceCountSpecified

Declaration

public bool InstanceCountSpecified { get; set; }

Property Value

Type	Description
System.Boolean

InstancesRelationLink

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

Declaration

public string InstancesRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

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

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.

VersionsRelationLink

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

Declaration

public string VersionsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

WaitingInstancesRelationLink

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

Declaration

public string WaitingInstancesRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetDesignerInstancesFromInstancesRelation()

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

Declaration

public DesignerInstances GetDesignerInstancesFromInstancesRelation()

Returns

Type	Description
DesignerInstances	The content of the response.

GetDesignerInstancesFromInstancesRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerInstances>> GetDesignerInstancesFromInstancesRelationAsync()

Returns

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

Remarks

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

GetDesignerInstancesFromInstancesRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDesignerWaitingInstancesFromWaitingInstancesRelation()

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

Declaration

public DesignerWaitingInstances GetDesignerWaitingInstancesFromWaitingInstancesRelation()

Returns

Type	Description
DesignerWaitingInstances	The content of the response.

GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWaitingInstances>> GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync()

Returns

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

Remarks

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

GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDesignerWorkflowFromSelfRelation()

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

Declaration

public DesignerWorkflow GetDesignerWorkflowFromSelfRelation()

Returns

Type	Description
DesignerWorkflow	The content of the response.

GetDesignerWorkflowFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflow>> GetDesignerWorkflowFromSelfRelationAsync()

Returns

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

Remarks

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

GetDesignerWorkflowFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDesignerWorkflowVersionsFromVersionsRelation()

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

Declaration

public DesignerWorkflowVersions GetDesignerWorkflowVersionsFromVersionsRelation()

Returns

Type	Description
DesignerWorkflowVersions	The content of the response.

GetDesignerWorkflowVersionsFromVersionsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DesignerWorkflowVersions>> GetDesignerWorkflowVersionsFromVersionsRelationAsync()

Returns

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

Remarks

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

GetDesignerWorkflowVersionsFromVersionsRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

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.