75 lines
3.3 KiB
Objective-C
75 lines
3.3 KiB
Objective-C
// AFHTTPOperation.h
|
|
//
|
|
// Copyright (c) 2011 Gowalla (http://gowalla.com/)
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
#import <Foundation/Foundation.h>
|
|
#import "AFURLConnectionOperation.h"
|
|
#import "AFHTTPClient.h"
|
|
|
|
/**
|
|
`AFHTTPRequestOperation` is a subclass of `AFURLConnectionOperation` for requests using the HTTP or HTTPS protocols. It encapsulates the concept of acceptable status codes and content types, which determine the success or failure of a request.
|
|
*/
|
|
@interface AFHTTPRequestOperation : AFURLConnectionOperation <AFHTTPClientOperation> {
|
|
@private
|
|
NSIndexSet *_acceptableStatusCodes;
|
|
NSSet *_acceptableContentTypes;
|
|
NSError *_HTTPError;
|
|
}
|
|
|
|
///----------------------------------------------
|
|
/// @name Getting HTTP URL Connection Information
|
|
///----------------------------------------------
|
|
|
|
/**
|
|
The last HTTP response received by the operation's connection.
|
|
*/
|
|
@property (readonly, nonatomic, retain) NSHTTPURLResponse *response;
|
|
|
|
|
|
///----------------------------------------------------------
|
|
/// @name Managing And Checking For Acceptable HTTP Responses
|
|
///----------------------------------------------------------
|
|
|
|
/**
|
|
Returns an `NSIndexSet` object containing the ranges of acceptable HTTP status codes. When non-`nil`, the operation will set the `error` property to an error in `AFErrorDomain`. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
|
|
|
|
By default, this is the range 200 to 299, inclusive.
|
|
*/
|
|
@property (nonatomic, retain) NSIndexSet *acceptableStatusCodes;
|
|
|
|
/**
|
|
A Boolean value that corresponds to whether the status code of the response is within the specified set of acceptable status codes. Returns `YES` if `acceptableStatusCodes` is `nil`.
|
|
*/
|
|
@property (readonly) BOOL hasAcceptableStatusCode;
|
|
|
|
/**
|
|
Returns an `NSSet` object containing the acceptable MIME types. When non-`nil`, the operation will set the `error` property to an error in `AFErrorDomain`. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
|
|
|
|
By default, this is `nil`.
|
|
*/
|
|
@property (nonatomic, retain) NSSet *acceptableContentTypes;
|
|
|
|
/**
|
|
A Boolean value that corresponds to whether the MIME type of the response is among the specified set of acceptable content types. Returns `YES` if `acceptableContentTypes` is `nil`.
|
|
*/
|
|
@property (readonly) BOOL hasAcceptableContentType;
|
|
|
|
@end
|