AGSJob.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/AGSObject.h>
#import <ArcGIS/AGSRemoteResource.h>
#import <ArcGIS/AGSJSONSerializable.h>



typedef NS_ENUM(NSInteger, AGSJobType) {
    AGSJobTypeGenerateGeodatabase = 0,      
    AGSJobTypeSyncGeodatabase = 1,          
    AGSJobTypeExportTileCache = 2,          
    AGSJobTypeEstimateTileCacheSize = 3,    
    AGSJobTypeGeoprocessingJob = 4,         
    AGSJobTypeGenerateOfflineMap = 5,       
    AGSJobTypeOfflineMapSync = 7            
};

typedef NS_ENUM(NSInteger, AGSJobStatus) {
    AGSJobStatusNotStarted = 0, 
    AGSJobStatusStarted = 1,    
    AGSJobStatusPaused = 2,     
    AGSJobStatusSucceeded = 3,  
    AGSJobStatusFailed = 4      
};

@class AGSJobMessage;

@protocol AGSCancelable;

@interface AGSJob : AGSObject <AGSRemoteResource, AGSJSONSerializable, NSProgressReporting>

#pragma mark -
#pragma mark initializers



#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readonly) NSError *error;

@property (nonatomic, assign, readonly) AGSJobType jobType;

@property (nonatomic, copy, readonly) NSArray<AGSJobMessage*> *messages;

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

@property (nonatomic, assign, readonly) AGSJobStatus status;

@property (nullable, nonatomic, strong, readonly) id result;

@property (nonatomic, strong, readonly) NSProgress *progress;

#pragma mark -
#pragma mark methods

-(void)startWithStatusHandler:(nullable void(^)(AGSJobStatus status))statusHandler
                   completion:(void(^)(id __nullable result, NSError * __nullable error))completion;

-(BOOL)pause ;

-(BOOL)cancel ;

/*
 Force status check. This method can be called from `application:performFetchWithCompletionHandler:`.
 */
-(id<AGSCancelable>)checkStatusWithCompletion:(void(^)(NSError * __nullable error))completion;

@end