Class WorkflowRequests

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public class WorkflowRequests : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

WorkflowRequests

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

CreatedWorkflowsCountRelationLink

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

public string CreatedWorkflowsCountRelationLink { get; }

Property Value

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

public string CreatedWorkflowsRelationLink { get; }

Property Value

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

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

MyTasksCountRelationLink

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

public string MyTasksCountRelationLink { get; }

Property Value

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

public string MyTasksRelationLink { get; }

Property Value

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

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.

public Task<DeserializedHttpResponse<OwnWorkflows>> GetOwnWorkflowsFromCreatedWorkflowsRelationAsync()

Returns

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

Remarks

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

GetOwnWorkflowsFromCreatedWorkflowsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<OwnWorkflows>> GetOwnWorkflowsFromCreatedWorkflowsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<RequestTasks>> GetRequestTasksFromMyTasksRelationAsync()

Returns

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

Remarks

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

GetRequestTasksFromMyTasksRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<RequestTasks>> GetRequestTasksFromMyTasksRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromCreatedWorkflowsCountRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromMyTasksCountRelationAsync()

Returns

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

Remarks

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

GetWorkflowTasksCountFromMyTasksCountRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<WorkflowTasksCount>> GetWorkflowTasksCountFromMyTasksCountRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

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

Remarks

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

PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(CancellationToken, TasksQuery)

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

public Task<DeserializedHttpResponse<OwnWorkflows>> PostToCreatedWorkflowsRelationForOwnWorkflowsAsync(CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

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

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.

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

Remarks

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

PostToMyTasksRelationForRequestTasksAsync(CancellationToken, TasksQuery)

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

public Task<DeserializedHttpResponse<RequestTasks>> PostToMyTasksRelationForRequestTasksAsync(CancellationToken cancellationToken, TasksQuery dataToSend)

Parameters

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

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.