Class RequestTask

A request task for a common user.

Inheritance

System.Object

RequestTask

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class RequestTask : IRelationsWithProxy

Properties

CreateDate

Creation date of the request.

Declaration

public System.DateTime CreateDate { get; set; }

Property Value

Type	Description
System.DateTime

Decisions

List of request decisions.

Declaration

public List<RequestDecision> Decisions { get; set; }

Property Value

Type	Description
List<RequestDecision>

Description

Description of the request.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DocId

Document id.

Declaration

public int DocId { get; set; }

Property Value

Type	Description
System.Int32

DocumentName

Name of the document.

Declaration

public string DocumentName { get; set; }

Property Value

Type	Description
System.String

FcGuid

File cabinet id of the document.

Declaration

public string FcGuid { get; set; }

Property Value

Type	Description
System.String

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

Task identifier.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

IsRead

Indicates whether the task is read.

Declaration

public bool IsRead { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Owner

Name of the initiator of the request.

Declaration

public string Owner { get; set; }

Property Value

Type	Description
System.String

ReadStatusRelationLink

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

Declaration

public string ReadStatusRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

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.

WorkflowId

Request identifier.

Declaration

public string WorkflowId { get; set; }

Property Value

Type	Description
System.String

WorkflowName

Name of the request.

Declaration

public string WorkflowName { get; set; }

Property Value

Type	Description
System.String

Methods

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 System.Threading.Tasks.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(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetRequestTaskFromSelfRelation()

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

Declaration

public RequestTask GetRequestTaskFromSelfRelation()

Returns

Type	Description
RequestTask	The content of the response.

GetRequestTaskFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestTask>> GetRequestTaskFromSelfRelationAsync()

Returns

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

Remarks

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

GetRequestTaskFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

PutToReadStatusRelationForString(System.IO.Stream)

Calls the HTTP Put method on the link for the relation “readStatus”.

Declaration

public string PutToReadStatusRelationForString(System.IO.Stream dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PutToReadStatusRelationForStringAsync(System.IO.Stream)

Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToReadStatusRelationForStringAsync(System.Threading.CancellationToken, System.IO.Stream)

Calls the HTTP Put method on the link for the relation “readStatus” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(System.Threading.CancellationToken cancellationToken, System.IO.Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

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.