Class DocumentsQueryResult

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Define a result from document query

public class DocumentsQueryResult : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DocumentsQueryResult

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

BatchUpdateRelationLink

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

public string BatchUpdateRelationLink { get; }

Property Value

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

public CountPlusValue Count { get; set; }

Property Value

Type	Description
CountPlusValue

CreateUserDefinedSearchRelationLink

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

public string CreateUserDefinedSearchRelationLink { get; }

Property Value

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

public string DownloadRelationLink { get; }

Property Value

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

public string ExportDocumentsRelationLink { get; }

Property Value

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

public string FeedRelationLink { get; }

Property Value

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

public string FileCabinetId { get; set; }

Property Value

Type	Description
string

FirstRelationLink

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

public string FirstRelationLink { get; }

Property Value

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

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

Property Value

Type	Description
List<Document>

LastAccessUser

The last user to execute the operation.

public string LastAccessUser { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

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

public string NextRelationLink { get; }

Property Value

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

public string OrganizationGuid { get; set; }

Property Value

Type	Description
string

PrevRelationLink

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

public string PrevRelationLink { get; }

Property Value

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

public string SelfRelationLink { get; }

Property Value

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

public DateTime TimeStamp { get; set; }

Property Value

Type	Description
DateTime

Title

The title of the document collection, if it exists.

public string Title { get; set; }

Property Value

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

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.

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromDownloadRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromDownloadRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromDownloadRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromFirstRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromFirstRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromFirstRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromNextRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromNextRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromNextRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromPrevRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromPrevRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromPrevRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromSelfRelationAsync()

Returns

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

Remarks

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

GetDocumentsQueryResultFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

public Task<DeserializedHttpResponse<XElementWrapper>> GetXElementWrapperFromFeedRelationAsync()

Returns

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

Remarks

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

GetXElementWrapperFromFeedRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<XElementWrapper>> GetXElementWrapperFromFeedRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

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.

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

Remarks

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

PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(CancellationToken, BatchUpdateProcessData)

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

public Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(CancellationToken cancellationToken, BatchUpdateProcessData dataToSend)

Parameters

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

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.

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

Remarks

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

PostToCreateUserDefinedSearchRelationForDialogAsync(CancellationToken, UserDefinedSearchInfo)

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

public Task<DeserializedHttpResponse<Dialog>> PostToCreateUserDefinedSearchRelationForDialogAsync(CancellationToken cancellationToken, UserDefinedSearchInfo dataToSend)

Parameters

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

public 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
Stream	The content of the response.

PostToExportDocumentsRelationForStreamAsync(ExportSettings)

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

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

Remarks

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

PostToExportDocumentsRelationForStreamAsync(CancellationToken, ExportSettings)

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

public Task<DeserializedHttpResponse<Stream>> PostToExportDocumentsRelationForStreamAsync(CancellationToken cancellationToken, ExportSettings dataToSend)

Parameters

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

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.