PortalQueryParametersForItems QML Type

Esri.ArcGISRuntime

PortalQueryParametersForItems

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

• List of all members, including inherited members
• PortalQueryParametersForItems is part of QML Type List.

Properties

• groupId : string
• itemId : string
• owner : string
• searchString : string
• types : list<Enums.PortalItemType>

Signals

• groupIdChanged()
• itemIdChanged()
• ownerChanged()
• searchStringChanged()
• typesChanged()

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:

• Create a new PortalQueryParametersForItems object.
• Optionally set one or more of the properties.
• Use the object by passing it to findItems.
• Obtain the PortalQueryResultSetForItems from findItemsResult.
• Optionally call nextQueryParameters to get a new PortalQueryParametersForItems object that can be used to 'find' the next batch of results.

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('2014-07-02T00:00:00Z').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:

const 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

Signal Documentation