DocumentsQueryResult Class

Define a result from document query

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientDocumentsQueryResult

Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient (in DocuWare.Platform.ServerClient.dll) Version: Version 6.9

Syntax

Copy

[XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", 
	IsNullable = false)]
[XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")]
public class DocumentsQueryResult : IRelationsWithProxy, 
	IRelations, IHttpClientProxy

The DocumentsQueryResult type exposes the following members.

Constructors

	Name	Description
	DocumentsQueryResult	Initializes a new instance of the DocumentsQueryResult class

Top

Properties

	Name	Description
	BatchUpdateRelationLink	Gets the Uri of the link for the relation “batchUpdate”.
	Count	Gets the number of items of the query leading to this result.
	CreateUserDefinedSearchRelationLink	Gets the Uri of the link for the relation “createUserDefinedSearch”.
	DownloadRelationLink	Gets the Uri of the link for the relation “download”.
	ExportDocumentsRelationLink	Gets the Uri of the link for the relation “exportDocuments”.
	FeedRelationLink	Gets the Uri of the link for the relation “feed”.
	FirstRelationLink	Gets the Uri of the link for the relation “first”.
	Items
	Links
	NextRelationLink	Gets the Uri of the link for the relation “next”.
	PrevRelationLink	Gets the Uri of the link for the relation “prev”.
	SelfRelationLink	Gets the Uri of the link for the relation “self”.
	TimeStamp	TimeStamp of the result.
	Title	The title of the document collection, if it exists.

Top

Methods

	Name	Description
	GetDocumentsQueryResultFromDownloadRelation	Calls the HTTP Get method on the link for the relation “download”.
	GetDocumentsQueryResultFromDownloadRelationAsync	Calls the HTTP Get method on the link for the relation “download” asynchronously.
	GetDocumentsQueryResultFromDownloadRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “download” asynchronously.
	GetDocumentsQueryResultFromFirstRelation	Calls the HTTP Get method on the link for the relation “first”.
	GetDocumentsQueryResultFromFirstRelationAsync	Calls the HTTP Get method on the link for the relation “first” asynchronously.
	GetDocumentsQueryResultFromFirstRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “first” asynchronously.
	GetDocumentsQueryResultFromNextRelation	Calls the HTTP Get method on the link for the relation “next”.
	GetDocumentsQueryResultFromNextRelationAsync	Calls the HTTP Get method on the link for the relation “next” asynchronously.
	GetDocumentsQueryResultFromNextRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “next” asynchronously.
	GetDocumentsQueryResultFromPrevRelation	Calls the HTTP Get method on the link for the relation “prev”.
	GetDocumentsQueryResultFromPrevRelationAsync	Calls the HTTP Get method on the link for the relation “prev” asynchronously.
	GetDocumentsQueryResultFromPrevRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “prev” asynchronously.
	GetDocumentsQueryResultFromSelfRelation	Calls the HTTP Get method on the link for the relation “self”.
	GetDocumentsQueryResultFromSelfRelationAsync	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetDocumentsQueryResultFromSelfRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetXElementWrapperFromFeedRelation	Calls the HTTP Get method on the link for the relation “feed”.
	GetXElementWrapperFromFeedRelationAsync	Calls the HTTP Get method on the link for the relation “feed” asynchronously.
	GetXElementWrapperFromFeedRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “feed” asynchronously.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult	Calls the HTTP Post method on the link for the relation “batchUpdate”.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcessData)	Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(CancellationToken, BatchUpdateProcessData)	Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
	PostToCreateUserDefinedSearchRelationForDialog	Calls the HTTP Post method on the link for the relation “createUserDefinedSearch”.
	PostToCreateUserDefinedSearchRelationForDialogAsync(UserDefinedSearchInfo)	Calls the HTTP Post method on the link for the relation “createUserDefinedSearch” asynchronously.
	PostToCreateUserDefinedSearchRelationForDialogAsync(CancellationToken, UserDefinedSearchInfo)	Calls the HTTP Post method on the link for the relation “createUserDefinedSearch” asynchronously.
	PostToExportDocumentsRelationForStream	Calls the HTTP Post method on the link for the relation “exportDocuments”.
	PostToExportDocumentsRelationForStreamAsync(ExportSettings)	Calls the HTTP Post method on the link for the relation “exportDocuments” asynchronously.
	PostToExportDocumentsRelationForStreamAsync(CancellationToken, ExportSettings)	Calls the HTTP Post method on the link for the relation “exportDocuments” asynchronously.
	SetProxy	Sets the HTTP communication proxy which is used in further HTTP communication.

Top

Extension Methods

	Name	Description
	DeleteTResponse(String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetBaseUri	Gets the base URI of the specified relations instance. (Defined by RelationsWithProxyExtensions.)
	GetLink	Gets the link by its name. (Defined by RelationExtension.)
	GetRelationUri	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	GetRelationUriOrThrow	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	HasRelationUri	Determines whether the specified link exists. (Defined by RelationExtension.)
	SendTResponse(HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)

Top

Explicit Interface Implementations

	Name	Description
	IHttpClientProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace

Send comments on this topic to DocuWare