Class TrashBinDocumentsTableResult
Defines trash bin table result from document query
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
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
Headers
Declaration
public List<TrashBinTableHeader> Headers { get; set; }
Property Value
Type | Description |
---|---|
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
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
Rows
Declaration
public List<TrashBinTableRow> Rows { get; set; }
Property Value
Type | Description |
---|---|
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
TimeStamp
TimeStamp of the result.
Declaration
public System.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 System.Threading.Tasks.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(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromFirstRelationAsync(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<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 System.Threading.Tasks.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(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromNextRelationAsync(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<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 System.Threading.Tasks.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(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromPrevRelationAsync(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<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 System.Threading.Tasks.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(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromSelfRelationAsync(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<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 |
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.