ios/sdk/WeexSDK/Sources/Protocol/WXImgLoaderProtocol.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#import <WeexSDK/WXModuleProtocol.h>
#import <WeexSDK/WXType.h>

NS_ASSUME_NONNULL_BEGIN

@protocol WXImageOperationProtocol <NSObject>

- (void)cancel;

@end

typedef NS_ENUM(NSInteger, WXImageLoaderCacheType) {
    /**
     * The image wasn't available the imageLoad caches, but was downloaded from the web.
     */
    WXImageLoaderCacheTypeNone,
    /**
     * The image was obtained from the disk cache.
     */
    WXImageLoaderCacheTypeDisk,
    /**
     * The image was obtained from the memory cache.
     */
    WXImageLoaderCacheTypeMemory
};

@protocol WXImgLoaderProtocol <WXModuleProtocol>

/**
 * @abstract Creates a image download handler with a given URL
 *
 * @param url The URL of the image to download
 *
 * @param imageFrame  The frame of the image you want to set
 *
 * @param options : The options to be used for this download
 *
 * @param completedBlock : A block called once the download is completed.
 *                 image : the image which has been download to local.
 *                 error : the error which has happened in download.
 *              finished : a Boolean value indicating whether download action has finished.
 */
- (id<WXImageOperationProtocol>)downloadImageWithURL:(NSString *)url imageFrame:(CGRect)imageFrame userInfo:(NSDictionary * _Nullable)options completed:(void(^)(UIImage * _Nullable image,  NSError * _Nullable error, BOOL finished))completedBlock;

@optional

/**
 * @abstract Creates a image download handler with a given URL
 *
 * @param imageView UIImageView to display the image
 *
 * @param url The URL of the image to download
 *
 * @param placeholder The image to be set initially, until the image request finishes.
 *
 * @param options : The options to be used for download operation
 *
 * @param progressBlock : A block called while the download start
 *
 * @param completedBlock : A block called once the download is completed.
 *                 image : the image which has been download to local.
 *                 error : the error which has happened in download.
 *              finished : a Boolean value indicating whether download action has finished.
 */
- (void)setImageViewWithURL:(UIImageView*)imageView
                        url:(NSURL *)url
           placeholderImage:(UIImage * _Nullable)placeholder
                    options:(NSDictionary* _Nullable)options
                   progress:(nullable void (^)(NSInteger receivedSize, NSInteger expectedSize))progressBlock
                  completed:(nullable void(^)(UIImage *_Nullable image, NSError *_Nullable error, WXImageLoaderCacheType cacheType, NSURL *imageURL))completedBlock;

/**
 * Cancel the current download image
 */
- (void)cancelCurrentImageLoad:(UIImageView*)imageView;

@end

NS_ASSUME_NONNULL_END