ArcGIS Runtime SDK for iOS: AGSPortalGroupContentSearchParameters Class Reference
ArcGIS Runtime SDK for iOS  100.15
AGSPortalGroupContentSearchParameters Class Reference

Description

Contains search parameters suitable for finding portal items that belong to a portal group.

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:

Inheritance diagram for AGSPortalGroupContentSearchParameters:
AGSObject

Instance Methods

(instancetype) - initWithBoundingBox:
 
(instancetype) - initWithQuery:
 
(instancetype) - initWithQuery:boundingBox:
 
(instancetype) - initWithQuery:limit:
 

Class Methods

(AGSPortalGroupContentSearchParameters *) + portalGroupContentSearchParametersForItemsOfType:owner:searchString:
 
(AGSPortalGroupContentSearchParameters *) + portalGroupContentSearchParametersForItemsOfType:searchString:
 
(AGSPortalGroupContentSearchParameters *) + portalGroupContentSearchParametersForItemsOfTypes:owner:searchString:
 
(AGSPortalGroupContentSearchParameters *) + portalGroupContentSearchParametersForItemsWithOwner:
 
(AGSPortalGroupContentSearchParameters *) + portalGroupContentSearchParametersForItemWithID:
 
(instancetype) + portalGroupContentSearchParametersWithBoundingBox:
 
(instancetype) + portalGroupContentSearchParametersWithQuery:
 
(instancetype) + portalGroupContentSearchParametersWithQuery:boundingBox:
 
(instancetype) + portalGroupContentSearchParametersWithQuery:limit:
 

Properties

AGSEnvelopeboundingBox
 
NSArray< NSString * > * categories
 
NSInteger limit
 
NSString * query
 
BOOL searchPublic
 
NSString * sortField
 
AGSPortalQuerySortOrder sortOrder
 
NSInteger startIndex
 

Method Documentation

◆ initWithBoundingBox:

- (instancetype) initWithBoundingBox: (AGSEnvelope *)  boundingBox

Constructor that sets a bounding box for a spatial search

Parameters
boundingBoxan Envelope specifying the bounding box
Since
100.7

◆ initWithQuery:

- (instancetype) initWithQuery: (NSString *)  query

Constructor that sets a custom query string to use

Parameters
querythe query string to use, for example "owner:username AND title:california"
Since
100.7

◆ initWithQuery:boundingBox:

- (instancetype) initWithQuery: (NSString *)  query
boundingBox: (nullable AGSEnvelope *)  boundingBox 

Constructor that sets a custom query string to use and a bounding box for a spatial search

Parameters
querythe query string to use, for example "owner:username AND title:california"
boundingBoxan Envelope specifying the bounding box
Since
100.7

◆ initWithQuery:limit:

- (instancetype) initWithQuery: (NSString *)  query
limit: (NSInteger)  limit 

Constructor that sets a custom query string to use and a limit on the number of results to return

Parameters
querythe query string to use, for example "owner:username AND title:california"
limitthe maximum number of results to be returned
Since
100.7

◆ portalGroupContentSearchParametersForItemsOfType:owner:searchString:

