Class WorkflowTasks
List of workflow tasks.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class WorkflowTasks : IRelationsWithProxy
Properties
Count
Total tasks count in the workflow.
Declaration
public int Count { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
FirstRelationLink
Gets the Uri of the link for the relation “first”.
Declaration
public string FirstRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “first” if it exists, or
HasDocumentFields
Indicates whether the task list contains document fields.
Declaration
public bool HasDocumentFields { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
NextRelationLink
Gets the Uri of the link for the relation “next”.
Declaration
public string NextRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “next” if it exists, or
PrevRelationLink
Gets the Uri of the link for the relation “prev”.
Declaration
public string PrevRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “prev” if it exists, or
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
Task
List of tasks.
Declaration
public List<WorkflowTask> Task { get; set; }
Property Value
Type | Description |
---|---|
List<WorkflowTask> |
TimeStamp
TimeStamp of the result.
Declaration
public System.DateTime TimeStamp { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Methods
GetWorkflowTasksFromFirstRelation()
Calls the HTTP Get method on the link for the relation “first”.
Declaration
public WorkflowTasks GetWorkflowTasksFromFirstRelation()
Returns
Type | Description |
---|---|
WorkflowTasks | The content of the response. |
GetWorkflowTasksFromFirstRelationAsync()
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromFirstRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetWorkflowTasksFromFirstRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromFirstRelationAsync(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<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetWorkflowTasksFromNextRelation()
Calls the HTTP Get method on the link for the relation “next”.
Declaration
public WorkflowTasks GetWorkflowTasksFromNextRelation()
Returns
Type | Description |
---|---|
WorkflowTasks | The content of the response. |
GetWorkflowTasksFromNextRelationAsync()
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromNextRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetWorkflowTasksFromNextRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromNextRelationAsync(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<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetWorkflowTasksFromPrevRelation()
Calls the HTTP Get method on the link for the relation “prev”.
Declaration
public WorkflowTasks GetWorkflowTasksFromPrevRelation()
Returns
Type | Description |
---|---|
WorkflowTasks | The content of the response. |
GetWorkflowTasksFromPrevRelationAsync()
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromPrevRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetWorkflowTasksFromPrevRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromPrevRelationAsync(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<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetWorkflowTasksFromSelfRelation()
Calls the HTTP Get method on the link for the relation “self”.
Declaration
public WorkflowTasks GetWorkflowTasksFromSelfRelation()
Returns
Type | Description |
---|---|
WorkflowTasks | The content of the response. |
GetWorkflowTasksFromSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetWorkflowTasksFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasks>> GetWorkflowTasksFromSelfRelationAsync(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<WorkflowTasks>> | 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 |
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.