Class WorkflowRequests

Inheritance

System.Object

WorkflowRequests

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class WorkflowRequests : IRelationsWithProxy

Properties

CreatedWorkflowsCountRelationLink

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

Declaration

public string CreatedWorkflowsCountRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

CreatedWorkflowsRelationLink

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

Declaration

public string CreatedWorkflowsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

MyTasksCountRelationLink

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

Declaration

public string MyTasksCountRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

MyTasksRelationLink

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

Declaration

public string MyTasksRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetOwnWorkflowsFromCreatedWorkflowsRelation()

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

Declaration

public OwnWorkflows GetOwnWorkflowsFromCreatedWorkflowsRelation()

Returns

Type	Description
OwnWorkflows	The content of the response.

GetOwnWorkflowsFromCreatedWorkflowsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflows>> GetOwnWorkflowsFromCreatedWorkflowsRelationAsync()

Returns

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

Remarks

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

GetOwnWorkflowsFromCreatedWorkflowsRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflows>> GetOwnWorkflowsFromCreatedWorkflowsRelationAsync(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<OwnWorkflows>>	A task which runs the request.

Remarks

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

GetRequestTasksFromMyTasksRelation()

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

Declaration

public RequestTasks GetRequestTasksFromMyTasksRelation()

Returns

Type	Description
RequestTasks	The content of the response.

GetRequestTasksFromMyTasksRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestTasks>> GetRequestTasksFromMyTasksRelationAsync()

Returns

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

Remarks

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

GetRequestTasksFromMyTasksRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestTasks>> GetRequestTasksFromMyTasksRelationAsync(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<RequestTasks>>	A task which runs the request.

Remarks

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

GetWorkflowTasksCountFromCreatedWorkflowsCountRelation()

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

Declaration

public WorkflowTasksCount GetWorkflowTasksCountFromCreatedWorkflowsCountRelation()

Returns

Type	Description
WorkflowTasksCount	The content of the response.

GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync(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<WorkflowTasksCount>>	A task which runs the request.

Remarks

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

GetWorkflowTasksCountFromMyTasksCountRelation()

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

Declaration

public WorkflowTasksCount GetWorkflowTasksCountFromMyTasksCountRelation()

Returns

Type	Description
WorkflowTasksCount	The content of the response.

GetWorkflowTasksCountFromMyTasksCountRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromMyTasksCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksCountFromMyTasksCountRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromMyTasksCountRelationAsync(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<WorkflowTasksCount>>	A task which runs the request.

Remarks

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

PostToCreatedWorkflowsRelationForOwnWorkflows(TasksQuery)

Calls the HTTP Post method on the link for the relation “createdWorkflows”.

Declaration

public OwnWorkflows PostToCreatedWorkflowsRelationForOwnWorkflows(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
OwnWorkflows	The content of the response.

PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(TasksQuery)

Calls the HTTP Post method on the link for the relation “createdWorkflows” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflows>> PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(System.Threading.CancellationToken, TasksQuery)

Calls the HTTP Post method on the link for the relation “createdWorkflows” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<OwnWorkflows>> PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(System.Threading.CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToMyTasksRelationForRequestTasks(TasksQuery)

Calls the HTTP Post method on the link for the relation “myTasks”.

Declaration

public RequestTasks PostToMyTasksRelationForRequestTasks(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
RequestTasks	The content of the response.

PostToMyTasksRelationForRequestTasksAsync(TasksQuery)

Calls the HTTP Post method on the link for the relation “myTasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestTasks>> PostToMyTasksRelationForRequestTasksAsync(TasksQuery dataToSend)

Parameters

Type	Name	Description
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

PostToMyTasksRelationForRequestTasksAsync(System.Threading.CancellationToken, TasksQuery)

Calls the HTTP Post method on the link for the relation “myTasks” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestTasks>> PostToMyTasksRelationForRequestTasksAsync(System.Threading.CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
TasksQuery	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

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.