Class DesignerWorkflow

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Model a designer workflow.

public class DesignerWorkflow : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DesignerWorkflow

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

HistoryInstancesRelationLink

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

public string HistoryInstancesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Id of the workflow.

public string Id { get; set; }

Property Value

Type	Description
string

InstanceCount

Number of items for all versions of the workflow.

public int InstanceCount { get; set; }

Property Value

Type	Description
int

InstanceCountSpecified

public bool InstanceCountSpecified { get; set; }

Property Value

Type	Description
bool

InstancesRelationLink

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

public string InstancesRelationLink { get; }

Property Value

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

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

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.

TimeStamp

Time of sending.

public DateTime TimeStamp { get; set; }

Property Value

Type	Description
DateTime

VersionsRelationLink

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

public string VersionsRelationLink { get; }

Property Value

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

public string WaitingInstancesRelationLink { get; }

Property Value

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

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.

public Task<DeserializedHttpResponse<DesignerInstances>> GetDesignerInstancesFromInstancesRelationAsync()

Returns

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

Remarks

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

GetDesignerInstancesFromInstancesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DesignerInstances>> GetDesignerInstancesFromInstancesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DesignerWaitingInstances>> GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync()

Returns

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

Remarks

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

GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DesignerWaitingInstances>> GetDesignerWaitingInstancesFromWaitingInstancesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DesignerWorkflow>> GetDesignerWorkflowFromSelfRelationAsync()

Returns

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

Remarks

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

GetDesignerWorkflowFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DesignerWorkflow>> GetDesignerWorkflowFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DesignerWorkflowVersions>> GetDesignerWorkflowVersionsFromVersionsRelationAsync()

Returns

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

Remarks

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

GetDesignerWorkflowVersionsFromVersionsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DesignerWorkflowVersions>> GetDesignerWorkflowVersionsFromVersionsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetHistoryInstancesFromHistoryInstancesRelation()

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

public HistoryInstances GetHistoryInstancesFromHistoryInstancesRelation()

Returns

Type	Description
HistoryInstances	The content of the response.

GetHistoryInstancesFromHistoryInstancesRelationAsync()

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

public Task<DeserializedHttpResponse<HistoryInstances>> GetHistoryInstancesFromHistoryInstancesRelationAsync()

Returns

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

Remarks

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

GetHistoryInstancesFromHistoryInstancesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<HistoryInstances>> GetHistoryInstancesFromHistoryInstancesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetWorkflowInstancesCountFromCountRelation()

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

public WorkflowInstancesCount GetWorkflowInstancesCountFromCountRelation()

Returns

Type	Description
WorkflowInstancesCount	The content of the response.

GetWorkflowInstancesCountFromCountRelationAsync()

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

public Task<DeserializedHttpResponse<WorkflowInstancesCount>> GetWorkflowInstancesCountFromCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowInstancesCountFromCountRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowInstancesCount>> GetWorkflowInstancesCountFromCountRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToHistoryInstancesRelationForHistoryInstances(InstancesQuery)

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

public HistoryInstances PostToHistoryInstancesRelationForHistoryInstances(InstancesQuery dataToSend)

Parameters

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

Returns

Type	Description
HistoryInstances	The content of the response.

PostToHistoryInstancesRelationForHistoryInstancesAsync(InstancesQuery)

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

public Task<DeserializedHttpResponse<HistoryInstances>> PostToHistoryInstancesRelationForHistoryInstancesAsync(InstancesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToHistoryInstancesRelationForHistoryInstancesAsync(CancellationToken, InstancesQuery)

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

public Task<DeserializedHttpResponse<HistoryInstances>> PostToHistoryInstancesRelationForHistoryInstancesAsync(CancellationToken cancellationToken, InstancesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToInstancesRelationForDesignerInstances(InstancesQuery)

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

public DesignerInstances PostToInstancesRelationForDesignerInstances(InstancesQuery dataToSend)

Parameters

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

Returns

Type	Description
DesignerInstances	The content of the response.

PostToInstancesRelationForDesignerInstancesAsync(InstancesQuery)

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

public Task<DeserializedHttpResponse<DesignerInstances>> PostToInstancesRelationForDesignerInstancesAsync(InstancesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToInstancesRelationForDesignerInstancesAsync(CancellationToken, InstancesQuery)

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

public Task<DeserializedHttpResponse<DesignerInstances>> PostToInstancesRelationForDesignerInstancesAsync(CancellationToken cancellationToken, InstancesQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

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.