Class InstanceHistory

List of history steps for an instance.

Inheritance

System.Object

InstanceHistory

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class InstanceHistory : IRelationsWithProxy

Properties

DocId

Document indentifier.

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

HistorySteps

List of history steps.

Declaration

public List<HistoryStep> HistorySteps { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<HistoryStep>

Id

Instance id.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Workflow name.

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.

StartedAt

DateTime for the start of history.

Declaration

public DateTime StartedAt { get; set; }

Property Value

Type	Description
System.DateTime

Version

Workflow version number.

Declaration

public int Version { get; set; }

Property Value

Type	Description
System.Int32

WorkflowId

Workflow id.

Declaration

public string WorkflowId { get; set; }

Property Value

Type	Description
System.String

WorkflowRequest

True if it is history for workflow request.

Declaration

public bool WorkflowRequest { get; set; }

Property Value

Type	Description
System.Boolean

Methods

GetInstanceHistoryFromSelfRelation()

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

Declaration

public InstanceHistory GetInstanceHistoryFromSelfRelation()

Returns

Type	Description
InstanceHistory	The content of the response.

GetInstanceHistoryFromSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromSelfRelationAsync()

Returns

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

Remarks

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

GetInstanceHistoryFromSelfRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromSelfRelationAsync(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<InstanceHistory>>	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.