AGSLoadable.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 <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);