ArcGIS Runtime SDK for iOS: AGSRelatedQueryParameters Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSRelatedQueryParameters Class Reference

Description

Parameters to perform a related query using AGSArcGISFeatureTable.

Instances of this class represent parameters that can be used to perform a query using queryRelatedFeaturesForFeature:parameters:completion: (AGSArcGISFeatureTable).

Since
100.1
Inheritance diagram for AGSRelatedQueryParameters:
AGSObject

Instance Methods

(instancetype) - initWithRelationshipInfo:
 

Class Methods

(instancetype) + relatedQueryParametersWithRelationshipInfo:
 

Properties

NSInteger maxFeatures
 
NSArray< AGSOrderBy * > * orderByFields
 
AGSRelationshipInforelationshipInfo
 
NSInteger resultOffset
 
BOOL returnGeometry
 
NSString * whereClause
 

Method Documentation

◆ initWithRelationshipInfo:

- (instancetype) initWithRelationshipInfo: (AGSRelationshipInfo *)  relationshipInfo

Creates a parameter with the provided relationship.

Parameters
relationshipInfospecifying the relationship to query on.
Since
100.1

◆ relatedQueryParametersWithRelationshipInfo:

+ (instancetype) relatedQueryParametersWithRelationshipInfo: (AGSRelationshipInfo *)  relationshipInfo

Creates a parameter with the provided relationship.

Parameters
relationshipInfoRelationship information specifying the relationship to query on.
Since
100.1
Returns
A new parameter.

Property Documentation

◆ maxFeatures

- (NSInteger) maxFeatures
readwritenonatomicassign

The maximum number of results that should be returned.

Note
For consistent ordering of results when using pagination, you should also provide a value for orderByFields.
Since
100.2

◆ orderByFields

- (NSArray<AGSOrderBy*>*) orderByFields
readwritenonatomiccopy

Fields by which the results need to be ordered. Note, the service being queried must support advanced queries.

Since
100.1

◆ relationshipInfo

- (AGSRelationshipInfo*) relationshipInfo
readwritenonatomicstrong

Information about the relationship that the query is based on.

Since
100.1

◆ resultOffset

- (NSInteger) resultOffset
readwritenonatomicassign

The starting offset of results to fetch. This is useful for paging through results.

Note
If providing a result offset, you must also set maxFeatures otherwise the offset is ignored.
Since
100.2

◆ returnGeometry

- (BOOL) returnGeometry
readwritenonatomicassign

If YES, result features will include their geometry. This is needed when you want to display the features on a map or a scene. If non-spatial data is being queried, result features will not contain a geometry.

Since
100.1

◆ whereClause

- (NSString*) whereClause
readwritenonatomiccopy

A SQL where clause to filter results for the query. If the where clause includes dates, they must be correctly formatted based on the geodatabase datasource used in the service. Refer to this document for date formats expected by different datasources.

Since
100.1