UIImageView(AFNetworking) Category Reference
Declared in | UIImageView+AFNetworking.h |
Overview
This category adds methods to the UIKit framework’s UIImageView
class. The methods in this category provide support for loading remote images asynchronously from a URL.
Tasks
-
– setImageWithURL:
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL, and sets it the request is finished. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
-
– setImageWithURL:placeholderImage:
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
-
– setImageWithURLRequest:placeholderImage:success:failure:
Creates and enqueues an image request operation, which asynchronously downloads the image with the specified URL request object. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
-
– cancelImageRequestOperation
Cancels any executing image request operation for the receiver, if one exists.
Instance Methods
cancelImageRequestOperation
Cancels any executing image request operation for the receiver, if one exists.
- (void)cancelImageRequestOperation
Discussion
Cancels any executing image request operation for the receiver, if one exists.
Declared In
UIImageView+AFNetworking.h
setImageWithURL:
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL, and sets it the request is finished. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
- (void)setImageWithURL:(NSURL *)url
Parameters
- url
The URL used for the image request.
Discussion
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL, and sets it the request is finished. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
@discussion By default, URL requests have a cache policy of NSURLCacheStorageAllowed
and a timeout interval of 30 seconds, and are set not handle cookies. To configure URL requests differently, use setImageWithURLRequest:placeholderImage:success:failure:
Declared In
UIImageView+AFNetworking.h
setImageWithURL:placeholderImage:
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
- (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholderImage
Parameters
- url
The URL used for the image request.
- placeholderImage
The image to be set initially, until the image request finishes. If
nil
, the image view will not change its image until the image request finishes.@discussion By default, URL requests have a cache policy of
NSURLCacheStorageAllowed
and a timeout interval of 30 seconds, and are set not handle cookies. To configure URL requests differently, usesetImageWithURLRequest:placeholderImage:success:failure:
Discussion
Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
Declared In
UIImageView+AFNetworking.h
setImageWithURLRequest:placeholderImage:success:failure:
Creates and enqueues an image request operation, which asynchronously downloads the image with the specified URL request object. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
- (void)setImageWithURLRequest:(NSURLRequest *)urlRequest placeholderImage:(UIImage *)placeholderImage success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , UIImage *image ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error ))failure
Parameters
- urlRequest
The URL request used for the image request.
- placeholderImage
The image to be set initially, until the image request finishes. If
nil
, the image view will not change its image until the image request finishes.
- success
A block to be executed when the image request operation 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 sent from the client, the response received from the server, and the image created from the response data of request. If the image was returned from cache, the request and response parameters will benil
.
- failure
A block object to be executed when the image request operation finishes unsuccessfully, or that finishes successfully. This block has no return value and takes three arguments: the request sent from the client, the response received from the server, and the error object describing the network or parsing error that occurred.
@discussion If a success block is specified, it is the responsibility of the block to set the image of the image view before returning. If no success block is specified, the default behavior of setting the image with
self.image = image
is executed.
Discussion
Creates and enqueues an image request operation, which asynchronously downloads the image with the specified URL request object. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.
Declared In
UIImageView+AFNetworking.h