Class TrashBin

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Definition for trash bin.

public class TrashBin : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

TrashBin

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BatchDeleteRelationLink

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

public string BatchDeleteRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

BatchRestoreRelationLink

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

public string BatchRestoreRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

CountDocumentsRelationLink

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

public string CountDocumentsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

DocumentsRelationLink

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

public string DocumentsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

QueryDocumentsRelationLink

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

public string QueryDocumentsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

SelectListsRelationLink

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

public string SelectListsRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

GetCountResultFromCountDocumentsRelation()

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

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.

public Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountDocumentsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<CountResult>>	A task which runs the request.

Remarks

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

GetCountResultFromCountDocumentsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<CountResult>> GetCountResultFromCountDocumentsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

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

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.

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromDocumentsRelationAsync()

Returns

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

Remarks

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

GetTrashBinDocumentsTableResultFromDocumentsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> GetTrashBinDocumentsTableResultFromDocumentsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

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

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.

public Task<DeserializedHttpResponse<TypedSelectListResult>> GetTypedSelectListResultFromSelectListsRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<TypedSelectListResult>>	A task which runs the request.

Remarks

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

GetTypedSelectListResultFromSelectListsRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<TypedSelectListResult>> GetTypedSelectListResultFromSelectListsRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

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

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.

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

Remarks

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

PostToBatchDeleteRelationForBatchDeleteResultAsync(CancellationToken, BatchDeleteDocumentsSource)

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

public Task<DeserializedHttpResponse<BatchDeleteResult>> PostToBatchDeleteRelationForBatchDeleteResultAsync(CancellationToken cancellationToken, BatchDeleteDocumentsSource dataToSend)

Parameters

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

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.

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

Remarks

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

PostToBatchRestoreRelationForBatchRestoreResultAsync(CancellationToken, BatchRestoreDocumentsSource)

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

public Task<DeserializedHttpResponse<BatchRestoreResult>> PostToBatchRestoreRelationForBatchRestoreResultAsync(CancellationToken cancellationToken, BatchRestoreDocumentsSource dataToSend)

Parameters

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

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.

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

Remarks

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

PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(CancellationToken, TrashBinQuery)

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

public Task<DeserializedHttpResponse<TrashBinDocumentsTableResult>> PostToQueryDocumentsRelationForTrashBinDocumentsTableResultAsync(CancellationToken cancellationToken, TrashBinQuery dataToSend)

Parameters

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

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.

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

Remarks

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

PostToSelectListsRelationForTypedSelectListResultAsync(CancellationToken, TrashBinSelectListExpression)

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

public Task<DeserializedHttpResponse<TypedSelectListResult>> PostToSelectListsRelationForTypedSelectListResultAsync(CancellationToken cancellationToken, TrashBinSelectListExpression dataToSend)

Parameters

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

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The 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.