ArcGIS Runtime SDK for iOS: AGSPortalGroupContentSearchParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPortalGroupContentSearchParameters.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 #import <ArcGIS/AGSPortalTypes.h>
30 
31 
32 
33 @class AGSEnvelope;
34 
51 
52 #pragma mark -
53 #pragma mark initializers
54 
55 
56 
61 -(instancetype)initWithBoundingBox:(AGSEnvelope *)boundingBox;
62 
67 +(instancetype)portalGroupContentSearchParametersWithBoundingBox:(AGSEnvelope *)boundingBox;
68 
73 -(instancetype)initWithQuery:(NSString *)query;
74 
79 +(instancetype)portalGroupContentSearchParametersWithQuery:(NSString *)query;
80 
86 -(instancetype)initWithQuery:(NSString *)query
87  boundingBox:(nullable AGSEnvelope *)boundingBox;
88 
94 +(instancetype)portalGroupContentSearchParametersWithQuery:(NSString *)query
95  boundingBox:(nullable AGSEnvelope *)boundingBox;
96 
102 -(instancetype)initWithQuery:(NSString *)query
103  limit:(NSInteger)limit;
104 
110 +(instancetype)portalGroupContentSearchParametersWithQuery:(NSString *)query
111  limit:(NSInteger)limit;
112 
113 #pragma mark -
114 #pragma mark properties
115 
122 @property (nullable, nonatomic, strong, readwrite) AGSEnvelope *boundingBox;
123 
135 @property (nonatomic, copy, readwrite) NSArray<NSString *> *categories;
136 
147 @property (nonatomic, assign, readwrite) NSInteger limit;
148 
153 @property (nullable, nonatomic, copy, readonly) NSString *query;
154 
159 @property (nonatomic, assign, readwrite) BOOL searchPublic;
160 
166 @property (nullable, nonatomic, copy, readwrite) NSString *sortField;
167 
172 @property (nonatomic, assign, readwrite) AGSPortalQuerySortOrder sortOrder;
173 
179 @property (nonatomic, assign, readwrite) NSInteger startIndex;
180 
181 #pragma mark -
182 #pragma mark methods
183 
192 +(AGSPortalGroupContentSearchParameters *)portalGroupContentSearchParametersForItemsOfType:(AGSPortalItemType)type
193  owner:(nullable NSString *)owner
194  searchString:(nullable NSString *)searchString;
195 
202 +(AGSPortalGroupContentSearchParameters *)portalGroupContentSearchParametersForItemsOfType:(AGSPortalItemType)type
203  searchString:(nullable NSString *)searchString;
204 
213 +(AGSPortalGroupContentSearchParameters *)portalGroupContentSearchParametersForItemsOfTypes:(NSArray<NSValue *> *)types
214  owner:(nullable NSString *)owner
215  searchString:(nullable NSString *)searchString;
216 
221 +(AGSPortalGroupContentSearchParameters *)portalGroupContentSearchParametersForItemsWithOwner:(NSString *)owner;
222 
227 +(AGSPortalGroupContentSearchParameters *)portalGroupContentSearchParametersForItemWithID:(NSString *)itemID;
228 
229 @end
230 
231 
AGSPortalQuerySortOrder
Definition: AGSPortalTypes.h:281
AGSPortalItemType
Definition: AGSPortalTypes.h:33
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
Definition: AGSObject.h:28
Contains search parameters suitable for finding portal items that belong to a portal group.
Definition: AGSPortalGroupContentSearchParameters.h:51
AGSPortalQuerySortOrder sortOrder
Definition: AGSPortalGroupContentSearchParameters.h:172
BOOL searchPublic
Definition: AGSPortalGroupContentSearchParameters.h:159
NSInteger startIndex
Definition: AGSPortalGroupContentSearchParameters.h:179
AGSEnvelope * boundingBox
Definition: AGSPortalGroupContentSearchParameters.h:122
NSString * query
Definition: AGSPortalGroupContentSearchParameters.h:153
NSInteger limit
Definition: AGSPortalGroupContentSearchParameters.h:147
NSString * sortField
Definition: AGSPortalGroupContentSearchParameters.h:166
NSArray< NSString * > * categories
Definition: AGSPortalGroupContentSearchParameters.h:135