PortalQueryParametersForItems QML Type
The query parameters suitable for finding content contained in a portal. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- groupId : string
- itemId : string
- owner : string
- searchString : string
- types : list<Enums.PortalItemType>
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:
- 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:
Example: Obtain the next set of query parameters from a result set:
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.
Note: The corresponding handler is onGroupIdChanged.
itemIdChanged() |
Emitted when the itemId property changes.
Note: The corresponding handler is onItemIdChanged.
ownerChanged() |
Emitted when the owner property changes.
Note: The corresponding handler is onOwnerChanged.
searchStringChanged() |
Emitted when the searchString property changes.
Note: The corresponding handler is onSearchStringChanged.
typesChanged() |
Emitted when the types property changes.
Note: The corresponding handler is onTypesChanged.