DocumentsQuery Class

DocuWare Platform .NET API

Defines a query for documents.

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientDocumentsQuery

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

Syntax

Copy

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

The DocumentsQuery type exposes the following members.

Constructors

	Name	Description
	DocumentsQuery	Creates a new instance of this class

Top

Methods

	Name	Description
	GetDocumentsQueryResultFromResultRelation	Calls the HTTP Get method on the link for the relation “result”.
	GetDocumentsQueryResultFromResultRelationAsync	Calls the HTTP Get method on the link for the relation “result” asynchronously.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult	Calls the HTTP Post method on the link for the relation “batchUpdate”.
	PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync	Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
	PostToDialogExpressionRelationForDocumentsQueryResult	Calls the HTTP Post method on the link for the relation “dialogExpression”.
	PostToDialogExpressionRelationForDocumentsQueryResultAsync	Calls the HTTP Post method on the link for the relation “dialogExpression” asynchronously.

Top

Extension Methods

	Name	Description
	DeleteTResponse(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.)
	GetTResponse(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.)
	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(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, TRequest(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.)

Top

Properties

	Name	Description
	BatchUpdateRelationLink	Gets the Uri of the link for the relation “batchUpdate”.
	DialogExpressionRelationLink	Gets the Uri of the link for the relation “dialogExpression”.
	Expression	Gets or sets the query expression.
	Fields	Gets or sets the fields which are returned by this query.
	ForceRefresh	Determine if result list is retrieved from the cache when ForceRefresh is set to false (default) or always a new one is executed when ForceRefresh is set to true.
	Links
	ResultRelationLink	Gets the Uri of the link for the relation “result”.
	SortOrder	Gets or sets the fields which are returned by this query.

Top

Explicit Interface Implementations

	Name	Description
	IRelationsWithProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace