AFPropertyListRequestOperation Class Reference
| Inherits from | AFHTTPRequestOperation : AFURLConnectionOperation : NSOperation |
| Declared in | AFPropertyListRequestOperation.h AFPropertyListRequestOperation.m |
Overview
AFPropertyListRequestOperation is a subclass of AFHTTPRequestOperation for downloading and deserializing objects with property list (plist) response data.
Acceptable Content Types
By default, AFPropertyListRequestOperation accepts the following MIME types:
application/x-plist
Tasks
Getting Response Data
-
responsePropertyListAn object deserialized from a plist constructed using the response data.
property
Managing Property List Behavior
-
propertyListReadOptionsOne of the
propertyNSPropertyListMutabilityOptionsoptions, specifying the mutability of objects deserialized from the property list. By default, this isNSPropertyListImmutable. -
+ propertyListRequestOperationWithRequest:success:failure:Creates and returns an
AFPropertyListRequestOperationobject and sets the specified success and failure callbacks.
Other Methods
-
– initWithRequest:Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.
-
– error -
+ acceptableContentTypesReturns an
NSSetobject containing the acceptable MIME types. When non-nil, the operation will set theerrorproperty to an error inAFErrorDomain. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 -
+ canProcessRequest:A Boolean value determining whether or not the class can process the specified request. For example,
AFJSONRequestOperationmay check to make sure the content type wasapplication/jsonor the URL path extension was.json. -
– setCompletionBlockWithSuccess:failure:Sets the
completionBlockproperty with a block that executes either the specified success or failure block, depending on the state of the request on completion. Iferrorreturns a value, which can be caused by an unacceptable status code or content type, thenfailureis executed. Otherwise,successis executed.
Properties
propertyListReadOptions
One of the NSPropertyListMutabilityOptions options, specifying the mutability of objects deserialized from the property list. By default, this is NSPropertyListImmutable.
@property (nonatomic, assign) NSPropertyListReadOptions propertyListReadOptionsDiscussion
One of the NSPropertyListMutabilityOptions options, specifying the mutability of objects deserialized from the property list. By default, this is NSPropertyListImmutable.
Declared In
AFPropertyListRequestOperation.hClass Methods
acceptableContentTypes
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
+ (NSSet *)acceptableContentTypesDiscussion
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.
Declared In
AFHTTPRequestOperation.hcanProcessRequest:
A Boolean value determining whether or not the class can process the specified request. For example, AFJSONRequestOperation may check to make sure the content type was application/json or the URL path extension was .json.
+ (BOOL)canProcessRequest:(NSURLRequest *)requestParameters
- urlRequest
The request that is determined to be supported or not supported for this class.
Discussion
A Boolean value determining whether or not the class can process the specified request. For example, AFJSONRequestOperation may check to make sure the content type was application/json or the URL path extension was .json.
Declared In
AFHTTPRequestOperation.hpropertyListRequestOperationWithRequest:success:failure:
Creates and returns an AFPropertyListRequestOperation object and sets the specified success and failure callbacks.
+ (AFPropertyListRequestOperation *)propertyListRequestOperationWithRequest:(NSURLRequest *)urlRequest success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , id propertyList ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error , id propertyList ))failureParameters
- urlRequest
The request object to be loaded asynchronously during execution of the operation
- success
A block object to be executed when the operation finishes successfully. This block has no return value and takes three arguments: the request sent from the client, the response received from the server, and the object deserialized from a plist constructed using the response data.
- failure
A block object to be executed when the operation finishes unsuccessfully, or that finishes successfully, but encountered an error while deserializing the object from a property list. This block has no return value and takes three arguments: the request sent from the client, the response received from the server, and the error describing the network or parsing error that occurred.
Return Value
A new property list request operation
Discussion
Creates and returns an AFPropertyListRequestOperation object and sets the specified success and failure callbacks.
Declared In
AFPropertyListRequestOperation.hInstance Methods
initWithRequest:
Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.
- (id)initWithRequest:(NSURLRequest *)urlRequestParameters
- urlRequest
The request object to be used by the operation connection.
@discussion This is the designated initializer.
Discussion
Initializes and returns a newly allocated operation object with a url connection configured with the specified url request.
Declared In
AFURLConnectionOperation.hsetCompletionBlockWithSuccess:failure:
Sets the completionBlock property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If error returns a value, which can be caused by an unacceptable status code or content type, then failure is executed. Otherwise, success is executed.
- (void)setCompletionBlockWithSuccess:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))success failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failureParameters
- success
The block to be executed on the completion of a successful request. This block has no return value and takes two arguments: the receiver operation and the object constructed from the response data of the request.
- failure
The block to be executed on the completion of an unsuccessful request. This block has no return value and takes two arguments: the receiver operation and the error that occurred during the request.
@discussion This method should be overridden in subclasses in order to specify the response object passed into the success block.
Discussion
Sets the completionBlock property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If error returns a value, which can be caused by an unacceptable status code or content type, then failure is executed. Otherwise, success is executed.
Declared In
AFHTTPRequestOperation.h