Class SimpleTasksData

---

Inheritance

System.Object

SimpleTasksData

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class SimpleTasksData : IRelationsWithProxy

Properties

AccessDateTime

Declaration

public System.DateTime AccessDateTime { get; set; }

Property Value

Type	Description
System.DateTime

Count

Declaration

public int Count { get; set; }

Property Value

Type	Description
System.Int32

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SingleItemRelationLink

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

Declaration

public string SingleItemRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

TasksRelationLink

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

Declaration

public string TasksRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetSimpleTaskListItemsFromTasksRelation()

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

Declaration

public SimpleTaskListItems GetSimpleTaskListItemsFromTasksRelation()

Returns

Type	Description
SimpleTaskListItems	The content of the response.

GetSimpleTaskListItemsFromTasksRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleTaskListItems>> GetSimpleTaskListItemsFromTasksRelationAsync()

Returns

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

Remarks

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

GetSimpleTaskListItemsFromTasksRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

PostToSingleItemRelationForSimpleTaskListItem(String)

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

Declaration

public SimpleTaskListItem PostToSingleItemRelationForSimpleTaskListItem(string dataToSend)

Parameters

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

Returns

Type	Description
SimpleTaskListItem	The content of the response.

PostToSingleItemRelationForSimpleTaskListItemAsync(String)

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

Declaration

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

Remarks

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

PostToSingleItemRelationForSimpleTaskListItemAsync(System.Threading.CancellationToken, String)

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

Declaration

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

Remarks

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

PostToTasksRelationForSimpleTaskListItems(TaskQuery)

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

Declaration

public SimpleTaskListItems PostToTasksRelationForSimpleTaskListItems(TaskQuery dataToSend)

Parameters

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

Returns

Type	Description
SimpleTaskListItems	The content of the response.

PostToTasksRelationForSimpleTaskListItemsAsync(TaskQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleTaskListItems>> PostToTasksRelationForSimpleTaskListItemsAsync(TaskQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToTasksRelationForSimpleTaskListItemsAsync(System.Threading.CancellationToken, TaskQuery)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleTaskListItems>> PostToTasksRelationForSimpleTaskListItemsAsync(System.Threading.CancellationToken cancellationToken, TaskQuery dataToSend)

Parameters

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

Returns

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

Remarks

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

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.