Class TrashBinDocumentsTableResult

Defines trash bin table result from document query

Inheritance

System.Object

TrashBinDocumentsTableResult

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

[Raccoon]
public class TrashBinDocumentsTableResult : IRelationsWithProxy

Properties

Count

Gets the number of items of the query leading to this result.

Declaration

public CountPlusValue Count { get; set; }

Property Value

Type	Description
CountPlusValue

FirstRelationLink

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

Declaration

public string FirstRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Headers

Declaration

public List<TrashBinTableHeader> Headers { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TrashBinTableHeader>

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

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

Declaration

public string NextRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

PrevRelationLink

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

Declaration

public string PrevRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Rows

Declaration

public List<TrashBinTableRow> Rows { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TrashBinTableRow>

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.

TimeStamp

TimeStamp of the result.

Declaration

public DateTime TimeStamp { get; set; }

Property Value

Type	Description
System.DateTime

Methods

GetTrashBinDocumentsTableResultFromFirstRelation()

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

Declaration

public TrashBinDocumentsTableResult GetTrashBinDocumentsTableResultFromFirstRelation()

Returns

Type	Description
TrashBinDocumentsTableResult	The content of the response.

GetTrashBinDocumentsTableResultFromFirstRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromFirstRelationAsync()

Returns

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

Remarks

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

GetTrashBinDocumentsTableResultFromFirstRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromFirstRelationAsync(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<TrashBinDocumentsTableResult>>	A task which runs the request.

Remarks

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

GetTrashBinDocumentsTableResultFromNextRelation()

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

Declaration

public TrashBinDocumentsTableResult GetTrashBinDocumentsTableResultFromNextRelation()

Returns

Type	Description
TrashBinDocumentsTableResult	The content of the response.

GetTrashBinDocumentsTableResultFromNextRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromNextRelationAsync()

Returns

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

Remarks

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

GetTrashBinDocumentsTableResultFromNextRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromNextRelationAsync(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<TrashBinDocumentsTableResult>>	A task which runs the request.

Remarks

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

GetTrashBinDocumentsTableResultFromPrevRelation()

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

Declaration

public TrashBinDocumentsTableResult GetTrashBinDocumentsTableResultFromPrevRelation()

Returns

Type	Description
TrashBinDocumentsTableResult	The content of the response.

GetTrashBinDocumentsTableResultFromPrevRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromPrevRelationAsync()

Returns

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

Remarks

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

GetTrashBinDocumentsTableResultFromPrevRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromPrevRelationAsync(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<TrashBinDocumentsTableResult>>	A task which runs the request.

Remarks

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

GetTrashBinDocumentsTableResultFromSelfRelation()

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

Declaration

public TrashBinDocumentsTableResult GetTrashBinDocumentsTableResultFromSelfRelation()

Returns

Type	Description
TrashBinDocumentsTableResult	The content of the response.

GetTrashBinDocumentsTableResultFromSelfRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromSelfRelationAsync()

Returns

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

Remarks

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

GetTrashBinDocumentsTableResultFromSelfRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromSelfRelationAsync(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<TrashBinDocumentsTableResult>>	A task which runs the request.

Remarks

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

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 System.Net.Http.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.