AFImageRequestOperation Class Reference

Inherits from	AFHTTPRequestOperation : AFURLConnectionOperation : NSOperation
Declared in	AFImageRequestOperation.h AFImageRequestOperation.m

Overview

AFImageRequestOperation is a subclass of AFHTTPRequestOperation for downloading an processing images.

Acceptable Content Types

By default, AFImageRequestOperation accepts the following MIME types, which correspond to the image formats supported by UIImage or NSImage:

image/tiff
image/jpeg
image/gif
image/png
image/ico
image/x-icon
image/bmp
image/x-bmp
image/x-xbitmap
image/x-win-bitmap

Tasks

Other Methods

responseImage
An image constructed from the response data. If an error occurs during the request, nil will be returned, and the error property will be set to the error.
property
imageScale
The scale factor used when interpreting the image data to construct responseImage. Specifying a scale factor of 1.0 results in an image whose size matches the pixel-based dimensions of the image. Applying a different scale factor changes the size of the image as reported by the size property. This is set to the value of scale of the main screen by default, which automatically scales images for retina displays, for instance.
property
+ imageRequestOperationWithRequest:success:
Creates and returns an AFImageRequestOperation object and sets the specified success callback.
+ imageRequestOperationWithRequest:imageProcessingBlock:success:failure:
Creates and returns an AFImageRequestOperation object and sets the specified success callback.

Other Methods

– initWithRequest:
Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.
+ acceptableContentTypes
Returns an NSSet object containing the acceptable MIME types. When non-nil, the operation will set the error property to an error in AFErrorDomain. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
+ canProcessRequest:
A Boolean value determining whether or not the class can process the specified request. For example, AFJSONRequestOperation may check to make sure the content type was application/json or the URL path extension was .json.
– setCompletionBlockWithSuccess:failure:
Sets the completionBlock property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If error returns a value, which can be caused by an unacceptable status code or content type, then failure is executed. Otherwise, success is executed.

Properties

imageScale

The scale factor used when interpreting the image data to construct responseImage. Specifying a scale factor of 1.0 results in an image whose size matches the pixel-based dimensions of the image. Applying a different scale factor changes the size of the image as reported by the size property. This is set to the value of scale of the main screen by default, which automatically scales images for retina displays, for instance.

@property (nonatomic, assign) CGFloat imageScale

Discussion

The scale factor used when interpreting the image data to construct responseImage. Specifying a scale factor of 1.0 results in an image whose size matches the pixel-based dimensions of the image. Applying a different scale factor changes the size of the image as reported by the size property. This is set to the value of scale of the main screen by default, which automatically scales images for retina displays, for instance.

Declared In

AFImageRequestOperation.h

responseImage

An image constructed from the response data. If an error occurs during the request, nil will be returned, and the error property will be set to the error.

@property (readonly, nonatomic, strong) UIImage *responseImage

Discussion

An image constructed from the response data. If an error occurs during the request, nil will be returned, and the error property will be set to the error.

Declared In

AFImageRequestOperation.h

Class Methods

acceptableContentTypes

Returns an NSSet object containing the acceptable MIME types. When non-nil, the operation will set the error property to an error in AFErrorDomain. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17

+ (NSSet *)acceptableContentTypes

Discussion

Returns an NSSet object containing the acceptable MIME types. When non-nil, the operation will set the error property to an error in AFErrorDomain. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17

By default, this is nil.

Declared In

AFHTTPRequestOperation.h

canProcessRequest:

A Boolean value determining whether or not the class can process the specified request. For example, AFJSONRequestOperation may check to make sure the content type was application/json or the URL path extension was .json.

+ (BOOL)canProcessRequest:(NSURLRequest *)request

Parameters

urlRequest: The request that is determined to be supported or not supported for this class.

Discussion

A Boolean value determining whether or not the class can process the specified request. For example, AFJSONRequestOperation may check to make sure the content type was application/json or the URL path extension was .json.

Declared In

AFHTTPRequestOperation.h

imageRequestOperationWithRequest:imageProcessingBlock:success:failure:

Creates and returns an AFImageRequestOperation object and sets the specified success callback.

+ (AFImageRequestOperation *)imageRequestOperationWithRequest:(NSURLRequest *)urlRequest imageProcessingBlock:(UIImage *( ^ ) ( UIImage *image ))imageProcessingBlock success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , UIImage *image ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error ))failure

Parameters

urlRequest: The request object to be loaded asynchronously during execution of the operation.

imageProcessingBlock: A block object to be executed after the image request finishes successfully, but before the image is returned in the success block. This block takes a single argument, the image loaded from the response body, and returns the processed image.

success: A block object to be executed when the request finishes successfully, with a status code in the 2xx range, and with an acceptable content type (e.g. image/png). This block has no return value and takes three arguments: the request object of the operation, the response for the request, and the image created from the response data.

failure: A block object to be executed when the request finishes unsuccessfully. This block has no return value and takes three arguments: the request object of the operation, the response for the request, and the error associated with the cause for the unsuccessful operation.

Return Value

A new image request operation

Discussion

Creates and returns an AFImageRequestOperation object and sets the specified success callback.

Declared In

AFImageRequestOperation.h

imageRequestOperationWithRequest:success:

Creates and returns an AFImageRequestOperation object and sets the specified success callback.

+ (AFImageRequestOperation *)imageRequestOperationWithRequest:(NSURLRequest *)urlRequest success:(void ( ^ ) ( UIImage *image ))success

Parameters

urlRequest: The request object to be loaded asynchronously during execution of the operation.

success: A block object to be executed when the request finishes successfully. This block has no return value and takes a single arguments, the image created from the response data of the request.

Return Value

A new image request operation

Discussion

Creates and returns an AFImageRequestOperation object and sets the specified success callback.

Declared In

AFImageRequestOperation.h

Instance Methods

initWithRequest:

Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.

- (id)initWithRequest:(NSURLRequest *)urlRequest

Parameters

urlRequest

The request object to be used by the operation connection.

@discussion This is the designated initializer.

Discussion

Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.

Declared In

AFURLConnectionOperation.h

setCompletionBlockWithSuccess:failure:

Sets the completionBlock property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If error returns a value, which can be caused by an unacceptable status code or content type, then failure is executed. Otherwise, success is executed.

- (void)setCompletionBlockWithSuccess:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure

Parameters

success: The block to be executed on the completion of a successful request. This block has no return value and takes two arguments: the receiver operation and the object constructed from the response data of the request.

failure

The block to be executed on the completion of an unsuccessful request. This block has no return value and takes two arguments: the receiver operation and the error that occurred during the request.

@discussion This method should be overridden in subclasses in order to specify the response object passed into the success block.

Discussion

Sets the completionBlock property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If error returns a value, which can be caused by an unacceptable status code or content type, then failure is executed. Otherwise, success is executed.

Declared In

AFHTTPRequestOperation.h