Class PortalGroupContentSearchParameters
Contains search parameters suitable for finding portal items that belong to a PortalGroup.
Inheritance
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class PortalGroupContentSearchParameters
Remarks
You can create an instance using one of the factory methods that are designed for particular types of searches, or you can use one of the constructors and specify a custom query string. A number of properties are also available to customize various aspects of the search. A typical usage pattern is:
- (1) Create a new PortalGroupContentSearchParameters object using a factory method or a constructor.
- (2) Optionally set one or more of the properties.
- (3) Pass the parameters to FindItemsAsync(PortalGroupContentSearchParameters) and await the results.
- (4) Optionally use NextSearchParameters to retrieve the next page of search results.
Constructors
Name | Description |
---|---|
PortalGroupContentSearchParameters(Envelope) | Initializes a new instance of the PortalGroupContentSearchParameters class with a bounding box for a spatial search. |
PortalGroupContentSearchParameters(String) | Initializes a new instance of the PortalGroupContentSearchParameters class with a custom query string. |
PortalGroupContentSearchParameters(String, Envelope) | Initializes a new instance of the PortalGroupContentSearchParameters class with a custom query string and a bounding box for a spatial search. |
PortalGroupContentSearchParameters(String, Int32) | Initializes a new instance of the PortalGroupContentSearchParameters class with a custom query string and a custom limit on the number of results. |
Properties
Name | Description |
---|---|
BoundingBox | Gets or sets an Envelope specifying the bounding box for a spatial search. |
CanSearchPublic | Gets or sets a value indicating whether public items outside the organization may be included in the search results. |
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. |
Query | Gets the query string used to search for items. |
SortField | Gets or sets a comma-separated string containing one or more field names to sort the results by. |
SortOrder | Gets or sets the sort order, indicating whether the results are returned in ascending or descending order. |
StartIndex | Gets or sets the index (within the entire set of results) of the first PortalItem in the current result set. |
Methods
Name | Description |
---|---|
CreateForItemsOfType(PortalItemType, String, String) | Creates a PortalGroupContentSearchParameters that will find items with a particular type. |
CreateForItemsOfTypes(IEnumerable<PortalItemType>, String, String) | Creates a PortalGroupContentSearchParameters that will find items with a particular type. |
CreateForItemsWithOwner(String) | Creates a PortalGroupContentSearchParameters that will find items belonging to a specified owner. |
CreateForItemWithId(String) | Creates a PortalGroupContentSearchParameters that will find an item with a specified item ID. |
See Also
Applies to
Target | Versions |
---|---|
.NET Standard 2.0 | 100.8 - 200.5 |
.NET | 100.13 - 200.5 |
.NET Windows | 100.13 - 200.5 |
.NET Android | 200.0 - 200.5 |
.NET iOS | 200.0 - 200.5 |
.NET Framework | 100.8 - 200.5 |
Xamarin.Android | 100.8 - 100.15 |
Xamarin.iOS | 100.8 - 100.15 |
UWP | 100.8 - 200.5 |