Class PortalQueryParameters
Parameters to provide as input of a paginated query such as FindUsersAsync(PortalQueryParameters, CancellationToken)
Inheritance
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class PortalQueryParametersConstructors
| Name | Description |
|---|---|
| PortalQueryParameters(Envelope) | Initializes a new instance of the PortalQueryParameters class from a search bounding box. |
| PortalQueryParameters(String) | Initializes a new instance of the PortalQueryParameters class from a query string. |
| PortalQueryParameters(String, Envelope) | Initializes a new instance of the PortalQueryParameters class from a query string and search extent. |
| PortalQueryParameters(String, Int32) | Initializes a new instance of the PortalQueryParameters class from a query string and a limit. |
Properties
| Name | Description |
|---|---|
| BoundingBox | Gets or sets the search extent for a spatial search. Search requires a bounding box, a Query, or both. Spatial search is an overlaps/intersects function of the search extent and the extent of the document. Sorting in a spatial search is not supported. Documents that have no extent (e.g., mxds, 3dds, lyr) will not be found when doing a spatial search. Document extent is assumed to be in geographic coordinates. |
| CanSearchPublic | Gets or sets a value indicating whether public items outside the organization may be included in the search results. Default behavior is they are included. |
| Categories | Gets a list of content category specifications to use when searching for items. |
| Limit | Gets or sets the maximum number of results to be included in the result set response. The default value is 10 and the maximum allowed value is 100. The start index, along with the limit parameter can be used to paginate the search results. The actual number of returned results may be less than Limit. This happens when the number of results remaining after StartIndex is less than Limit. |
| Query | Gets or sets the query string to search against. |
| SortField | Gets or sets the field to sort by. (e.g for groups the allowed field names are title, owner, and created). |
| SortOrder | Gets or sets a value indicating whether order returns in ascending or descending order. Default is ascending. |
| StartIndex | Gets or sets the index of the first entry in the result set response. The index number is 1-based. The default value of StartIndex is 1 (e.g.,. the first search result). The start index, along with the Limit parameter can be used to paginate the search results. |
Methods
| Name | Description |
|---|---|
| CreateForGroups(String, String) | Returns query parameters that will find groups with a specified owner and/or title. |
| CreateForItemsInGroup(String) | Returns query parameters that will find items with a specified type. |
| CreateForItemsOfType(PortalItemType, String) | Returns query parameters that will find items with a specified type. |
| CreateForItemsOfTypeInGroup(PortalItemType, String, String) | Returns query parameters that will find items with a specified type in the specified group. |
| CreateForItemsOfTypes(IEnumerable<PortalItemType>, String, String, String) | Returns query parameters that will find items with the specified types, group and owner. |
| CreateForItemsOfTypeWithOwner(PortalItemType, String, String) | Returns query parameters that will find items with a specified type and owner. |
| CreateForItemsWithId(String) | Returns query parameters that will find items with a specified item Id. |
| CreateForItemsWithOwner(String) | Returns query parameters that will find items with a specified item owner. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.6 |
| .NET | 100.13 - 200.6 |
| .NET Windows | 100.13 - 200.6 |
| .NET Android | 200.0 - 200.6 |
| .NET iOS | 200.0 - 200.6 |
| .NET Framework | 100.0 - 200.6 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.6 |