AGSPortalItem.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
 */
 //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSItem.h>
#import <ArcGIS/AGSLoadable.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSPortalTypes.h>
#import <ArcGIS/AGSCancelable.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSPortalItemRelationship) {
    AGSPortalItemRelationshipMapToService,                  
    AGSPortalItemRelationshipWMAToCode,                     
    AGSPortalItemRelationshipMapToFeatureCollection,        
    AGSPortalItemRelationshipMobileAppToCode,               
    AGSPortalItemRelationshipServiceToData,                 
    AGSPortalItemRelationshipServiceToService,              
    AGSPortalItemRelationshipMapToAppConfig,                
    AGSPortalItemRelationshipItemToAttachment,              
    AGSPortalItemRelationshipItemToReport,                  
    AGSPortalItemRelationshipListedToProvisioned,           
    AGSPortalItemRelationshipStyleToStyle,                  
    AGSPortalItemRelationshipServiceToStyle,                
    AGSPortalItemRelationshipSurveyToService,               
    AGSPortalItemRelationshipSurveyToData,                  
    AGSPortalItemRelationshipServiceToRoute,                
    AGSPortalItemRelationshipAreaToPackage,                 
    AGSPortalItemRelationshipMapToArea,                     
    AGSPortalItemRelationshipServiceToLayer,                
    AGSPortalItemRelationshipAreaToCustomPackage,           
    AGSPortalItemRelationshipTrackViewToMap,                
    AGSPortalItemRelationshipSurveyAddInToData,             
    AGSPortalItemRelationshipWorkforceMapToFeatureService,  
    AGSPortalItemRelationshipThemeToStory,                  
    AGSPortalItemRelationshipWebStyleToDesktopStyle,        
    AGSPortalItemRelationshipSolutionToItem,                
    AGSPortalItemRelationshipAPIKeyToItem                   
};
 
typedef NS_ENUM(NSInteger, AGSPortalItemRelationshipDirection) {
    AGSPortalItemRelationshipDirectionForward,  
    AGSPortalItemRelationshipDirectionReverse   
};
 
 
@class AGSEnvelope;
@class AGSPortal;
@class AGSPortalItemComment;
@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>)fetchRelatedItemsWithRelationship:(AGSPortalItemRelationship)relationship
                                             direction:(AGSPortalItemRelationshipDirection)direction
                                            completion:(void(^)(NSArray<AGSPortalItem *> * __nullable result, NSError * __nullable error))completion;
 
- (id<AGSCancelable>)fetchRelatedItemsWithRelationships:(NSArray<NSValue *> *)relationships
                                              direction:(AGSPortalItemRelationshipDirection)direction
                                             completion:(void(^)(NSArray<AGSPortalItem *> * __nullable result, 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
 
@interface NSValue (AGSPortalItem)
 
+ (instancetype _Null_unspecified)ags_valueWithPortalItemRelationship:(AGSPortalItemRelationship)relationship;
 
- (AGSPortalItemRelationship)ags_portalItemRelationshipValue;
 
@end