ArcGIS Runtime SDK for iOS: AGSPortalQueryParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPortalQueryParameters.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/AGSJSONSerializableBase.h>
27 #import <ArcGIS/AGSPortalTypes.h>
28 
29 @class AGSEnvelope;
30  //Required for Globals API doc
32 
40 
41 
46 @property (nullable, nonatomic, copy, readwrite) NSString *query;
47 
51 @property (nullable, nonatomic, copy, readwrite) NSString *sortField;
52 
57 @property (nonatomic, assign, readwrite) AGSPortalQuerySortOrder sortOrder;
58 
62 @property (nonatomic, assign, readwrite) NSInteger startIndex;
63 
67 @property (nonatomic, assign, readwrite) NSInteger limit;
68 
72 @property (nullable, nonatomic, strong, readwrite) AGSEnvelope *boundingBox;
73 
78 @property (nonatomic, assign, readwrite) BOOL searchPublic;
79 
100 @property (nonatomic, copy, readwrite) NSArray<NSString *> *categories;
101 
106 -(instancetype)initWithQuery:(NSString*)query;
107 
112 +(AGSPortalQueryParameters*)queryParametersWithQuery:(NSString*)query;
113 
119 -(instancetype)initWithQuery:(NSString*)query limit:(NSInteger)limit;
120 
126 +(AGSPortalQueryParameters*)queryParametersWithQuery:(NSString*)query limit:(NSInteger)limit;
127 
134 +(AGSPortalQueryParameters*)queryParametersForGroupsWithOwner:(nullable NSString*)username title:(nullable NSString*)title;
135 
141 +(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type withSearchString:(nullable NSString*)searchString;
142 
149 +(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type inGroup:(nullable NSString*)groupID withSearchString:(nullable NSString*)searchString;
150 
156 +(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type inGroup:(nullable NSString*)groupID;
157 
162 +(AGSPortalQueryParameters*)queryParametersForItemsInGroup:(NSString*)groupID;
163 
168 +(AGSPortalQueryParameters*)queryParametersForItemWithID:(NSString*)itemID;
169 
175 +(AGSPortalQueryParameters*)queryParametersForItemsWithOwner:(NSString*)username searchString:(nullable NSString*)searchString;
176 
183 +(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type owner:(NSString*)username searchString:(nullable NSString*)searchString;
184 
194 +(AGSPortalQueryParameters *)queryParametersForItemsOfTypes:(NSArray<NSValue *> *)types
195  owner:(nullable NSString *)owner
196  groupID:(nullable NSString *)groupID
197  searchString:(nullable NSString *)searchString;
198 
199 
200 @end
AGSPortalQuerySortOrder
Definition: AGSPortalTypes.h:281
AGSPortalItemType
Definition: AGSPortalTypes.h:33
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A class that provides a base implementation for our JSON serializable objects.
Definition: AGSJSONSerializableBase.h:41
Defines a query on a portal.
Definition: AGSPortalQueryParameters.h:40
AGSEnvelope * boundingBox
Definition: AGSPortalQueryParameters.h:72
NSArray< NSString * > * categories
Definition: AGSPortalQueryParameters.h:100
NSString * query
Definition: AGSPortalQueryParameters.h:46
NSInteger limit
Definition: AGSPortalQueryParameters.h:67
BOOL searchPublic
Definition: AGSPortalQueryParameters.h:78
NSString * sortField
Definition: AGSPortalQueryParameters.h:51
AGSPortalQuerySortOrder sortOrder
Definition: AGSPortalQueryParameters.h:57
NSInteger startIndex
Definition: AGSPortalQueryParameters.h:62