| commit | author | age | ||
| 6e1425 | 1 | // AFHTTPSessionManager.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 | #if !TARGET_OS_WATCH | |
| 24 | #import <SystemConfiguration/SystemConfiguration.h> | |
| 25 | #endif | |
| 633752 | 26 | #import <TargetConditionals.h> |
| 6e1425 | 27 | |
| H | 28 | #import "AFURLSessionManager.h" |
| 29 | ||
| 30 | /** | |
| 31 | `AFHTTPSessionManager` is a subclass of `AFURLSessionManager` with convenience methods for making HTTP requests. When a `baseURL` is provided, requests made with the `GET` / `POST` / et al. convenience methods can be made with relative paths. | |
| 32 | ||
| 33 | ## Subclassing Notes | |
| 34 | ||
| 35 | Developers targeting iOS 7 or Mac OS X 10.9 or later that deal extensively with a web service are encouraged to subclass `AFHTTPSessionManager`, providing a class method that returns a shared singleton object on which authentication and other configuration can be shared across the application. | |
| 36 | ||
| 37 | ## Methods to Override | |
| 38 | ||
| 633752 | 39 | To change the behavior of all data task operation construction, which is also used in the `GET` / `POST` / et al. convenience methods, override `dataTaskWithRequest:uploadProgress:downloadProgress:completionHandler:`. |
| 6e1425 | 40 | |
| H | 41 | ## Serialization |
| 42 | ||
| 43 | Requests created by an HTTP client will contain default headers and encode parameters according to the `requestSerializer` property, which is an object conforming to `<AFURLRequestSerialization>`. | |
| 44 | ||
| 45 | Responses received from the server are automatically validated and serialized by the `responseSerializers` property, which is an object conforming to `<AFURLResponseSerialization>` | |
| 46 | ||
| 47 | ## URL Construction Using Relative Paths | |
| 48 | ||
| 49 | For HTTP convenience methods, the request serializer constructs URLs from the path relative to the `-baseURL`, using `NSURL +URLWithString:relativeToURL:`, when provided. If `baseURL` is `nil`, `path` needs to resolve to a valid `NSURL` object using `NSURL +URLWithString:`. | |
| 50 | ||
| 51 | Below are a few examples of how `baseURL` and relative paths interact: | |
| 52 | ||
| 53 | NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"]; | |
| 54 | [NSURL URLWithString:@"foo" relativeToURL:baseURL]; // http://example.com/v1/foo | |
| 55 | [NSURL URLWithString:@"foo?bar=baz" relativeToURL:baseURL]; // http://example.com/v1/foo?bar=baz | |
| 56 | [NSURL URLWithString:@"/foo" relativeToURL:baseURL]; // http://example.com/foo | |
| 57 | [NSURL URLWithString:@"foo/" relativeToURL:baseURL]; // http://example.com/v1/foo | |
| 58 | [NSURL URLWithString:@"/foo/" relativeToURL:baseURL]; // http://example.com/foo/ | |
| 59 | [NSURL URLWithString:@"http://example2.com/" relativeToURL:baseURL]; // http://example2.com/ | |
| 60 | ||
| 61 | Also important to note is that a trailing slash will be added to any `baseURL` without one. This would otherwise cause unexpected behavior when constructing URLs using paths without a leading slash. | |
| 62 | ||
| 63 | @warning Managers for background sessions must be owned for the duration of their use. This can be accomplished by creating an application-wide or shared singleton instance. | |
| 64 | */ | |
| 65 | ||
| 66 | NS_ASSUME_NONNULL_BEGIN | |
| 67 | ||
| 68 | @interface AFHTTPSessionManager : AFURLSessionManager <NSSecureCoding, NSCopying> | |
| 69 | ||
| 70 | /** | |
| 71 | The URL used to construct requests from relative paths in methods like `requestWithMethod:URLString:parameters:`, and the `GET` / `POST` / et al. convenience methods. | |
| 72 | */ | |
| 73 | @property (readonly, nonatomic, strong, nullable) NSURL *baseURL; | |
| 74 | ||
| 75 | /** | |
| 76 | Requests created with `requestWithMethod:URLString:parameters:` & `multipartFormRequestWithMethod:URLString:parameters:constructingBodyWithBlock:` are constructed with a set of default headers using a parameter serialization specified by this property. By default, this is set to an instance of `AFHTTPRequestSerializer`, which serializes query string parameters for `GET`, `HEAD`, and `DELETE` requests, or otherwise URL-form-encodes HTTP message bodies. | |
| 77 | ||
| 78 | @warning `requestSerializer` must not be `nil`. | |
| 79 | */ | |
| 80 | @property (nonatomic, strong) AFHTTPRequestSerializer <AFURLRequestSerialization> * requestSerializer; | |
| 81 | ||
| 82 | /** | |
| 83 | Responses sent from the server in data tasks created with `dataTaskWithRequest:success:failure:` and run using the `GET` / `POST` / et al. convenience methods are automatically validated and serialized by the response serializer. By default, this property is set to an instance of `AFJSONResponseSerializer`. | |
| 84 | ||
| 85 | @warning `responseSerializer` must not be `nil`. | |
| 86 | */ | |
| 87 | @property (nonatomic, strong) AFHTTPResponseSerializer <AFURLResponseSerialization> * responseSerializer; | |
| 633752 | 88 | |
| L | 89 | ///------------------------------- |
| 90 | /// @name Managing Security Policy | |
| 91 | ///------------------------------- | |
| 92 | ||
| 93 | /** | |
| 94 | The security policy used by created session to evaluate server trust for secure connections. `AFURLSessionManager` uses the `defaultPolicy` unless otherwise specified. A security policy configured with `AFSSLPinningModePublicKey` or `AFSSLPinningModeCertificate` can only be applied on a session manager initialized with a secure base URL (i.e. https). Applying a security policy with pinning enabled on an insecure session manager throws an `Invalid Security Policy` exception. | |
| 95 | */ | |
| 96 | @property (nonatomic, strong) AFSecurityPolicy *securityPolicy; | |
| 6e1425 | 97 | |
| H | 98 | ///--------------------- |
| 99 | /// @name Initialization | |
| 100 | ///--------------------- | |
| 101 | ||
| 102 | /** | |
| 103 | Creates and returns an `AFHTTPSessionManager` object. | |
| 104 | */ | |
| 105 | + (instancetype)manager; | |
| 106 | ||
| 107 | /** | |
| 108 | Initializes an `AFHTTPSessionManager` object with the specified base URL. | |
| 109 | ||
| 110 | @param url The base URL for the HTTP client. | |
| 111 | ||
| 112 | @return The newly-initialized HTTP client | |
| 113 | */ | |
| 114 | - (instancetype)initWithBaseURL:(nullable NSURL *)url; | |
| 115 | ||
| 116 | /** | |
| 117 | Initializes an `AFHTTPSessionManager` object with the specified base URL. | |
| 118 | ||
| 119 | This is the designated initializer. | |
| 120 | ||
| 121 | @param url The base URL for the HTTP client. | |
| 122 | @param configuration The configuration used to create the managed session. | |
| 123 | ||
| 124 | @return The newly-initialized HTTP client | |
| 125 | */ | |
| 126 | - (instancetype)initWithBaseURL:(nullable NSURL *)url | |
| 127 | sessionConfiguration:(nullable NSURLSessionConfiguration *)configuration NS_DESIGNATED_INITIALIZER; | |
| 128 | ||
| 129 | ///--------------------------- | |
| 130 | /// @name Making HTTP Requests | |
| 131 | ///--------------------------- | |
| 132 | ||
| 133 | /** | |
| 134 | Creates and runs an `NSURLSessionDataTask` with a `GET` request. | |
| 633752 | 135 | |
| L | 136 | @param URLString The URL string used to create the request URL. |
| 137 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 138 | @param headers The headers appended to the default headers for this request. | |
| 139 | @param downloadProgress A block object to be executed when the download progress is updated. Note this block is called on the session queue, not the main queue. | |
| 140 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 141 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 142 | ||
| 143 | @see -dataTaskWithRequest:uploadProgress:downloadProgress:completionHandler: | |
| 144 | */ | |
| 145 | - (nullable NSURLSessionDataTask *)GET:(NSString *)URLString | |
| 146 | parameters:(nullable id)parameters | |
| 147 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 148 | progress:(nullable void (^)(NSProgress *downloadProgress))downloadProgress | |
| 149 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 150 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 151 | ||
| 152 | /** | |
| 153 | Creates and runs an `NSURLSessionDataTask` with a `HEAD` request. | |
| 154 | ||
| 155 | @param URLString The URL string used to create the request URL. | |
| 156 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 157 | @param headers The headers appended to the default headers for this request. | |
| 158 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes a single arguments: the data task. | |
| 159 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 160 | ||
| 161 | @see -dataTaskWithRequest:completionHandler: | |
| 162 | */ | |
| 163 | - (nullable NSURLSessionDataTask *)HEAD:(NSString *)URLString | |
| 164 | parameters:(nullable id)parameters | |
| 165 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 166 | success:(nullable void (^)(NSURLSessionDataTask *task))success | |
| 167 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 6e1425 | 168 | |
| H | 169 | /** |
| 170 | Creates and runs an `NSURLSessionDataTask` with a `POST` request. | |
| 633752 | 171 | |
| L | 172 | @param URLString The URL string used to create the request URL. |
| 173 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 174 | @param headers The headers appended to the default headers for this request. | |
| 175 | @param uploadProgress A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue. | |
| 176 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 177 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 178 | ||
| 179 | @see -dataTaskWithRequest:uploadProgress:downloadProgress:completionHandler: | |
| 180 | */ | |
| 181 | - (nullable NSURLSessionDataTask *)POST:(NSString *)URLString | |
| 182 | parameters:(nullable id)parameters | |
| 183 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 184 | progress:(nullable void (^)(NSProgress *uploadProgress))uploadProgress | |
| 185 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 186 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 6e1425 | 187 | |
| 633752 | 188 | /** |
| L | 189 | Creates and runs an `NSURLSessionDataTask` with a multipart `POST` request. |
| 190 | ||
| 191 | @param URLString The URL string used to create the request URL. | |
| 192 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 193 | @param headers The headers appended to the default headers for this request. | |
| 194 | @param block A block that takes a single argument and appends data to the HTTP body. The block argument is an object adopting the `AFMultipartFormData` protocol. | |
| 195 | @param uploadProgress A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue. | |
| 196 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 197 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 198 | ||
| 199 | @see -dataTaskWithRequest:uploadProgress:downloadProgress:completionHandler: | |
| 200 | */ | |
| 201 | - (nullable NSURLSessionDataTask *)POST:(NSString *)URLString | |
| 202 | parameters:(nullable id)parameters | |
| 203 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 204 | constructingBodyWithBlock:(nullable void (^)(id <AFMultipartFormData> formData))block | |
| 205 | progress:(nullable void (^)(NSProgress *uploadProgress))uploadProgress | |
| 206 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 207 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 208 | ||
| 209 | /** | |
| 210 | Creates and runs an `NSURLSessionDataTask` with a `PUT` request. | |
| 211 | ||
| 212 | @param URLString The URL string used to create the request URL. | |
| 213 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 214 | @param headers The headers appended to the default headers for this request. | |
| 215 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 216 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 217 | ||
| 218 | @see -dataTaskWithRequest:completionHandler: | |
| 219 | */ | |
| 220 | - (nullable NSURLSessionDataTask *)PUT:(NSString *)URLString | |
| 221 | parameters:(nullable id)parameters | |
| 222 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 223 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 224 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 6e1425 | 225 | |
| H | 226 | /** |
| 227 | Creates and runs an `NSURLSessionDataTask` with a `PATCH` request. | |
| 633752 | 228 | |
| L | 229 | @param URLString The URL string used to create the request URL. |
| 230 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 231 | @param headers The headers appended to the default headers for this request. | |
| 232 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 233 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 234 | ||
| 235 | @see -dataTaskWithRequest:completionHandler: | |
| 236 | */ | |
| 237 | - (nullable NSURLSessionDataTask *)PATCH:(NSString *)URLString | |
| 238 | parameters:(nullable id)parameters | |
| 239 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 240 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 241 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 6e1425 | 242 | |
| H | 243 | /** |
| 244 | Creates and runs an `NSURLSessionDataTask` with a `DELETE` request. | |
| 633752 | 245 | |
| L | 246 | @param URLString The URL string used to create the request URL. |
| 247 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 248 | @param headers The headers appended to the default headers for this request. | |
| 249 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 250 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 251 | ||
| 252 | @see -dataTaskWithRequest:completionHandler: | |
| 253 | */ | |
| 254 | - (nullable NSURLSessionDataTask *)DELETE:(NSString *)URLString | |
| 255 | parameters:(nullable id)parameters | |
| 256 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 257 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 258 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 6e1425 | 259 | |
| bf3f86 | 260 | /** |
| L | 261 | Creates an `NSURLSessionDataTask` with a custom `HTTPMethod` request. |
| 262 | ||
| 263 | @param method The HTTPMethod string used to create the request. | |
| 264 | @param URLString The URL string used to create the request URL. | |
| 265 | @param parameters The parameters to be encoded according to the client request serializer. | |
| 266 | @param headers The headers appended to the default headers for this request. | |
| 267 | @param uploadProgress A block object to be executed when the upload progress is updated. Note this block is called on the session queue, not the main queue. | |
| 268 | @param downloadProgress A block object to be executed when the download progress is updated. Note this block is called on the session queue, not the main queue. | |
| 269 | @param success A block object to be executed when the task finishes successfully. This block has no return value and takes two arguments: the data task, and the response object created by the client response serializer. | |
| 270 | @param failure A block object to be executed when the 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 two arguments: the data task and the error describing the network or parsing error that occurred. | |
| 271 | ||
| 272 | @see -dataTaskWithRequest:uploadProgress:downloadProgress:completionHandler: | |
| 273 | */ | |
| 274 | - (nullable NSURLSessionDataTask *)dataTaskWithHTTPMethod:(NSString *)method | |
| 275 | URLString:(NSString *)URLString | |
| 276 | parameters:(nullable id)parameters | |
| 277 | headers:(nullable NSDictionary <NSString *, NSString *> *)headers | |
| 278 | uploadProgress:(nullable void (^)(NSProgress *uploadProgress))uploadProgress | |
| 279 | downloadProgress:(nullable void (^)(NSProgress *downloadProgress))downloadProgress | |
| 280 | success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success | |
| 281 | failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure; | |
| 282 | ||
| 6e1425 | 283 | @end |
| H | 284 | |
| 285 | NS_ASSUME_NONNULL_END | |
