| Name | Description | |
|---|---|---|
 | PortalQueryParameters Constructor | Overloaded. |
PortalQueryParameters Class Members
In This Topic
The following tables list the members exposed by PortalQueryParameters.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | BoundingBox | Gets or sets the search extent for a spatial search. A valid search requires either a bounding box, or a Query, or both. |
| 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. |
| OrganizationId | Gets or sets the organization id to use in the query. |
| Query | Gets or sets the query string to search against. |
| SearchQuery | Gets a formatted query string based on the PortalQueryParameter properties |
| 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. |
Public Methods
| Name | Description | |
|---|---|---|
  | CreateForItemsInGroup | Returns query parameters that will find items with a specified group. |
| CreateForItemsOfType | Returns query parameters that will find items with a specified type. |
| CreateForItemsOfTypeInGroup | Returns query parameters that will find items with a specified type in the specified group. |
| CreateForItemsOfTypes | Returns query parameters that will find items with the specified types, group and owner. |
| CreateForItemsOfTypeWithOwner | Returns query parameters that will find items with a specified type and owner. |
| CreateForItemsWithId | Returns query parameters that will find items with a specified item Id. |
| CreateForItemsWithOwner | Returns query parameters that will find items with a specified item owner. |
See Also