+ (AGSPortalGroupContentSearchParameters *) portalGroupContentSearchParametersForItemsOfType: (AGSPortalItemType type
owner: (nullable NSString *)  owner
searchString: (nullable NSString *)  searchString 

Creates an AGSPortalGroupContentSearchParameters that will find items with a particular type Optionally restricts the search to items belonging to a specified owner. An optional search string can be used to restrict the search even further.

Parameters
typethe item type to search for
ownerthe username of the owner of the items, or null to search for items with any owner
searchStringa string specifying other criteria for the search, or null if there are none
Since
100.7

◆ portalGroupContentSearchParametersForItemsOfType:searchString:

+ (AGSPortalGroupContentSearchParameters *) portalGroupContentSearchParametersForItemsOfType: (AGSPortalItemType type
searchString: (nullable NSString *)  searchString 

Creates an AGSPortalGroupContentSearchParameters that will find items with a specified type and, optionally, that also match a specified search string.

Parameters
typeitem type to search for
searchStringa string specifying other criteria for the search, or null if there are none
Since
100.7

◆ portalGroupContentSearchParametersForItemsOfTypes:owner:searchString:

+ (AGSPortalGroupContentSearchParameters *) portalGroupContentSearchParametersForItemsOfTypes: (NSArray< NSValue * > *)  types
owner: (nullable NSString *)  owner
searchString: (nullable NSString *)  searchString 

Creates an AGSPortalGroupContentSearchParameters that will find items with any one of a number of given types Optionally restricts the search to items belonging to a specified owner. An optional search string can be used to restrict the search even further.

Parameters
typesthe item types to search for
ownerthe username of the owner of the items, or null to search for items with any owner
searchStringa string specifying other criteria for the search, or null if there are none
Since
100.7

◆ portalGroupContentSearchParametersForItemsWithOwner:

+ (AGSPortalGroupContentSearchParameters *) portalGroupContentSearchParametersForItemsWithOwner: (NSString *)  owner

Creates an AGSPortalGroupContentSearchParameters that will find items belonging to a specified owner

Parameters
ownerthe username of the owner of the items
Since
100.7

◆ portalGroupContentSearchParametersForItemWithID:

+ (AGSPortalGroupContentSearchParameters *) portalGroupContentSearchParametersForItemWithID: (NSString *)  itemID

Creates an AGSPortalGroupContentSearchParameters that will find an item with a specified item ID

Parameters
itemIDthe ID of the item
Since
100.7

◆ portalGroupContentSearchParametersWithBoundingBox:

+ (instancetype) portalGroupContentSearchParametersWithBoundingBox: (AGSEnvelope *)  boundingBox

Constructor that sets a bounding box for a spatial search

Parameters
boundingBoxan Envelope specifying the bounding box
Since
100.7

◆ portalGroupContentSearchParametersWithQuery:

+ (instancetype) portalGroupContentSearchParametersWithQuery: (NSString *)  query

Constructor that sets a custom query string to use

Parameters
querythe query string to use, for example "owner:username AND title:california"
Since
100.7

◆ portalGroupContentSearchParametersWithQuery:boundingBox:

+ (instancetype) portalGroupContentSearchParametersWithQuery: (NSString *)  query
boundingBox: (nullable AGSEnvelope *)  boundingBox 

Constructor that sets a custom query string to use and a bounding box for a spatial search

Parameters
querythe query string to use, for example "owner:username AND title:california"
boundingBoxan Envelope specifying the bounding box
Since
100.7

◆ portalGroupContentSearchParametersWithQuery:limit:

+ (instancetype) portalGroupContentSearchParametersWithQuery: (NSString *)  query
limit: (NSInteger)  limit 

Constructor that sets a custom query string to use and a limit on the number of results to return

Parameters
querythe query string to use, for example "owner:username AND title:california"
limitthe maximum number of results to be returned
Since
100.7

Property Documentation

◆ boundingBox

- (AGSEnvelope*) boundingBox
readwritenonatomicstrong

An Envelope specifying the bounding box for a spatial search Spatial search is an overlaps/intersects function of the bounding box and the extent of the document. Documents that have no extent (e.g., mxds, 3dds, lyr) will not be found when doing a bounding box search. Document extent is assumed to be in the WGS84 geographic coordinate system.

Since
100.7

◆ categories

- (NSArray<NSString *>*) categories
readwritenonatomiccopy

An Array of content category specifications to use when searching for items Each entry in the Array is a String containing a comma-separated list of up to 8 group content categories. The full path of each category is required and an OR relationship is applied between the categories within a particular String.

There can be up to 8 Strings with an AND relationship being applied between the different Strings.

For example, to search for items belonging to either the Water or Forest categories, both within the US, specify 2 Strings as follows: "/Categories/Water,/Categories/Forest" and "/Region/US".

Since
100.7

◆ limit

- (NSInteger) limit
readwritenonatomicassign

The maximum number of results to be included in the result set response The limit, along with the AGSPortalGroupContentSearchParameters::startIndex, can be used to paginate the search results.

The default value is 10, and the maximum allowed value is 100.

Note that the actual number of returned results may be less than limit. This happens when the number of results remaining after the startIndex is less than limit.

Since
100.7

◆ query

- (NSString*) query
readnonatomiccopy

The query string specified for the search.

See also
http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r3000000mn000000 for information on query syntax
Since
100.7

◆ searchPublic

- (BOOL) searchPublic
readwritenonatomicassign

Indicates whether public items outside the organization may be included in the search results Default behavior is they are included.

Since
100.7

◆ sortField

- (NSString*) sortField
readwritenonatomiccopy

A string containing one or more fields names, comma separated, specifying the field(s) to sort the results by Sort field names are case-insensitive. Supported field names are "title", "created", "type", "owner", "modified", "added", "avgrating", "numratings", "numcomments", and "numviews".

Since
100.7

◆ sortOrder

- (AGSPortalQuerySortOrder) sortOrder
readwritenonatomicassign

The sort order, indicating whether the results are returned in ascending or descending order Default behavior is ascending order.

Since
100.7

◆ startIndex

- (NSInteger) startIndex
readwritenonatomicassign

The index within the entire set of results of the first entry in the current page The startIndex, along with the AGSPortalGroupContentSearchParameters::limit, can be used to paginate the search results. The index number is 1-based and the default value is 1.

Since
100.7