AGSDynamicLayerImageRequestOperation Class Reference

---

Description

Operation that will retrieve a dynamic layer image and adopts the AGSDynamicLayerDrawingOperation protocol.

Defined in:

AGSDynamicLayer.h (ArcGIS library)

Since:

1.0

Inheritance diagram for AGSDynamicLayerImageRequestOperation:

List of all members.

Public Member Functions
(AGSRequestOperation *)	- copyOperation
(void)	- done
(id)	- initWithRequest:
(id)	- initWithURL:
(id)	- initWithURL:queryParameters:
(id)	- initWithURL:resource:queryParameters:
(id)	- initWithURL:resource:queryParameters:doPOST:
(void)	- invokeActionSelector:withObject:
(NSError *)	- processError:
(id)	- processResultData:
(void)	- setIsExecuting:
(void)	- setIsFinished:
(BOOL)	- shouldProcessResultDataInBackground:
Static Public Member Functions
(NSOperationQueue *)	+ sharedOperationQueue
Properties
SEL	action
AGSCredential *	credential
SEL	errorAction
AGSExportImageParams *	exportImageParams
BOOL	post
NSDictionary *	query
NSURLRequest *	request
NSString *	resource
NSMutableDictionary *	state
id	target
NSURL *	URL
BOOL	waitUntilActionSelectorIsDone

---

Member Function Documentation

- (AGSRequestOperation*) copyOperation

Creates a copy of the current operation to be re-added to the operation queue for resubmission. This is useful if a token expires and the operation needs to be resubmitted with a new token or set of credentials.

Since:

1.0

- (void) done

Simple method to set finished & executing flags on the operation

Since:

1.0

- (id) initWithRequest:

(NSURLRequest *)

req

Initialize an AGSRequestOperation with the specified request.

Parameters:

req

Request to initialize the operation with.

Returns:

Initialized AGSRequestOperation.

Since:

1.0

- (id) initWithURL:

(NSURL *)

url

Initialize an AGSRequestOperation with the specified url.

Parameters:

url

URL to initialize the request operation.

Returns:

Initialized AGSRequestOperation.

Since:

1.0

- (id) initWithURL:		(NSURL *)	url
queryParameters:		(NSDictionary *)	query

Initialize an AGSRequestOperation with the specified url and query parameters.

Parameters:

	url	URL to initialize the request operation.
	query	Query parameters to submit along with the request.

Returns:

Initialized AGSRequestOperation.

Since:

1.0

- (id) initWithURL:		(NSURL *)	url
resource:		(NSString *)	resource
queryParameters:		(NSDictionary *)	query

Initialize an AGSRequestOperation with the specified url, resource, and query parameters.

Parameters:

	url	URL to initialize the request operation.
	resource	Resource to access off of the url.
	query	Query parameters to submit along with the request to the resource.

Returns:

Initialized AGSRequestOperation

Since:

1.0

- (id) initWithURL:		(NSURL *)	url
resource:		(NSString *)	resource
queryParameters:		(NSDictionary *)	query
doPOST:		(BOOL)	post

Designated initializer. Initialize an AGSRequestOperation with the specified url, resource, query parameters, and post flag.

Parameters:

	url	URL to initialize the request operation.
	resource	Resource to access off of the url.
	query	Query parameters to submit along with the request to the resource.
	post	Post flag to determine whether or not to use a GET or POST,

Returns:

Initialized AGSRequestOperation

Since:

1.0

- (void) invokeActionSelector:		(SEL)	theSel
withObject:		(id)	results

Derived classes can call this if they need to invoke the action or errorAction directly.

Parameters:

	theSel	Selector to be called
	results	object to be passed as an argument to theSel

Since:

1.0

- (NSError *) processError:

(NSError *)

error

Method to override to process the error that results, if any, from a request

Since:

1.0

- (id) processResultData:

(NSData *)

data

Methods to override to process results and errors before sending them to the callbacks

Parameters:

data

to be processed from the request

Since:

1.0

- (void) setIsExecuting:

(BOOL)

executing

Sets the executing flag.

Parameters:

executing

Boolean representing whether or not an operation is executing.

Since:

1.0

- (void) setIsFinished:

(BOOL)

finished

Sets the finished flag.

Parameters:

finished

Boolean representing whether or not an operation is finished.

Since:

1.0

+ (NSOperationQueue *) sharedOperationQueue

Class method to retrieve the shared operation queue that is handling all operations. This is where all AGSRequestOperations will be queued.

Since:

1.0

- (BOOL) shouldProcessResultDataInBackground:

(NSData *)

data

Subclasses can override this if processing the data will take a long time and the superclass should call the process method on a bg thread.

Parameters:

data

to be processed in the background

Since:

1.0

---

Property Documentation

- (SEL) action [read, write, assign, inherited]

Selector to be called if the operation succeeds.

Since:

1.0

- (AGSCredential*) credential [read, write, copy, inherited]

Credentials to access a secured resource.

Since:

1.0

- (SEL) errorAction [read, write, assign, inherited]

Selector to be called if the operation fails.

Since:

1.0

- (AGSExportImageParams*) exportImageParams [read, write, retain]

Request parameters for specific area of a map.

Since:

1.0

Reimplemented from <AGSDynamicLayerDrawingOperation>.

- (BOOL) post [read, assign, inherited]

Flag to determine whether or not the request is a GET or POST.

Since:

1.0

- (NSDictionary*) query [read, copy, inherited]

Query parameters to be used in the request to URL.

Since:

1.0

- (NSURLRequest*) request [read, retain, inherited]

Request object to be used instead of generating one on the fly.

Since:

1.0

- (NSString*) resource [read, copy, inherited]

String to append to the end of a url to access a specific resource, such as when exporting an image.

Since:

1.0

- (NSMutableDictionary*) state [read, retain, inherited]

A dictionary that can be filled with objects that need to be retrieved upon completion of an operation and are not passed back as results.

Since:

1.0

- (id) target [read, write, assign, inherited]

Target class to perform the operation from.

Since:

1.0

- (NSURL*) URL [read, copy, inherited]

URL of the resource to make a request from.

Since:

1.0

- (BOOL) waitUntilActionSelectorIsDone [read, write, assign, inherited]

Defaults to NO, but it is helpful if this operation is a dependency for another operation and the action selector processes some results that the dependent operation needs before it can start.

Since:

1.0