Class DocumentsQuery
Defines a query for documents.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class DocumentsQuery : IRelationsWithProxy
Constructors
DocumentsQuery()
Creates a new instance of this class
Declaration
public DocumentsQuery()
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
CalculateTotalCount
Indicates if total count of the documents should be calculated. If it is false the return value will be the number of requested items and indication if there are more items available.
Declaration
public bool CalculateTotalCount { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
DialogExpressionRelationLink
Gets the Uri of the link for the relation “dialogExpression”.
Declaration
public string DialogExpressionRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “dialogExpression” if it exists, or
ExcludeSystemFields
Specifies whether the default system/additional fields should be returned.
Declaration
public bool ExcludeSystemFields { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Expression
Gets or sets the query expression.
Declaration
public string Expression { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
The query string contains the query in a proper expression. If the expression is missing then all documents match the query.
Fields
Gets or sets the fields which are returned by this query.
Declaration
public List<string> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
Remarks
Depending on the server's choice, there might be more fields included, like some system fields. If this field is null then all fields are returned.
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.
Declaration
public bool ForceRefresh { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IdsResultRelationLink
Gets the Uri of the link for the relation “IdsResult”.
Declaration
public string IdsResultRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “IdsResult” if it exists, or
IncludeSuggestions
Gets or sets a value indicating whether Intellix suggetstions to be included.
Declaration
public bool IncludeSuggestions { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
ResultRelationLink
Gets the Uri of the link for the relation “result”.
Declaration
public string ResultRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “result” if it exists, or
SortOrder
Gets or sets the fields which are returned by this query.
Declaration
public List<SortedField> SortOrder { get; set; }
Property Value
Type | Description |
---|---|
List<SortedField> |
Remarks
Depending on the server's choice, there might be more fields included, like some system fields. If this field is null then all fields are returned.
TableDialogExpressionRelationLink
Gets the Uri of the link for the relation “tableDialogExpression”.
Declaration
public string TableDialogExpressionRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “tableDialogExpression” if it exists, or
TableResultRelationLink
Gets the Uri of the link for the relation “tableResult”.
Declaration
public string TableResultRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “tableResult” if it exists, or
Methods
GetDocumentsQueryResultFromResultRelation()
Calls the HTTP Get method on the link for the relation “result”.
Declaration
public DocumentsQueryResult GetDocumentsQueryResultFromResultRelation()
Returns
Type | Description |
---|---|
DocumentsQueryResult | The content of the response. |
GetDocumentsQueryResultFromResultRelationAsync()
Calls the HTTP Get method on the link for the relation “result” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromResultRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “result”.
GetDocumentsQueryResultFromResultRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “result” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromResultRelationAsync(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 “result”.
GetDocumentsQueryTableResultFromTableResultRelation()
Calls the HTTP Get method on the link for the relation “tableResult”.
Declaration
public DocumentsQueryTableResult GetDocumentsQueryTableResultFromTableResultRelation()
Returns
Type | Description |
---|---|
DocumentsQueryTableResult | The content of the response. |
GetDocumentsQueryTableResultFromTableResultRelationAsync()
Calls the HTTP Get method on the link for the relation “tableResult” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetDocumentsQueryTableResultFromTableResultRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “tableResult”.
GetDocumentsQueryTableResultFromTableResultRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “tableResult” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> GetDocumentsQueryTableResultFromTableResultRelationAsync(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<DocumentsQueryTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “tableResult”.
PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcess)
Calls the HTTP Post method on the link for the relation “batchUpdate”.
Declaration
public BatchUpdateIndexFieldsResult PostToBatchUpdateRelationForBatchUpdateIndexFieldsResult(BatchUpdateProcess dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchUpdateProcess | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
BatchUpdateIndexFieldsResult | The content of the response. |
PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcess)
Calls the HTTP Post method on the link for the relation “batchUpdate” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<BatchUpdateIndexFieldsResult>> PostToBatchUpdateRelationForBatchUpdateIndexFieldsResultAsync(BatchUpdateProcess dataToSend)
Parameters
Type | Name | Description |
---|---|---|
BatchUpdateProcess | 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, BatchUpdateProcess)
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, BatchUpdateProcess dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
BatchUpdateProcess | 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”.
PostToDialogExpressionRelationForDocumentsQueryResult(DialogExpression)
Calls the HTTP Post method on the link for the relation “dialogExpression”.
Declaration
public DocumentsQueryResult PostToDialogExpressionRelationForDocumentsQueryResult(DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
DocumentsQueryResult | The content of the response. |
PostToDialogExpressionRelationForDocumentsQueryResultAsync(DialogExpression)
Calls the HTTP Post method on the link for the relation “dialogExpression” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToDialogExpressionRelationForDocumentsQueryResultAsync(DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogExpression”.
PostToDialogExpressionRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, DialogExpression)
Calls the HTTP Post method on the link for the relation “dialogExpression” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToDialogExpressionRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken cancellationToken, DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “dialogExpression”.
PostToIdsResultRelationForSelectListResult(SelectListExpression)
Calls the HTTP Post method on the link for the relation “IdsResult”.
Declaration
public SelectListResult PostToIdsResultRelationForSelectListResult(SelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
SelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
SelectListResult | The content of the response. |
PostToIdsResultRelationForSelectListResultAsync(SelectListExpression)
Calls the HTTP Post method on the link for the relation “IdsResult” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> PostToIdsResultRelationForSelectListResultAsync(SelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
SelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “IdsResult”.
PostToIdsResultRelationForSelectListResultAsync(System.Threading.CancellationToken, SelectListExpression)
Calls the HTTP Post method on the link for the relation “IdsResult” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> PostToIdsResultRelationForSelectListResultAsync(System.Threading.CancellationToken cancellationToken, SelectListExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
SelectListExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “IdsResult”.
PostToTableDialogExpressionRelationForDocumentsQueryTableResult(DialogExpression)
Calls the HTTP Post method on the link for the relation “tableDialogExpression”.
Declaration
public DocumentsQueryTableResult PostToTableDialogExpressionRelationForDocumentsQueryTableResult(DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
DocumentsQueryTableResult | The content of the response. |
PostToTableDialogExpressionRelationForDocumentsQueryTableResultAsync(DialogExpression)
Calls the HTTP Post method on the link for the relation “tableDialogExpression” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> PostToTableDialogExpressionRelationForDocumentsQueryTableResultAsync(DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “tableDialogExpression”.
PostToTableDialogExpressionRelationForDocumentsQueryTableResultAsync(System.Threading.CancellationToken, DialogExpression)
Calls the HTTP Post method on the link for the relation “tableDialogExpression” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> PostToTableDialogExpressionRelationForDocumentsQueryTableResultAsync(System.Threading.CancellationToken cancellationToken, DialogExpression dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
DialogExpression | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryTableResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “tableDialogExpression”.
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 |
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.