AGSPortalItem.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/AGSItem.h>
#import <ArcGIS/AGSLoadable.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSPortalTypes.h>



@class AGSEnvelope;
@class AGSPortal;
@class AGSPortalItemComment;
@class AGSLoadableImage;
@class AGSLoadableValue;
@class AGSPortalGroup;

@interface AGSPortalItem : AGSItem <AGSLoadable, AGSJSONSerializable>

#pragma mark -
#pragma mark initializers



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

+(instancetype)portalItemWithPortal:(AGSPortal*)portal itemID:(NSString*)itemID;

-(instancetype)initWithPortal:(AGSPortal*)portal type:(AGSPortalItemType)type;

+(instancetype)portalItemWithPortal:(AGSPortal*)portal type:(AGSPortalItemType)type;

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

-(nullable instancetype)initWithURL:(NSURL*)URL;

+(nullable instancetype)portalItemWithURL:(NSURL*)URL;

#pragma mark -
#pragma mark properties

@property (nonatomic, strong, readonly) AGSPortal *portal;

@property (nullable, nonatomic, strong, readonly) NSURL *serviceURL;

@property (nonatomic, copy, readonly) NSString *folderID;

@property (nonatomic, copy, readwrite) NSString *owner;

@property (nonatomic, assign, readwrite) AGSPortalItemType type;

@property (nonatomic, copy, readonly) NSString *typeName;

@property (nullable, nonatomic, strong, readonly) NSLocale *locale;

@property (nonatomic, assign, readonly) long long size;

@property (nonatomic, assign, readonly) NSInteger commentCount;

@property (nonatomic, assign, readonly) NSInteger ratingCount;

@property (nonatomic, assign, readonly) CGFloat averageRating;

@property (nonatomic, assign, readonly) NSInteger viewCount;

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

@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalItemComment*> *comments;

@property (nonatomic, assign, readonly) BOOL commentsEnabled;

@property (nullable, nonatomic, strong, readonly) AGSLoadableValue *userRating;

@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *adminGroups;

@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *memberGroups;

@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *otherGroups;

#pragma mark -
#pragma mark methods

-(id<AGSCancelable>)fetchCommentsWithCompletion:(nullable void(^)(NSArray<AGSPortalItemComment*> * __nullable comments, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchGroupsWithCompletion:(nullable void(^)(NSArray<AGSPortalGroup*> * __nullable adminGroups, NSArray<AGSPortalGroup*> * __nullable memberGroups, NSArray<AGSPortalGroup*> * __nullable otherGroups, NSError * __nullable error))completion;

-(id<AGSCancelable>)addRating:(CGFloat)rating completion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)addComment:(NSString*)comment completion:(nullable void(^)(AGSPortalItemComment * __nullable resultComment, NSError * __nullable error))completion;

-(id<AGSCancelable>)updateDataWithJSON:(id)json completion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)updateData:(NSData*)data completion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)shareWithEveryone:(BOOL)everyone org:(BOOL)org completion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)shareWithGroups:(NSArray<AGSPortalGroup*> *)groups completion:(nullable void(^)(NSArray<AGSPortalGroup*> * __nullable excludedGroups, NSError * __nullable error))completion;

-(id<AGSCancelable>)unshareWithCompletion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)unshareWithGroups:(NSArray<AGSPortalGroup*> *)groups completion:(nullable void(^)(NSArray<AGSPortalGroup*> * __nullable excludedGroups, NSError * __nullable error))completion;

-(__nullable id)toJSON:(NSError**)error;

@end

@interface AGSPortalItem (AGSDeprecated)

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

+(instancetype)portalItemWithPortal:(AGSPortal *)portal ;

@property (nonatomic, copy, readwrite) NSString *accessAndUseConstraintsHtml ;
@property (nonatomic, copy, readonly) NSString *GUID __deprecated;

@end