Class HistoryInstance

Model a history workflow instance.

Inheritance

System.Object

HistoryInstance

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class HistoryInstance : IRelationsWithProxy

Properties

ColumnValues

Values in columns.

Declaration

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

Property Value

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

DocId

Document id connected with the instance(optional).

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

DocIdSpecified

Declaration

public bool DocIdSpecified { get; set; }

Property Value

Type	Description
System.Boolean

HistoryRelationLink

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

Declaration

public string HistoryRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Methods

GetHistoryInstanceFromSelfRelation()

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

Declaration

public HistoryInstance GetHistoryInstanceFromSelfRelation()

Returns

Type	Description
HistoryInstance	The content of the response.

GetHistoryInstanceFromSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<HistoryInstance>> GetHistoryInstanceFromSelfRelationAsync()

Returns

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

Remarks

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

GetHistoryInstanceFromSelfRelationAsync(CancellationToken)

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

Declaration

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

Remarks

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

GetInstanceHistoryFromHistoryRelation()

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

Declaration

public InstanceHistory GetInstanceHistoryFromHistoryRelation()

Returns

Type	Description
InstanceHistory	The content of the response.

GetInstanceHistoryFromHistoryRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync()

Returns

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

Remarks

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

GetInstanceHistoryFromHistoryRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync(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 “history”.

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.