Class DocumentsQueryResult

Define a result from document query

Inheritance

System.Object

DocumentsQueryResult

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DocumentsQueryResult : IRelationsWithProxy

Properties

BatchUpdateRelationLink

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

Declaration

public string BatchUpdateRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Count

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

Declaration

public CountPlusValue Count { get; set; }

Property Value

Type	Description
CountPlusValue

CreateUserDefinedSearchRelationLink

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

Declaration

public string CreateUserDefinedSearchRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

DownloadRelationLink

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

Declaration

public string DownloadRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ExportDocumentsRelationLink

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

Declaration

public string ExportDocumentsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

FeedRelationLink

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

Declaration

public string FeedRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

FileCabinetId

The guid of the cabinet

Declaration

public string FileCabinetId { get; set; }

Property Value

Type	Description
System.String

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.

Items

Declaration

public List<Document> Items { get; set; }

Property Value

Type	Description
List<Document>

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.

OrganizationGuid

The guid of the organization

Declaration

public string OrganizationGuid { get; set; }

Property Value

Type	Description
System.String

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.

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 System.DateTime TimeStamp { get; set; }

Property Value

Type	Description
System.DateTime

Title

The title of the document collection, if it exists.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Remarks

Could be the name of the dialog creating this collection.

Methods

GetDocumentsQueryResultFromDownloadRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromDownloadRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromDownloadRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromDownloadRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromDownloadRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDocumentsQueryResultFromFirstRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromFirstRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromFirstRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromFirstRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromFirstRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDocumentsQueryResultFromNextRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromNextRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromNextRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromNextRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromNextRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDocumentsQueryResultFromPrevRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromPrevRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromPrevRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromPrevRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromPrevRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetDocumentsQueryResultFromSelfRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromSelfRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromSelfRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromSelfRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromSelfRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetXElementWrapperFromFeedRelation()

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

Declaration

public XElementWrapper GetXElementWrapperFromFeedRelation()

Returns

Type	Description
XElementWrapper	The content of the response.

GetXElementWrapperFromFeedRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<XElementWrapper>> GetXElementWrapperFromFeedRelationAsync()

Returns

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

Remarks

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

GetXElementWrapperFromFeedRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcessData)

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

Declaration

public BatchUpdateIndexFieldsResult PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcessData dataToSend)

Parameters

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

Returns

Type	Description
BatchUpdateIndexFieldsResult	The content of the response.

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcessData)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcessData dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(System.Threading.CancellationToken, BatchUpdateProcessData)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(System.Threading.CancellationToken cancellationToken, BatchUpdateProcessData dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCreateUserDefinedSearchRelationForDialog(UserDefinedSearchInfo)

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

Declaration

public Dialog PostToCreateUserDefinedSearchRelationForDialog(UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

Type	Description
Dialog	The content of the response.

PostToCreateUserDefinedSearchRelationForDialogAsync(UserDefinedSearchInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCreateUserDefinedSearchRelationForDialogAsync(System.Threading.CancellationToken, UserDefinedSearchInfo)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(System.Threading.CancellationToken cancellationToken, UserDefinedSearchInfo dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToExportDocumentsRelationForStream(ExportSettings)

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

Declaration

public System.IO.Stream PostToExportDocumentsRelationForStream(ExportSettings dataToSend)

Parameters

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

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToExportDocumentsRelationForStreamAsync(ExportSettings)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToExportDocumentsRelationForStreamAsync(ExportSettings dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToExportDocumentsRelationForStreamAsync(System.Threading.CancellationToken, ExportSettings)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToExportDocumentsRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, ExportSettings dataToSend)

Parameters

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

Returns

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

Remarks

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

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.