AGSPortalGroup.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 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
 */
 //Required for Globals API doc

#import <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSPortalTypes.h>



typedef NS_ENUM(NSInteger, AGSPortalGroupSortField) {
    AGSPortalGroupSortFieldUnknown = 0,     
    AGSPortalGroupSortFieldTitle,           
    AGSPortalGroupSortFieldOwner,           
    AGSPortalGroupSortFieldAvgRating,       
    AGSPortalGroupSortFieldNumViews,        
    AGSPortalGroupSortFieldCreated,         
    AGSPortalGroupSortFieldModified,        
};

@class AGSLoadableImage;
@class AGSPortal;
@class AGSPortalGroupContentSearchParameters;
@class AGSPortalGroupContentSearchResultSet;

@protocol AGSCancelable;

@interface AGSPortalGroup : AGSLoadableBase <AGSJSONSerializable>

#pragma mark -
#pragma mark initializers



-(instancetype)initWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;


+(instancetype)portalGroupWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;

+(nullable AGSPortalGroup *)fromJSON:(id)JSONObject withPortal:(AGSPortal*)portal error:(NSError**)error;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, weak, readonly) AGSPortal *portal;

@property (nullable, nonatomic, copy, readonly) NSString *groupID;

@property (nullable, nonatomic, copy, readonly) NSString *title;

@property (nullable, nonatomic, copy, readonly) NSString *owner;

@property (nullable, nonatomic, copy, readonly) NSString *groupDescription;

@property (nullable, nonatomic, copy, readonly) NSString *snippet;

@property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *tags;

@property (nullable, nonatomic, strong, readonly) NSDate *created;

@property (nullable, nonatomic, strong, readonly) NSDate *modified;

@property (nonatomic, assign, readonly) AGSPortalAccess access;

@property (nonatomic, assign, readonly, getter=isInvitationOnly) BOOL invitationOnly;

@property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;

@property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *users;

@property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *admins;

@property (nonatomic, assign, readonly) AGSPortalGroupSortField sortField;

@property (nonatomic, assign, readonly) AGSPortalQuerySortOrder sortOrder;

@property (nonatomic, assign, readonly, getter=isViewOnly) BOOL viewOnly;

@property (nullable, nonatomic, copy, readonly) NSString *phone;

#pragma mark -
#pragma mark methods

-(id<AGSCancelable>)fetchUsersWithCompletion:(nullable void(^)(NSArray<NSString*> * __nullable users, NSArray<NSString*> * __nullable admins, NSError * __nullable error))completion;

-(id<AGSCancelable>)findItemsWithSearchParameters:(AGSPortalGroupContentSearchParameters *)parameters
                                       completion:(void(^)(AGSPortalGroupContentSearchResultSet * __nullable result, NSError * __nullable error))completion;

@end