Updated the doc with the new completion type (SDWebImageManager loadImageWithURL)

This commit is contained in:
Bogdan Poplauschi 2016-06-01 10:02:20 +03:00
parent ada86ab939
commit 32f4e4d234
1 changed files with 6 additions and 4 deletions

View File

@ -197,16 +197,18 @@ SDWebImageManager *manager = [SDWebImageManager sharedManager];
* *
* This parameter is required. * This parameter is required.
* *
* This block has no return value and takes the requested UIImage as first parameter. * This block has no return value and takes the requested UIImage as first parameter and the NSData representation as second parameter.
* In case of error the image parameter is nil and the second parameter may contain an NSError. * In case of error the image parameter is nil and the third parameter may contain an NSError.
* *
* The third parameter is an `SDImageCacheType` enum indicating if the image was retrieved from the local cache * The forth parameter is an `SDImageCacheType` enum indicating if the image was retrieved from the local cache
* or from the memory cache or from the network. * or from the memory cache or from the network.
* *
* The last parameter is set to NO when the SDWebImageProgressiveDownload option is used and the image is * The fith parameter is set to NO when the SDWebImageProgressiveDownload option is used and the image is
* downloading. This block is thus called repeatedly with a partial image. When image is fully downloaded, the * downloading. This block is thus called repeatedly with a partial image. When image is fully downloaded, the
* block is called a last time with the full image and the last parameter set to YES. * block is called a last time with the full image and the last parameter set to YES.
* *
* The last parameter is the original image URL
*
* @return Returns an NSObject conforming to SDWebImageOperation. Should be an instance of SDWebImageDownloaderOperation * @return Returns an NSObject conforming to SDWebImageOperation. Should be an instance of SDWebImageDownloaderOperation
*/ */
- (id <SDWebImageOperation>)loadImageWithURL:(NSURL *)url - (id <SDWebImageOperation>)loadImageWithURL:(NSURL *)url