AGSLoadable.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/AGSDefines.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSLoadStatus) {
    AGSLoadStatusLoaded = 0,            
    AGSLoadStatusLoading = 1,           
    AGSLoadStatusFailedToLoad = 2,      
    AGSLoadStatusNotLoaded = 3,         
    AGSLoadStatusUnknown = -1           
} ;
 
AGS_EXTERN AGSLoadStatus AGSLoadStatusFromString(NSString *loadStatus);
 
AGS_EXTERN NSString *AGSLoadStatusAsString(AGSLoadStatus loadStatus);
 
AGS_EXTERN NSNotificationName AGSLoadableDidLoadNotification;
AGS_EXTERN NSNotificationName AGSLoadableDidFailToLoadNotification;
 
@protocol AGSLoadable 
 
@required
 
-(void)loadWithCompletion:(nullable void(^)(NSError * __nullable error))completion;
 
-(void)retryLoadWithCompletion:(nullable void(^)(NSError * __nullable error))completion;
 
-(void)cancelLoad;
 
// kvo enabled properties
@property (nonatomic, assign, readonly) AGSLoadStatus loadStatus;
 
@property (nullable, nonatomic, strong, readonly) NSError *loadError;
 
@end
 
#pragma mark loadObjects declaration
 
typedef void (^ags_load_objects_block_t)(BOOL finishedWithNoErrors);
 
AGS_EXTERN void AGSLoadObjects(NSArray<id<AGSLoadable>> *array, _Nullable ags_load_objects_block_t completion);