Skip To Content ArcGIS for Developers Sign In Dashboard

PortalQueryParametersForItems QML Type

The query parameters suitable for finding content contained in a portal. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

PortalQueryParameters

Properties

Signals

Detailed Description

Properties are provided for a number of particular parameters: groupId, itemId, owner and types. There are also a number of properties for a searchString that can be a complex expression, containing names and values of one or more fields, for example "owner:username AND title:mygroupname".

A typical usage pattern is:

Example: Use query parameters to retrieve web maps with specific tags from a portal:

// webmaps authored prior to July 2nd, 2014 are not supported - so search only from that date to the current time
property string fromDate: "000000" + new Date('Wed, 02 Jul 2014 00:00:00 GMT').getTime()
property string toDate: "000000" + new Date().getTime()

PortalQueryParametersForItems {
    id: webmapQuery
    types: [ Enums.PortalItemTypeWebMap ]

    searchString: 'tags:\"' + keyWordField.text + '\" AND + uploaded:[' + fromDate + ' TO ' + toDate +']';
}
portal.findItems(webmapQuery);

Example: Obtain the next set of query parameters from a result set:

var nextQuery = portal.findItemsResult.nextQueryParameters;
// check whether the startIndex of the new query is valid
if (nextQuery.startIndex !== -1)
    portal.findItems(nextQuery);

Detailed information on search capabilities and syntax can be found in the ArcGIS REST API.

See also Portal, PortalItem, and PortalQueryResultSetForItems.

Property Documentation

groupId : string

The ID of the PortalGroup for which all items must belong.

See also PortalGroup.


itemId : string

The ID of the specific PortalItem to be retrieved.

See also PortalItem.


owner : string

The username of the PortalUser to whom all the items must belong.

See also PortalUser.


searchString : string

The custom search string to be used for querying.

See the ArcGIS REST API for more details.


types : list<Enums.PortalItemType>

The list of types of PortalItem to retrieve.

See also Enums.PortalItemType.


Signal Documentation

groupIdChanged()

Emitted when the groupId property changes.


itemIdChanged()

Emitted when the itemId property changes.


ownerChanged()

Emitted when the owner property changes.


searchStringChanged()

Emitted when the searchString property changes.


typesChanged()

Emitted when the types property changes.



Feedback on this topic?