PortalQueryParameters

class PortalQueryParameters(query: String = "", var boundingBox: Envelope? = null, var limit: Int = 10)

Defines a query to find contents or groups contained in a portal.

To query a portal for items or groups, the methods Portal.findItems and Portal.findGroups must use the query parameters specified by the portal query parameters. You can choose any of pre-defined query strings, supplied by the static methods under this class, or you can create a custom query string as per the specification in the Portal API.

The default number of results returned is 10. Adjust this limit to return more results and use with the startIndex property, if you wish to paginate the results.

Since

200.0.0

Parameters

query

the query string to use. The format is such as "owner:username AND title:mygroupname".

Constructors

Link copied to clipboard
constructor(query: String = "", boundingBox: Envelope? = null, limit: Int = 10)

Creates a PortalQueryParameters with the given query string, the bounding box and the result limit.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The bounding box for a spatial search, which is an overlaps/intersects function of the query bounding box and the extent of the document. Documents that have no extent (e.g., mxds, 3dds, lyr) will not be found when doing a bounding box search. The bounding box must have a SpatialReference. If the spatial reference is not WGS84, it will be projected to WGS84 when it is applied.

Link copied to clipboard

An array of content category specifications to use when searching for items using Portal.findItems(queryParameters).

Link copied to clipboard
var limit: Int

the results limit, which is used when paging through large result sets. It is the maximum number of results to be included in the result set response.

Link copied to clipboard

The query string to search with.

Link copied to clipboard

True if public items outside the organization may be included in the query.

Link copied to clipboard

The field or fields to sort the results by. It is a String containing a list of one or more fields names, comma separated, or null if none.

Link copied to clipboard

The sort order, indicating whether the results are returned in ascending or descending order.

Link copied to clipboard

The start index, which is used when paging through large result sets. It is the index within the entire set of results of the first entry in the current page. The index number is 1-based.