ArcGIS Runtime SDK for iOS: AGSQueryParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSQueryParameters.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 #import <ArcGIS/AGSSpatialRelationship.h>
28 
29 @class AGSGeometry;
30 @class AGSOrderBy;
31 @class AGSSpatialReference;
32 @class AGSTimeExtent;
33  //Required for Globals API doc
35 
45 
46 
47 
48 #pragma mark -
49 #pragma mark initializers
50 
51 -(instancetype)init;
52 +(instancetype)queryParameters;
53 
54 #pragma mark -
55 #pragma mark properties
56 
60 @property (nullable, nonatomic, strong, readwrite) AGSGeometry *geometry;
61 
65 @property (nonatomic, assign, readwrite) double maxAllowableOffset;
66 
71 @property (nonatomic, assign, readwrite) NSInteger maxFeatures;
72 
76 @property (nonatomic, copy, readwrite) NSArray<NSNumber*> *objectIDs;
77 
81 @property (nonatomic, copy, readwrite) NSArray<AGSOrderBy*> *orderByFields;
82 
86 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outSpatialReference;
87 
92 @property (nonatomic, assign, readwrite) NSInteger resultOffset;
93 
97 @property (nonatomic, assign, readwrite) BOOL returnGeometry;
98 
102 @property (nonatomic, assign, readwrite) AGSSpatialRelationship spatialRelationship;
103 
107 @property (nullable, nonatomic, strong, readwrite) AGSTimeExtent *timeExtent;
108 
112 @property (nonatomic, copy, readwrite) NSString *whereClause;
113 
114 #pragma mark -
115 #pragma mark methods
116 
117 
118 
119 @end
AGSSpatialRelationship
Definition: AGSSpatialRelationship.h:35
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
Definition: AGSObject.h:28
An object that is used to specify the sort order of query results.
Definition: AGSOrderBy.h:48
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:45
AGSSpatialReference * outSpatialReference
Definition: AGSQueryParameters.h:86
instancetype init()
AGSGeometry * geometry
Definition: AGSQueryParameters.h:60
NSArray< NSNumber * > * objectIDs
Definition: AGSQueryParameters.h:76
NSString * whereClause
Definition: AGSQueryParameters.h:112
AGSSpatialRelationship spatialRelationship
Definition: AGSQueryParameters.h:102
AGSTimeExtent * timeExtent
Definition: AGSQueryParameters.h:107
double maxAllowableOffset
Definition: AGSQueryParameters.h:65
instancetype queryParameters()
NSArray< AGSOrderBy * > * orderByFields
Definition: AGSQueryParameters.h:81
NSInteger resultOffset
Definition: AGSQueryParameters.h:92
NSInteger maxFeatures
Definition: AGSQueryParameters.h:71
BOOL returnGeometry
Definition: AGSQueryParameters.h:97
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46
Represents a span of time between a start time and end time.
Definition: AGSTimeExtent.h:42