The parameters used to perform a query for Items, Groups, and Users within a Portal.
Constructors
new PortalQueryParams(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| String | The name of the class. more details | more details | |
| Extent | Only relevant when querying for PortalItems. more details | more details | |
| Number | The maximum number of results to be included in the result set response. more details | more details | |
| String | The query string used for the search. more details | more details | |
| String | A comma-delimited list of fields to sort. more details | more details | |
| String | The order in which to sort the results. more details | more details | |
| Number | The index of the first entry in the result set response. more details | more details | |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.Only relevant when querying for PortalItems. When specified, restricts the results of the query to the extent defined here.
The spatial reference of the given extent must be WGS84 (wkid 4326) or Web Mercator (wkid 3857).
numNumber
The maximum number of results to be included in the result set response. The maximum value allowed is
100. The start property combined with thenumproperty can be used to paginate the search results.Default Value: 10queryString
The query string used for the search. View the ArcGIS REST API Search Reference for details on constructing a valid query.
- See also:
sortFieldString
A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names are listed below. These names correspond to either item (search), group, and/or user queries.
Field name Query functionality title search, group uploaded search modified search username user created user, group type search owner search, group avg-rating search num-ratings search num-comments search num-views search sortOrderString
The order in which to sort the results.
Possible Value Description asc Sort the results in ascending order. desc Sort the results in descending order. Default Value: ascstartNumber
The index of the first entry in the result set response. The index is 1-based. The start property, along with the num property can be used to paginate the search results.
Default Value: 1
Method Overview
| Name | Return Type | Summary | |
|---|---|---|---|
| PortalQueryParams | Creates a deep clone of the instance of PortalQueryParams that calls this method. more details | more details | |
Method Details
clone(){PortalQueryParams}
Creates a deep clone of the instance of PortalQueryParams that calls this method.
Returns:Type Description PortalQueryParams A clone of the instance that called this method.