Class TrashBin
Definition for trash bin.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class TrashBin : IRelationsWithProxy
Properties
BatchDeleteRelationLink
Gets the Uri of the link for the relation “batchDelete”.
Declaration
public string BatchDeleteRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “batchDelete” if it exists, or
BatchRestoreRelationLink
Gets the Uri of the link for the relation “batchRestore”.
Declaration
public string BatchRestoreRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “batchRestore” if it exists, or
CountDocumentsRelationLink
Gets the Uri of the link for the relation “countDocuments”.
Declaration
public string CountDocumentsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “countDocuments” if it exists, or
DocumentsRelationLink
Gets the Uri of the link for the relation “documents”.
Declaration
public string DocumentsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “documents” if it exists, or
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
QueryDocumentsRelationLink
Gets the Uri of the link for the relation “queryDocuments”.
Declaration
public string QueryDocumentsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “queryDocuments” if it exists, or
SelectListsRelationLink
Gets the Uri of the link for the relation “selectLists”.
Declaration
public string SelectListsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “selectLists” if it exists, or
Methods
GetCountResultFromCountDocumentsRelation()
Calls the HTTP Get method on the link for the relation “countDocuments”.
Declaration
public CountResult GetCountResultFromCountDocumentsRelation()
Returns
Type | Description |
---|---|
CountResult | The content of the response. |
GetCountResultFromCountDocumentsRelationAsync()
Calls the HTTP Get method on the link for the relation “countDocuments” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountDocumentsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “countDocuments”.
GetCountResultFromCountDocumentsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “countDocuments” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountDocumentsRelationAsync(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<CountResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “countDocuments”.
GetTrashBinDocumentsTableResultFromDocumentsRelation()
Calls the HTTP Get method on the link for the relation “documents”.
Declaration
public TrashBinDocumentsTableResult GetTrashBinDocumentsTableResultFromDocumentsRelation()
Returns
Type | Description |
---|---|
TrashBinDocumentsTableResult | The content of the response. |
GetTrashBinDocumentsTableResultFromDocumentsRelationAsync()
Calls the HTTP Get method on the link for the relation “documents” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromDocumentsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “documents”.
GetTrashBinDocumentsTableResultFromDocumentsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “documents” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromDocumentsRelationAsync(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 “documents”.
GetTypedSelectListResultFromSelectListsRelation()
Calls the HTTP Get method on the link for the relation “selectLists”.
Declaration
public TypedSelectListResult GetTypedSelectListResultFromSelectListsRelation()
Returns
Type | Description |
---|---|
TypedSelectListResult | The content of the response. |
GetTypedSelectListResultFromSelectListsRelationAsync()
Calls the HTTP Get method on the link for the relation “selectLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> GetTypedSelectListResultFromSelectListsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectLists”.
GetTypedSelectListResultFromSelectListsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “selectLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> GetTypedSelectListResultFromSelectListsRelationAsync(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<TypedSelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectLists”.
PostToBatchDeleteRelationForBatchDeleteResult(BatchDeleteDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchDelete”.
Declaration
public BatchDeleteResult PostToBatchDeleteRelationForBatchDeleteResult(BatchDeleteDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchDeleteDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
BatchDeleteResult | The content of the response. |
PostToBatchDeleteRelationForBatchDeleteResultAsync(BatchDeleteDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchDelete” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchDeleteResult>> PostToBatchDeleteRelationForBatchDeleteResultAsync(BatchDeleteDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchDeleteDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchDeleteResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “batchDelete”.
PostToBatchDeleteRelationForBatchDeleteResultAsync(System.Threading.CancellationToken, BatchDeleteDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchDelete” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchDeleteResult>> PostToBatchDeleteRelationForBatchDeleteResultAsync(System.Threading.CancellationToken cancellationToken, BatchDeleteDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
BatchDeleteDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchDeleteResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “batchDelete”.
PostToBatchRestoreRelationForBatchRestoreResult(BatchRestoreDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchRestore”.
Declaration
public BatchRestoreResult PostToBatchRestoreRelationForBatchRestoreResult(BatchRestoreDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchRestoreDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
BatchRestoreResult | The content of the response. |
PostToBatchRestoreRelationForBatchRestoreResultAsync(BatchRestoreDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchRestore” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchRestoreResult>> PostToBatchRestoreRelationForBatchRestoreResultAsync(BatchRestoreDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchRestoreDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchRestoreResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “batchRestore”.
PostToBatchRestoreRelationForBatchRestoreResultAsync(System.Threading.CancellationToken, BatchRestoreDocumentsSource)
Calls the HTTP Post method on the link for the relation “batchRestore” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchRestoreResult>> PostToBatchRestoreRelationForBatchRestoreResultAsync(System.Threading.CancellationToken cancellationToken, BatchRestoreDocumentsSource dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
BatchRestoreDocumentsSource | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<BatchRestoreResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “batchRestore”.
PostToQueryDocumentsRelationForTrashBinDocumentsTableResult(TrashBinQuery)
Calls the HTTP Post method on the link for the relation “queryDocuments”.
Declaration
public TrashBinDocumentsTableResult PostToQueryDocumentsRelationForTrashBinDocumentsTableResult(TrashBinQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TrashBinQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
TrashBinDocumentsTableResult | The content of the response. |
PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(TrashBinQuery)
Calls the HTTP Post method on the link for the relation “queryDocuments” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(TrashBinQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TrashBinQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “queryDocuments”.
PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(System.Threading.CancellationToken, TrashBinQuery)
Calls the HTTP Post method on the link for the relation “queryDocuments” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(System.Threading.CancellationToken cancellationToken, TrashBinQuery dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
TrashBinQuery | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “queryDocuments”.
PostToSelectListsRelationForTypedSelectListResult(TrashBinSelectListExpression)
Calls the HTTP Post method on the link for the relation “selectLists”.
Declaration
public TypedSelectListResult PostToSelectListsRelationForTypedSelectListResult(TrashBinSelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TrashBinSelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
TypedSelectListResult | The content of the response. |
PostToSelectListsRelationForTypedSelectListResultAsync(TrashBinSelectListExpression)
Calls the HTTP Post method on the link for the relation “selectLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> PostToSelectListsRelationForTypedSelectListResultAsync(TrashBinSelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
TrashBinSelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectLists”.
PostToSelectListsRelationForTypedSelectListResultAsync(System.Threading.CancellationToken, TrashBinSelectListExpression)
Calls the HTTP Post method on the link for the relation “selectLists” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> PostToSelectListsRelationForTypedSelectListResultAsync(System.Threading.CancellationToken cancellationToken, TrashBinSelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
TrashBinSelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<TypedSelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “selectLists”.
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.