Class DesignerInstance

Model a designer workflow instance.

Inheritance

System.Object

DesignerInstance

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DesignerInstance : IRelationsWithProxy

Properties

CreateDate

Creation date of the instance.

Declaration

public DateTime CreateDate { get; set; }

Property Value

Type	Description
System.DateTime

DocId

Document id connected with the instance.

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

ExecutionState

Execution state.

Declaration

public InstanceExecutionStateEnum ExecutionState { get; set; }

Property Value

Type	Description
InstanceExecutionStateEnum

Id

Id of the workflow instance.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

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.

WorkflowVersionId

Workflow version id.

Declaration

public string WorkflowVersionId { get; set; }

Property Value

Type	Description
System.String

Methods

DeleteSelfRelation()

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

Declaration

public string DeleteSelfRelation()

Returns

Type	Description
System.String	The content of the response.

DeleteSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

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

Remarks

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

DeleteSelfRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(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<System.String>>	A task which runs the request.

Remarks

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

GetDesignerInstanceFromSelfRelation()

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

Declaration

public DesignerInstance GetDesignerInstanceFromSelfRelation()

Returns

Type	Description
DesignerInstance	The content of the response.

GetDesignerInstanceFromSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<DesignerInstance>> GetDesignerInstanceFromSelfRelationAsync()

Returns

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

Remarks

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

GetDesignerInstanceFromSelfRelationAsync(CancellationToken)

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

Declaration

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

Remarks

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

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 System.Net.Http.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.