Class InstanceHistory

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

List of history steps for an instance.

public class InstanceHistory : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

InstanceHistory

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

DocId

Document indentifier.

public int DocId { get; set; }

Property Value

Type	Description
int

HistorySteps

List of history steps.

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

Property Value

Type	Description
List<HistoryStep>

Id

Instance id.

public string Id { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Workflow name.

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.

StartedAt

DateTime for the start of history.

public DateTime StartedAt { get; set; }

Property Value

Type	Description
DateTime

Version

Workflow version number.

public int Version { get; set; }

Property Value

Type	Description
int

WorkflowId

Workflow id.

public string WorkflowId { get; set; }

Property Value

Type	Description
string

WorkflowRequest

True if it is history for workflow request.

public bool WorkflowRequest { get; set; }

Property Value

Type	Description
bool

Methods

GetInstanceHistoryFromSelfRelation()

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

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.

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromSelfRelationAsync()

Returns

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

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.