| commit | author | age | ||
| 6e1425 | 1 | // AFURLResponseSerialization.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 | #import <CoreGraphics/CoreGraphics.h> | |
| 24 | ||
| 25 | NS_ASSUME_NONNULL_BEGIN | |
| 26 | ||
| 27 | /** | |
| 28 | The `AFURLResponseSerialization` protocol is adopted by an object that decodes data into a more useful object representation, according to details in the server response. Response serializers may additionally perform validation on the incoming response and data. | |
| 29 | ||
| 30 | For example, a JSON response serializer may check for an acceptable status code (`2XX` range) and content type (`application/json`), decoding a valid JSON response into an object. | |
| 31 | */ | |
| 32 | @protocol AFURLResponseSerialization <NSObject, NSSecureCoding, NSCopying> | |
| 33 | ||
| 34 | /** | |
| 35 | The response object decoded from the data associated with a specified response. | |
| 36 | ||
| 37 | @param response The response to be processed. | |
| 38 | @param data The response data to be decoded. | |
| 39 | @param error The error that occurred while attempting to decode the response data. | |
| 40 | ||
| 41 | @return The object decoded from the specified response data. | |
| 42 | */ | |
| 43 | - (nullable id)responseObjectForResponse:(nullable NSURLResponse *)response | |
| 44 | data:(nullable NSData *)data | |
| 45 | error:(NSError * __nullable __autoreleasing *)error; | |
| 46 | ||
| 47 | @end | |
| 48 | ||
| 49 | #pragma mark - | |
| 50 | ||
| 51 | /** | |
| 52 | `AFHTTPResponseSerializer` conforms to the `AFURLRequestSerialization` & `AFURLResponseSerialization` protocols, offering a concrete base implementation of query string / URL form-encoded parameter serialization and default request headers, as well as response status code and content type validation. | |
| 53 | ||
| 54 | Any request or response serializer dealing with HTTP is encouraged to subclass `AFHTTPResponseSerializer` in order to ensure consistent default behavior. | |
| 55 | */ | |
| 56 | @interface AFHTTPResponseSerializer : NSObject <AFURLResponseSerialization> | |
| 57 | ||
| 58 | - (instancetype)init; | |
| 59 | ||
| 60 | /** | |
| 61 | The string encoding used to serialize data received from the server, when no string encoding is specified by the response. `NSUTF8StringEncoding` by default. | |
| 62 | */ | |
| 63 | @property (nonatomic, assign) NSStringEncoding stringEncoding; | |
| 64 | ||
| 65 | /** | |
| 66 | Creates and returns a serializer with default configuration. | |
| 67 | */ | |
| 68 | + (instancetype)serializer; | |
| 69 | ||
| 70 | ///----------------------------------------- | |
| 71 | /// @name Configuring Response Serialization | |
| 72 | ///----------------------------------------- | |
| 73 | ||
| 74 | /** | |
| 75 | The acceptable HTTP status codes for responses. When non-`nil`, responses with status codes not contained by the set will result in an error during validation. | |
| 76 | ||
| 77 | See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html | |
| 78 | */ | |
| 79 | @property (nonatomic, copy, nullable) NSIndexSet *acceptableStatusCodes; | |
| 80 | ||
| 81 | /** | |
| 82 | The acceptable MIME types for responses. When non-`nil`, responses with a `Content-Type` with MIME types that do not intersect with the set will result in an error during validation. | |
| 83 | */ | |
| 84 | @property (nonatomic, copy, nullable) NSSet *acceptableContentTypes; | |
| 85 | ||
| 86 | /** | |
| 87 | Validates the specified response and data. | |
| 88 | ||
| 89 | In its base implementation, this method checks for an acceptable status code and content type. Subclasses may wish to add other domain-specific checks. | |
| 90 | ||
| 91 | @param response The response to be validated. | |
| 92 | @param data The data associated with the response. | |
| 93 | @param error The error that occurred while attempting to validate the response. | |
| 94 | ||
| 95 | @return `YES` if the response is valid, otherwise `NO`. | |
| 96 | */ | |
| 97 | - (BOOL)validateResponse:(nullable NSHTTPURLResponse *)response | |
| 98 | data:(nullable NSData *)data | |
| 99 | error:(NSError * __nullable __autoreleasing *)error; | |
| 100 | ||
| 101 | @end | |
| 102 | ||
| 103 | #pragma mark - | |
| 104 | ||
| 105 | ||
| 106 | /** | |
| 107 | `AFJSONResponseSerializer` is a subclass of `AFHTTPResponseSerializer` that validates and decodes JSON responses. | |
| 108 | ||
| 109 | By default, `AFJSONResponseSerializer` accepts the following MIME types, which includes the official standard, `application/json`, as well as other commonly-used types: | |
| 110 | ||
| 111 | - `application/json` | |
| 112 | - `text/json` | |
| 113 | - `text/javascript` | |
| 114 | */ | |
| 115 | @interface AFJSONResponseSerializer : AFHTTPResponseSerializer | |
| 116 | ||
| 117 | - (instancetype)init; | |
| 118 | ||
| 119 | /** | |
| 120 | Options for reading the response JSON data and creating the Foundation objects. For possible values, see the `NSJSONSerialization` documentation section "NSJSONReadingOptions". `0` by default. | |
| 121 | */ | |
| 122 | @property (nonatomic, assign) NSJSONReadingOptions readingOptions; | |
| 123 | ||
| 124 | /** | |
| 125 | Whether to remove keys with `NSNull` values from response JSON. Defaults to `NO`. | |
| 126 | */ | |
| 127 | @property (nonatomic, assign) BOOL removesKeysWithNullValues; | |
| 128 | ||
| 129 | /** | |
| 130 | Creates and returns a JSON serializer with specified reading and writing options. | |
| 131 | ||
| 132 | @param readingOptions The specified JSON reading options. | |
| 133 | */ | |
| 134 | + (instancetype)serializerWithReadingOptions:(NSJSONReadingOptions)readingOptions; | |
| 135 | ||
| 136 | @end | |
| 137 | ||
| 138 | #pragma mark - | |
| 139 | ||
| 140 | /** | |
| 141 | `AFXMLParserResponseSerializer` is a subclass of `AFHTTPResponseSerializer` that validates and decodes XML responses as an `NSXMLParser` objects. | |
| 142 | ||
| 143 | By default, `AFXMLParserResponseSerializer` accepts the following MIME types, which includes the official standard, `application/xml`, as well as other commonly-used types: | |
| 144 | ||
| 145 | - `application/xml` | |
| 146 | - `text/xml` | |
| 147 | */ | |
| 148 | @interface AFXMLParserResponseSerializer : AFHTTPResponseSerializer | |
| 149 | ||
| 150 | @end | |
| 151 | ||
| 152 | #pragma mark - | |
| 153 | ||
| 154 | #ifdef __MAC_OS_X_VERSION_MIN_REQUIRED | |
| 155 | ||
| 156 | /** | |
| 157 | `AFXMLDocumentResponseSerializer` is a subclass of `AFHTTPResponseSerializer` that validates and decodes XML responses as an `NSXMLDocument` objects. | |
| 158 | ||
| 159 | By default, `AFXMLDocumentResponseSerializer` accepts the following MIME types, which includes the official standard, `application/xml`, as well as other commonly-used types: | |
| 160 | ||
| 161 | - `application/xml` | |
| 162 | - `text/xml` | |
| 163 | */ | |
| 164 | @interface AFXMLDocumentResponseSerializer : AFHTTPResponseSerializer | |
| 165 | ||
| 166 | - (instancetype)init; | |
| 167 | ||
| 168 | /** | |
| 169 | Input and output options specifically intended for `NSXMLDocument` objects. For possible values, see the `NSJSONSerialization` documentation section "NSJSONReadingOptions". `0` by default. | |
| 170 | */ | |
| 171 | @property (nonatomic, assign) NSUInteger options; | |
| 172 | ||
| 173 | /** | |
| 174 | Creates and returns an XML document serializer with the specified options. | |
| 175 | ||
| 176 | @param mask The XML document options. | |
| 177 | */ | |
| 178 | + (instancetype)serializerWithXMLDocumentOptions:(NSUInteger)mask; | |
| 179 | ||
| 180 | @end | |
| 181 | ||
| 182 | #endif | |
| 183 | ||
| 184 | #pragma mark - | |
| 185 | ||
| 186 | /** | |
| 187 | `AFPropertyListResponseSerializer` is a subclass of `AFHTTPResponseSerializer` that validates and decodes XML responses as an `NSXMLDocument` objects. | |
| 188 | ||
| 189 | By default, `AFPropertyListResponseSerializer` accepts the following MIME types: | |
| 190 | ||
| 191 | - `application/x-plist` | |
| 192 | */ | |
| 193 | @interface AFPropertyListResponseSerializer : AFHTTPResponseSerializer | |
| 194 | ||
| 195 | - (instancetype)init; | |
| 196 | ||
| 197 | /** | |
| 198 | The property list format. Possible values are described in "NSPropertyListFormat". | |
| 199 | */ | |
| 200 | @property (nonatomic, assign) NSPropertyListFormat format; | |
| 201 | ||
| 202 | /** | |
| 203 | The property list reading options. Possible values are described in "NSPropertyListMutabilityOptions." | |
| 204 | */ | |
| 205 | @property (nonatomic, assign) NSPropertyListReadOptions readOptions; | |
| 206 | ||
| 207 | /** | |
| 208 | Creates and returns a property list serializer with a specified format, read options, and write options. | |
| 209 | ||
| 210 | @param format The property list format. | |
| 211 | @param readOptions The property list reading options. | |
| 212 | */ | |
| 213 | + (instancetype)serializerWithFormat:(NSPropertyListFormat)format | |
| 214 | readOptions:(NSPropertyListReadOptions)readOptions; | |
| 215 | ||
| 216 | @end | |
| 217 | ||
| 218 | #pragma mark - | |
| 219 | ||
| 220 | /** | |
| 221 | `AFImageResponseSerializer` is a subclass of `AFHTTPResponseSerializer` that validates and decodes image responses. | |
| 222 | ||
| 223 | By default, `AFImageResponseSerializer` accepts the following MIME types, which correspond to the image formats supported by UIImage or NSImage: | |
| 224 | ||
| 225 | - `image/tiff` | |
| 226 | - `image/jpeg` | |
| 227 | - `image/gif` | |
| 228 | - `image/png` | |
| 229 | - `image/ico` | |
| 230 | - `image/x-icon` | |
| 231 | - `image/bmp` | |
| 232 | - `image/x-bmp` | |
| 233 | - `image/x-xbitmap` | |
| 234 | - `image/x-win-bitmap` | |
| 235 | */ | |
| 236 | @interface AFImageResponseSerializer : AFHTTPResponseSerializer | |
| 237 | ||
| 238 | #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) | |
| 239 | /** | |
| 240 | The scale factor used when interpreting the image data to construct `responseImage`. Specifying a scale factor of 1.0 results in an image whose size matches the pixel-based dimensions of the image. Applying a different scale factor changes the size of the image as reported by the size property. This is set to the value of scale of the main screen by default, which automatically scales images for retina displays, for instance. | |
| 241 | */ | |
| 242 | @property (nonatomic, assign) CGFloat imageScale; | |
| 243 | ||
| 244 | /** | |
| 245 | Whether to automatically inflate response image data for compressed formats (such as PNG or JPEG). Enabling this can significantly improve drawing performance on iOS when used with `setCompletionBlockWithSuccess:failure:`, as it allows a bitmap representation to be constructed in the background rather than on the main thread. `YES` by default. | |
| 246 | */ | |
| 247 | @property (nonatomic, assign) BOOL automaticallyInflatesResponseImage; | |
| 248 | #endif | |
| 249 | ||
| 250 | @end | |
| 251 | ||
| 252 | #pragma mark - | |
| 253 | ||
| 254 | /** | |
| 255 | `AFCompoundSerializer` is a subclass of `AFHTTPResponseSerializer` that delegates the response serialization to the first `AFHTTPResponseSerializer` object that returns an object for `responseObjectForResponse:data:error:`, falling back on the default behavior of `AFHTTPResponseSerializer`. This is useful for supporting multiple potential types and structures of server responses with a single serializer. | |
| 256 | */ | |
| 257 | @interface AFCompoundResponseSerializer : AFHTTPResponseSerializer | |
| 258 | ||
| 259 | /** | |
| 260 | The component response serializers. | |
| 261 | */ | |
| 262 | @property (readonly, nonatomic, copy) NSArray *responseSerializers; | |
| 263 | ||
| 264 | /** | |
| 265 | Creates and returns a compound serializer comprised of the specified response serializers. | |
| 266 | ||
| 267 | @warning Each response serializer specified must be a subclass of `AFHTTPResponseSerializer`, and response to `-validateResponse:data:error:`. | |
| 268 | */ | |
| 269 | + (instancetype)compoundSerializerWithResponseSerializers:(NSArray *)responseSerializers; | |
| 270 | ||
| 271 | @end | |
| 272 | ||
| 273 | ///---------------- | |
| 274 | /// @name Constants | |
| 275 | ///---------------- | |
| 276 | ||
| 277 | /** | |
| 278 | ## Error Domains | |
| 279 | ||
| 280 | The following error domain is predefined. | |
| 281 | ||
| 282 | - `NSString * const AFURLResponseSerializationErrorDomain` | |
| 283 | ||
| 284 | ### Constants | |
| 285 | ||
| 286 | `AFURLResponseSerializationErrorDomain` | |
| 287 | AFURLResponseSerializer errors. Error codes for `AFURLResponseSerializationErrorDomain` correspond to codes in `NSURLErrorDomain`. | |
| 288 | */ | |
| 289 | extern NSString * const AFURLResponseSerializationErrorDomain; | |
| 290 | ||
| 291 | /** | |
| 292 | ## User info dictionary keys | |
| 293 | ||
| 294 | These keys may exist in the user info dictionary, in addition to those defined for NSError. | |
| 295 | ||
| 296 | - `NSString * const AFNetworkingOperationFailingURLResponseErrorKey` | |
| 297 | - `NSString * const AFNetworkingOperationFailingURLResponseDataErrorKey` | |
| 298 | ||
| 299 | ### Constants | |
| 300 | ||
| 301 | `AFNetworkingOperationFailingURLResponseErrorKey` | |
| 302 | The corresponding value is an `NSURLResponse` containing the response of the operation associated with an error. This key is only present in the `AFURLResponseSerializationErrorDomain`. | |
| 303 | ||
| 304 | `AFNetworkingOperationFailingURLResponseDataErrorKey` | |
| 305 | The corresponding value is an `NSData` containing the original data of the operation associated with an error. This key is only present in the `AFURLResponseSerializationErrorDomain`. | |
| 306 | */ | |
| 307 | extern NSString * const AFNetworkingOperationFailingURLResponseErrorKey; | |
| 308 | ||
| 309 | extern NSString * const AFNetworkingOperationFailingURLResponseDataErrorKey; | |
| 310 | ||
| 311 | NS_ASSUME_NONNULL_END | |
