Class DesignerInstance

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Model a designer workflow instance.

public class DesignerInstance : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DesignerInstance

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

ColumnValues

Values in columns.

public List<ColumnValue> ColumnValues { get; set; }

Property Value

Type	Description
List<ColumnValue>

CreateDate

Creation date of the instance.

public DateTime CreateDate { get; set; }

Property Value

Type	Description
DateTime

DocId

Document id connected with the instance.

public int DocId { get; set; }

Property Value

Type	Description
int

DocIdSpecified

public bool DocIdSpecified { get; set; }

Property Value

Type	Description
bool

ExecutionState

Execution state.

public InstanceExecutionStateEnum ExecutionState { get; set; }

Property Value

Type	Description
InstanceExecutionStateEnum

HibernationState

Gets or sets the hibernation state.

[IgnoreDataMember]
public InstanceHibernationStateEnum HibernationState { get; set; }

Property Value

Type	Description
InstanceHibernationStateEnum

HibernationStateValue

Hibernation state.

public string HibernationStateValue { get; set; }

Property Value

Type	Description
string

Id

Id of the workflow instance.

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

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.

WorkflowVersionId

Workflow version id.

public string WorkflowVersionId { get; set; }

Property Value

Type	Description
string

Methods

DeleteSelfRelation()

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

public string DeleteSelfRelation()

Returns

Type	Description
string	The content of the response.

DeleteSelfRelationAsync()

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

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync()

Returns

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

public Task<DeserializedHttpResponse<string>> DeleteSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DesignerInstance>> GetDesignerInstanceFromSelfRelationAsync()

Returns

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

public Task<DeserializedHttpResponse<DesignerInstance>> GetDesignerInstanceFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.