Class Task

---

Inheritance

System.Object

Task

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Task : IRelationsWithProxy

Properties

ColumnsValue

Declaration

public List<ColumnValue> ColumnsValue { get; set; }

Property Value

Type	Description
List<ColumnValue>

CompositeDataRelationLink

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

Declaration

public string CompositeDataRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

DecisionStampRelationLink

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

Declaration

public string DecisionStampRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

DocumentRightsRelationLink

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

Declaration

public string DocumentRightsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

DwVerId

Declaration

public int DwVerId { get; set; }

Property Value

Type	Description
System.Int32

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

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

InstanceId

Declaration

public string InstanceId { get; set; }

Property Value

Type	Description
System.String

IsRead

Declaration

public bool IsRead { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

LockRelationLink

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

Declaration

public string LockRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

MarkasreadRelationLink

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

Declaration

public string MarkasreadRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ReassignRelationLink

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

Declaration

public string ReassignRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

StopRelationLink

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

Declaration

public string StopRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

TaskState

Declaration

public TaskState TaskState { get; set; }

Property Value

Type	Description
TaskState

Methods

GetCompositeDataFromCompositeDataRelation()

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

Declaration

public CompositeData GetCompositeDataFromCompositeDataRelation()

Returns

Type	Description
CompositeData	The content of the response.

GetCompositeDataFromCompositeDataRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<CompositeData>> GetCompositeDataFromCompositeDataRelationAsync()

Returns

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

Remarks

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

GetCompositeDataFromCompositeDataRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDecisionStampsFromDecisionStampRelation()

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

Declaration

public DecisionStamps GetDecisionStampsFromDecisionStampRelation()

Returns

Type	Description
DecisionStamps	The content of the response.

GetDecisionStampsFromDecisionStampRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DecisionStamps>> GetDecisionStampsFromDecisionStampRelationAsync()

Returns

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

Remarks

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

GetDecisionStampsFromDecisionStampRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDocumentWorkflowHistoryStepsFromHistoryRelation()

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

Declaration

public DocumentWorkflowHistorySteps GetDocumentWorkflowHistoryStepsFromHistoryRelation()

Returns

Type	Description
DocumentWorkflowHistorySteps	The content of the response.

GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentWorkflowHistorySteps>> GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync()

Returns

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

Remarks

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

GetDocumentWorkflowHistoryStepsFromHistoryRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetStringFromStopRelation()

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

Declaration

public string GetStringFromStopRelation()

Returns

Type	Description
System.String	The content of the response.

GetStringFromStopRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> GetStringFromStopRelationAsync()

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 “stop”.

GetStringFromStopRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

PostToDocumentRightsRelationForBpwDocument(StringParameter)

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

Declaration

public BpwDocument PostToDocumentRightsRelationForBpwDocument(StringParameter dataToSend)

Parameters

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

Returns

Type	Description
BpwDocument	The content of the response.

PostToDocumentRightsRelationForBpwDocumentAsync(StringParameter)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BpwDocument>> PostToDocumentRightsRelationForBpwDocumentAsync(StringParameter dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToDocumentRightsRelationForBpwDocumentAsync(System.Threading.CancellationToken, StringParameter)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BpwDocument>> PostToDocumentRightsRelationForBpwDocumentAsync(System.Threading.CancellationToken cancellationToken, StringParameter dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToLockRelationForString(LockParameter)

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

Declaration

public string PostToLockRelationForString(LockParameter dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PostToLockRelationForStringAsync(LockParameter)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(LockParameter dataToSend)

Parameters

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

PostToLockRelationForStringAsync(System.Threading.CancellationToken, LockParameter)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToLockRelationForStringAsync(System.Threading.CancellationToken cancellationToken, LockParameter dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
LockParameter	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 “lock”.

PostToMarkasreadRelationForString(String)

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

Declaration

public string PostToMarkasreadRelationForString(string dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PostToMarkasreadRelationForStringAsync(String)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToMarkasreadRelationForStringAsync(string dataToSend)

Parameters

Type	Name	Description
System.String	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 “markasread”.

PostToMarkasreadRelationForStringAsync(System.Threading.CancellationToken, String)

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

Declaration

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

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
System.String	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 “markasread”.

PostToReassignRelationForString(ReassignData)

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

Declaration

public string PostToReassignRelationForString(ReassignData dataToSend)

Parameters

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

Returns

Type	Description
System.String	The content of the response.

PostToReassignRelationForStringAsync(ReassignData)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToReassignRelationForStringAsync(ReassignData dataToSend)

Parameters

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

PostToReassignRelationForStringAsync(System.Threading.CancellationToken, ReassignData)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToReassignRelationForStringAsync(System.Threading.CancellationToken cancellationToken, ReassignData dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
ReassignData	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 “reassign”.

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.