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: PortalQueryResult
[ AMD Module Require | Legacy Module Require ]
require(["esri/arcgis/Portal"], function(arcgisPortal) { /* code goes here */ });
Description
(Added at v2.8)
Details about the result of a query.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| nextQueryParams | Object | The query parameters for the next set of results. |
| queryParams | Object | The query parameters for the first set of results. |
| results | Object[] | An array of result item objects. |
| total | Number | The total number of results. |
Property Details
<Object
ObjectThe query parameters for the next set of results.
Object Specifications:
<
queryParams>< |
Required | The maximum number of results to be included in the result set response. The Default value is 10 and the maximum allowed value is 100. The start parameter combined with the num parameter can be used to paginate the search results. Note that the actual number of returned results may be less than num if the number of results remaining after start is less than num. |
< |
Required | The query string used for a search. View the ArcGIS REST API Search Reference for details on constructing a valid query. |
< |
Required | A comma separated list of field(s) to sort by. Valid fields are: title, created, type, owner, avgRating, numRatings, numComments and numViews. |
< |
Required | The number of the first entry in the result set response. The index number is 1-based. The start parameter, along with the num parameter can be used to paginate the search results. |
<Object
ObjectThe query parameters for the first set of results.
Object Specifications:
<
queryParams>< |
Required | The maximum number of results to be included in the result set response. The Default value is 10 and the maximum allowed value is 100. The start parameter combined with the num parameter can be used to paginate the search results. Note that the actual number of returned results may be less than num if the number of results remaining after start is less than num. |
< |
Required | The query string used for a search. View the ArcGIS REST API Search Reference for details on constructing a valid query. |
< |
Required | A comma separated list of field(s) to sort by. Valid fields are: title, created, type, owner, avgRating, numRatings, numComments and numViews. |
< |
Required | The number of the first entry in the result set response. The index number is 1-based. The start parameter, along with the num parameter can be used to paginate the search results. |
<Object[]
Object[]An array of result item objects.
<Number
NumberThe total number of results. The maximum number of results is limited to 1000.