AGSPortalQueryParameters.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSJSONSerializableBase.h>
#import <ArcGIS/AGSPortalTypes.h>
 
@class AGSEnvelope;
 //Required for Globals API doc
 
@interface AGSPortalQueryParameters : AGSJSONSerializableBase
 
 
@property (nullable, nonatomic, copy, readwrite) NSString *query;
 
@property (nullable, nonatomic, copy, readwrite) NSString *sortField;
 
@property (nonatomic, assign, readwrite) AGSPortalQuerySortOrder sortOrder;
 
@property (nonatomic, assign, readwrite) NSInteger startIndex;
 
@property (nonatomic, assign, readwrite) NSInteger limit;
 
@property (nullable, nonatomic, strong, readwrite) AGSEnvelope *boundingBox;
 
@property (nonatomic, assign, readwrite) BOOL searchPublic;
 
@property (nonatomic, copy, readwrite) NSArray<NSString *> *categories;
 
-(instancetype)initWithQuery:(NSString*)query;
 
+(AGSPortalQueryParameters*)queryParametersWithQuery:(NSString*)query;
 
-(instancetype)initWithQuery:(NSString*)query limit:(NSInteger)limit;
 
+(AGSPortalQueryParameters*)queryParametersWithQuery:(NSString*)query limit:(NSInteger)limit;
 
+(AGSPortalQueryParameters*)queryParametersForGroupsWithOwner:(nullable NSString*)username title:(nullable NSString*)title;
 
+(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type withSearchString:(nullable NSString*)searchString;
 
+(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type inGroup:(nullable NSString*)groupID withSearchString:(nullable NSString*)searchString;
 
+(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type inGroup:(nullable NSString*)groupID;
 
+(AGSPortalQueryParameters*)queryParametersForItemsInGroup:(NSString*)groupID;
 
+(AGSPortalQueryParameters*)queryParametersForItemWithID:(NSString*)itemID;
 
+(AGSPortalQueryParameters*)queryParametersForItemsWithOwner:(NSString*)username searchString:(nullable NSString*)searchString;
 
+(AGSPortalQueryParameters*)queryParametersForItemsOfType:(AGSPortalItemType)type owner:(NSString*)username searchString:(nullable NSString*)searchString;
 
+(AGSPortalQueryParameters *)queryParametersForItemsOfTypes:(NSArray<NSValue *> *)types
                                                      owner:(nullable NSString *)owner
                                                    groupID:(nullable NSString *)groupID
                                               searchString:(nullable NSString *)searchString;
 
 
@end