Class RequestTask

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

A request task for a common user.

public class RequestTask : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

RequestTask

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

AllowDecisionStamp

Indicates whether stamps are allowed for taking of the decisions.

public bool AllowDecisionStamp { get; set; }

Property Value

Type	Description
bool

CreateDate

Creation date of the request.

public DateTime CreateDate { get; set; }

Property Value

Type	Description
DateTime

Decisions

List of request decisions.

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

Property Value

Type	Description
List<RequestDecision>

Description

Description of the request.

public string Description { get; set; }

Property Value

Type	Description
string

DocId

Document id.

public int DocId { get; set; }

Property Value

Type	Description
int

DocumentName

Name of the document.

public string DocumentName { get; set; }

Property Value

Type	Description
string

FcGuid

File cabinet id of the document.

public string FcGuid { get; set; }

Property Value

Type	Description
string

HistoryRelationLink

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

public string HistoryRelationLink { get; }

Property Value

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

public string Id { get; set; }

Property Value

Type	Description
string

IsRead

Indicates whether the task is read.

public bool IsRead { get; set; }

Property Value

Type	Description
bool

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Owner

Name of the initiator of the request.

public string Owner { get; set; }

Property Value

Type	Description
string

ReadStatusRelationLink

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

public string ReadStatusRelationLink { get; }

Property Value

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

public string SelfRelationLink { get; }

Property Value

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

StampSettingsRelationLink

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

public string StampSettingsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

public string WorkflowId { get; set; }

Property Value

Type	Description
string

WorkflowName

Name of the request.

public string WorkflowName { get; set; }

Property Value

Type	Description
string

Methods

GetInstanceHistoryFromHistoryRelation()

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

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.

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync()

Returns

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

Remarks

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

GetInstanceHistoryFromHistoryRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetRequestDecisionsStampSettingsFromStampSettingsRelation()

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

public RequestDecisionsStampSettings GetRequestDecisionsStampSettingsFromStampSettingsRelation()

Returns

Type	Description
RequestDecisionsStampSettings	The content of the response.

GetRequestDecisionsStampSettingsFromStampSettingsRelationAsync()

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

public Task<DeserializedHttpResponse<RequestDecisionsStampSettings>> GetRequestDecisionsStampSettingsFromStampSettingsRelationAsync()

Returns

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

Remarks

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

GetRequestDecisionsStampSettingsFromStampSettingsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<RequestDecisionsStampSettings>> GetRequestDecisionsStampSettingsFromStampSettingsRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetRequestTaskFromSelfRelation()

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

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.

public Task<DeserializedHttpResponse<RequestTask>> GetRequestTaskFromSelfRelationAsync()

Returns

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

Remarks

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

GetRequestTaskFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<RequestTask>> GetRequestTaskFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PutToReadStatusRelationForString(Stream)

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

public string PutToReadStatusRelationForString(Stream dataToSend)

Parameters

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

Returns

Type	Description
string	The content of the response.

PutToReadStatusRelationForStringAsync(Stream)

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

public Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(Stream dataToSend)

Parameters

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

Returns

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

Remarks

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

PutToReadStatusRelationForStringAsync(CancellationToken, Stream)

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

public Task<DeserializedHttpResponse<string>> PutToReadStatusRelationForStringAsync(CancellationToken cancellationToken, Stream dataToSend)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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.

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.