Class DocumentWorkflowMetadata

---

Inheritance

System.Object

DocumentWorkflowMetadata

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DocumentWorkflowMetadata : IRelationsWithProxy

Properties

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.

InstanceId

Declaration

public string InstanceId { get; set; }

Property Value

Type	Description
System.String

IsSimple

Declaration

public bool IsSimple { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

WorkflowName

Declaration

public string WorkflowName { get; set; }

Property Value

Type	Description
System.String

Methods

GetDocumentWorkflowHistoryStepsFromHistoryRelation()

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

Declaration

public DocumentWorkflowHistorySteps GetDocumentWorkflowHistoryStepsFromHistoryRelation()

Returns

Type	Description
DocumentWorkflowHistorySteps	The content of the response.

GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWorkflowHistorySteps>> GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync()

Returns

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

Remarks

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

GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWorkflowHistorySteps>> GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync(System.Threading.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<DocumentWorkflowHistorySteps>>	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 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.