lipengwei
2020-01-13 01b433018ffe1577fcd2684437116bac5c8ae4a3
commit | author | age
6e1425 1 // UIWebView+AFNetworking.h
633752 2 // Copyright (c) 2011–2016 Alamofire Software Foundation ( http://alamofire.org/ )
6e1425 3 //
H 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
633752 24 #import <TargetConditionals.h>
6e1425 25
633752 26 #if TARGET_OS_IOS
6e1425 27
H 28 #import <UIKit/UIKit.h>
29
30 NS_ASSUME_NONNULL_BEGIN
31
633752 32 @class AFHTTPSessionManager;
6e1425 33
H 34 /**
35  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.
36
37  @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.
38  */
39 @interface UIWebView (AFNetworking)
40
41 /**
633752 42  The session manager used to download all requests.
6e1425 43  */
633752 44 @property (nonatomic, strong) AFHTTPSessionManager *sessionManager;
6e1425 45
H 46 /**
47  Asynchronously loads the specified request.
48
49  @param request A URL request identifying the location of the content to load. This must not be `nil`.
633752 50  @param progress A progress object monitoring the current download progress.
6e1425 51  @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.
633752 52  @param failure A block object to be executed when the data task 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.
6e1425 53  */
H 54 - (void)loadRequest:(NSURLRequest *)request
633752 55            progress:(NSProgress * _Nullable __autoreleasing * _Nullable)progress
6e1425 56             success:(nullable NSString * (^)(NSHTTPURLResponse *response, NSString *HTML))success
H 57             failure:(nullable void (^)(NSError *error))failure;
58
59 /**
60  Asynchronously loads the data associated with a particular request with a specified MIME type and text encoding.
61
62  @param request A URL request identifying the location of the content to load. This must not be `nil`.
63  @param MIMEType The MIME type of the content. Defaults to the content type of the response if not specified.
64  @param textEncodingName The IANA encoding name, as in `utf-8` or `utf-16`. Defaults to the response text encoding if not specified.
633752 65 @param progress A progress object monitoring the current download progress.
6e1425 66  @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.
633752 67  @param failure A block object to be executed when the data task 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.
6e1425 68  */
H 69 - (void)loadRequest:(NSURLRequest *)request
70            MIMEType:(nullable NSString *)MIMEType
71    textEncodingName:(nullable NSString *)textEncodingName
633752 72            progress:(NSProgress * _Nullable __autoreleasing * _Nullable)progress
6e1425 73             success:(nullable NSData * (^)(NSHTTPURLResponse *response, NSData *data))success
H 74             failure:(nullable void (^)(NSError *error))failure;
75
76 @end
77
78 NS_ASSUME_NONNULL_END
79
80 #endif