Class SimpleTaskListItem

Namespace

DocuWare.Platform.Bpw.Schemas

Assembly

DocuWare.Platform.ServerClient.dll

public class SimpleTaskListItem : BaseSimpeWorkflowleItem, IRelationsWithProxy

Inheritance

Object

BaseSimpeWorkflowleItem

SimpleTaskListItem

Implements

IRelationsWithProxy

Inherited Members

BaseSimpeWorkflowleItem.DocumentInformation

BaseSimpeWorkflowleItem.Id

BaseSimpeWorkflowleItem.Owner

BaseSimpeWorkflowleItem.WorkflowName

BaseSimpeWorkflowleItem.DocumentName

BaseSimpeWorkflowleItem.DwVerId

BaseSimpeWorkflowleItem.FcGuid

BaseSimpeWorkflowleItem.PercentCompleted

BaseSimpeWorkflowleItem.PercentCompletedSpecified

BaseSimpeWorkflowleItem.CreateDate

Properties

ConfirmRelationLink

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

public string ConfirmRelationLink { get; }

Property Value

Type	Description
String

Remarks

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

Decisions

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

Property Value

Type	Description
List<SimpleTaskDecision>

Description

public string Description { 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.

InstanceGuid

public string InstanceGuid { get; set; }

Property Value

Type	Description
String

IsRead

public bool IsRead { get; set; }

Property Value

Type	Description
Boolean

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

MarkasreadRelationLink

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

public string MarkasreadRelationLink { get; }

Property Value

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

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.

SetStampAuto

public bool SetStampAuto { get; set; }

Property Value

Type	Description
Boolean

Methods

GetDocumentWorkflowHistoryStepsFromHistoryRelation()

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

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.

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.

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

GetSimpleTaskListItemFromSelfRelation()

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

public SimpleTaskListItem GetSimpleTaskListItemFromSelfRelation()

Returns

Type	Description
SimpleTaskListItem	The content of the response.

GetSimpleTaskListItemFromSelfRelationAsync()

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleTaskListItem>> GetSimpleTaskListItemFromSelfRelationAsync()

Returns

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

Remarks

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

GetSimpleTaskListItemFromSelfRelationAsync(System.Threading.CancellationToken)

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

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

Remarks

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

PostToConfirmRelationForString(ConfirmSimpleTaskData)

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

public string PostToConfirmRelationForString(ConfirmSimpleTaskData dataToSend)

Parameters

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

Returns

Type	Description
String	The content of the response.

PostToConfirmRelationForStringAsync(ConfirmSimpleTaskData)

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

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

Parameters

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

Returns

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

Remarks

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

PostToConfirmRelationForStringAsync(System.Threading.CancellationToken, ConfirmSimpleTaskData)

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

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

Parameters

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

Returns

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

Remarks

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

PostToMarkasreadRelationForString(String)

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

public string PostToMarkasreadRelationForString(string dataToSend)

Parameters

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

Returns

Type	Description
String	The content of the response.

PostToMarkasreadRelationForStringAsync(String)

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

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

Parameters

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

Returns

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

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.
String	dataToSend	The data to send. This data is written into the request body.

Returns

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

Remarks

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

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

public override void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Overrides

BaseSimpeWorkflowleItem.SetProxy(HttpClientProxy)

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.