AGSRequestOperation.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/AGSObservableOperation.h>
#import <ArcGIS/AGSCancelable.h>



typedef NS_ENUM(NSInteger, AGSRequestHTTPMethod) {
    AGSRequestHTTPMethodGet = 0,                        
    AGSRequestHTTPMethodPostFormEncodeParameters = 1,   
    AGSRequestHTTPMethodPostJSON = 2                    
};

@class AGSCredential;
@class AGSRequestConfiguration;
@protocol AGSRemoteResource;
@protocol AGSLoadable;

@interface AGSRequestOperation : AGSObservableOperation <AGSCancelable, NSProgressReporting>

#pragma mark -
#pragma mark initializers



- (instancetype)initWithRemoteResource:(nullable id<AGSRemoteResource>)remoteResource
                               request:(NSURLRequest *)request NS_DESIGNATED_INITIALIZER;

- (instancetype)initWithURL:(NSURL *)url;

-(instancetype)initWithRemoteResource:(nullable id<AGSRemoteResource>)remoteResource
                                  URL:(NSURL *)URL
                      queryParameters:(nullable NSDictionary<NSString*,id> *)queryParameters;

-(instancetype)initWithRemoteResource:(nullable id<AGSRemoteResource>)remoteResource
                                  URL:(NSURL*)URL
                      queryParameters:(nullable NSDictionary<NSString*,id> *)queryParameters
                               method:(AGSRequestHTTPMethod)method NS_DESIGNATED_INITIALIZER;
#pragma mark -
#pragma mark properties

@property (nonatomic, strong, readonly) NSURL *URL;

@property (nullable, copy, readonly) NSDictionary<NSString*,id> *queryParameters;

@property (nonatomic, assign, readwrite) AGSRequestHTTPMethod method;

@property (nullable, nonatomic, strong, readonly) NSURLRequest *request;

@property (nullable, nonatomic, strong, readwrite) AGSCredential *credential;

@property (nonatomic, strong, readwrite) AGSRequestConfiguration *requestConfiguration;

@property (nullable, nonatomic, weak, readonly) id<AGSRemoteResource> remoteResource;

@property (nullable, nonatomic, weak, readwrite) id<AGSLoadable> loadDependency;

@property (nullable, nonatomic, strong, readonly) NSURLResponse *response;

@property (nullable, nonatomic, strong, readwrite) NSURL *outputFileURL;

@property (nullable, nonatomic, copy, readwrite) NSString *sessionID;

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

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

@property (nullable, nonatomic, copy, readwrite) void(^progressHandler)(long long totalBytesDownloaded, long long totalBytesExpected);

@property (nonatomic, assign, readwrite) BOOL cancelSessionWhenOperationIsCanceled;

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

#pragma mark -
#pragma mark methods

-(BOOL)pause ;

-(BOOL)isPaused ;

-(void)resume ;

@end