Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: GetResultsQueryParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/datareviewer/GetResultsQueryParameters"], function(GetResultsQueryParameters) { /* code goes here */ });
Description
(Added at v3.14)
Encapsulates data used for retrieving results from the reviewer workspace. Instances of this class define the size and content of featuresets returned by the getResults function in ReviewerResultsTask. Results returned from the getResults function are paged. You can control page size and which page to fetch using properties in this class.
See also
Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| pageNumber | Number | The page number, zero based index, of the results to return. |
| pageSize | Number | The number of items to list on a page. |
| returnFields | Array | Array of field names. |
| sortBy | String | Indicates a field name by which to sort. |
| sortDescending | Boolean | Controls sort order. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJSON() | Object | Returns a JSON representation of an instance of GetResultsQueryParameters. |
Property Details
<Number
NumberThe number of items to list on a page. Specify a value between 1-1000.
Default value:
5<Array
ArrayArray of field names. Use "*" to indicate ALL. Valid fields include:
recordIdobjectIdsubtypecategorysessionIdchecktitleresourceNamecheckNamenotesseverityreviewStatusreviewTechniciancorrectionTechnicianverificationTechnicianreviewDateUtccorrectionDateUtcverificationDateUtclifecycleStatus
<String
StringIndicates a field name by which to sort. The field must be included in returnFields. Optional.
<Boolean
BooleanControls sort order. Optional.
Known values:
true | falseDefault value:
falseMethod Details
Returns a JSON representation of an instance of GetResultsQueryParameters.
Return type:
Object