| commit | author | age | ||
| 6e1425 | 1 | // UIWebView+AFNetworking.h |
| H | 2 | // Copyright (c) 2011–2015 Alamofire Software Foundation (http://alamofire.org/) |
| 3 | // | |
| 4 | // Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 5 | // of this software and associated documentation files (the "Software"), to deal | |
| 6 | // in the Software without restriction, including without limitation the rights | |
| 7 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 8 | // copies of the Software, and to permit persons to whom the Software is | |
| 9 | // furnished to do so, subject to the following conditions: | |
| 10 | // | |
| 11 | // The above copyright notice and this permission notice shall be included in | |
| 12 | // all copies or substantial portions of the Software. | |
| 13 | // | |
| 14 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 15 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 16 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 17 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 18 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 19 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| 20 | // THE SOFTWARE. | |
| 21 | ||
| 22 | #import <Foundation/Foundation.h> | |
| 23 | ||
| 24 | #import <Availability.h> | |
| 25 | ||
| 26 | #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) | |
| 27 | ||
| 28 | #import <UIKit/UIKit.h> | |
| 29 | ||
| 30 | NS_ASSUME_NONNULL_BEGIN | |
| 31 | ||
| 32 | @class AFHTTPRequestSerializer, AFHTTPResponseSerializer; | |
| 33 | @protocol AFURLRequestSerialization, AFURLResponseSerialization; | |
| 34 | ||
| 35 | /** | |
| 36 | This category adds methods to the UIKit framework's `UIWebView` class. The methods in this category provide increased control over the request cycle, including progress monitoring and success / failure handling. | |
| 37 | ||
| 38 | @discussion When using these category methods, make sure to assign `delegate` for the web view, which implements `–webView:shouldStartLoadWithRequest:navigationType:` appropriately. This allows for tapped links to be loaded through AFNetworking, and can ensure that `canGoBack` & `canGoForward` update their values correctly. | |
| 39 | */ | |
| 40 | @interface UIWebView (AFNetworking) | |
| 41 | ||
| 42 | /** | |
| 43 | The request serializer used to serialize requests made with the `-loadRequest:...` category methods. By default, this is an instance of `AFHTTPRequestSerializer`. | |
| 44 | */ | |
| 45 | @property (nonatomic, strong) AFHTTPRequestSerializer <AFURLRequestSerialization> * requestSerializer; | |
| 46 | ||
| 47 | /** | |
| 48 | The response serializer used to serialize responses made with the `-loadRequest:...` category methods. By default, this is an instance of `AFHTTPResponseSerializer`. | |
| 49 | */ | |
| 50 | @property (nonatomic, strong) AFHTTPResponseSerializer <AFURLResponseSerialization> * responseSerializer; | |
| 51 | ||
| 52 | /** | |
| 53 | Asynchronously loads the specified request. | |
| 54 | ||
| 55 | @param request A URL request identifying the location of the content to load. This must not be `nil`. | |
| 56 | @param progress A block object to be called when an undetermined number of bytes have been downloaded from the server. This block has no return value and takes three arguments: the number of bytes read since the last time the download progress block was called, the total bytes read, and the total bytes expected to be read during the request, as initially determined by the expected content size of the `NSHTTPURLResponse` object. This block may be called multiple times, and will execute on the main thread. | |
| 57 | @param success A block object to be executed when the request finishes loading successfully. This block returns the HTML string to be loaded by the web view, and takes two arguments: the response, and the response string. | |
| 58 | @param failure A block object to be executed when the request operation finishes unsuccessfully, or that finishes successfully, but encountered an error while parsing the response data. This block has no return value and takes a single argument: the error that occurred. | |
| 59 | */ | |
| 60 | - (void)loadRequest:(NSURLRequest *)request | |
| 61 | progress:(nullable void (^)(NSUInteger bytesWritten, long long totalBytesWritten, long long totalBytesExpectedToWrite))progress | |
| 62 | success:(nullable NSString * (^)(NSHTTPURLResponse *response, NSString *HTML))success | |
| 63 | failure:(nullable void (^)(NSError *error))failure; | |
| 64 | ||
| 65 | /** | |
| 66 | Asynchronously loads the data associated with a particular request with a specified MIME type and text encoding. | |
| 67 | ||
| 68 | @param request A URL request identifying the location of the content to load. This must not be `nil`. | |
| 69 | @param MIMEType The MIME type of the content. Defaults to the content type of the response if not specified. | |
| 70 | @param textEncodingName The IANA encoding name, as in `utf-8` or `utf-16`. Defaults to the response text encoding if not specified. | |
| 71 | @param progress A block object to be called when an undetermined number of bytes have been downloaded from the server. This block has no return value and takes three arguments: the number of bytes read since the last time the download progress block was called, the total bytes read, and the total bytes expected to be read during the request, as initially determined by the expected content size of the `NSHTTPURLResponse` object. This block may be called multiple times, and will execute on the main thread. | |
| 72 | @param success A block object to be executed when the request finishes loading successfully. This block returns the data to be loaded by the web view and takes two arguments: the response, and the downloaded data. | |
| 73 | @param failure A block object to be executed when the request operation finishes unsuccessfully, or that finishes successfully, but encountered an error while parsing the response data. This block has no return value and takes a single argument: the error that occurred. | |
| 74 | */ | |
| 75 | - (void)loadRequest:(NSURLRequest *)request | |
| 76 | MIMEType:(nullable NSString *)MIMEType | |
| 77 | textEncodingName:(nullable NSString *)textEncodingName | |
| 78 | progress:(nullable void (^)(NSUInteger bytesWritten, long long totalBytesWritten, long long totalBytesExpectedToWrite))progress | |
| 79 | success:(nullable NSData * (^)(NSHTTPURLResponse *response, NSData *data))success | |
| 80 | failure:(nullable void (^)(NSError *error))failure; | |
| 81 | ||
| 82 | @end | |
| 83 | ||
| 84 | NS_ASSUME_NONNULL_END | |
| 85 | ||
| 86 | #endif | |
