AFXMLRequestOperation Class Reference
Inherits from | AFHTTPRequestOperation : AFURLConnectionOperation : NSOperation |
Declared in | AFXMLRequestOperation.h |
Overview
AFXMLRequestOperation
is a subclass of AFHTTPRequestOperation
for downloading and working with XML response data.
Acceptable Content Types
By default, AFXMLRequestOperation
accepts the following MIME types, which includes the official standard, application/xml
, as well as other commonly-used types:
application/xml
text/xml
Use With AFHTTPClient
When AFXMLRequestOperation
is registered with AFHTTPClient
, the response object in the success callback of HTTPRequestOperationWithRequest:success:failure:
will be an instance of NSXMLParser
. On platforms that support NSXMLDocument
, you have the option to ignore the response object, and simply use the responseXMLDocument
property of the operation argument of the callback.
Tasks
Getting Response Data
-
responseXMLParser
An
propertyNSXMLParser
object constructed from the response data. -
responseXMLDocument
An
propertyNSXMLDocument
object constructed from the response data. If an error occurs while parsing,nil
will be returned, and theerror
property will be set to the error. -
+ XMLParserRequestOperationWithRequest:success:failure:
Creates and returns an
AFXMLRequestOperation
object and sets the specified success and failure callbacks. -
+ XMLDocumentRequestOperationWithRequest:success:failure:
Creates and returns an
AFXMLRequestOperation
object and sets the specified success and failure callbacks.
Properties
responseXMLDocument
An NSXMLDocument
object constructed from the response data. If an error occurs while parsing, nil
will be returned, and the error
property will be set to the error.
@property (readonly, nonatomic, strong) NSXMLDocument *responseXMLDocument
Discussion
An NSXMLDocument
object constructed from the response data. If an error occurs while parsing, nil
will be returned, and the error
property will be set to the error.
Declared In
AFXMLRequestOperation.h
Class Methods
XMLDocumentRequestOperationWithRequest:success:failure:
Creates and returns an AFXMLRequestOperation
object and sets the specified success and failure callbacks.
+ (instancetype)XMLDocumentRequestOperationWithRequest:(NSURLRequest *)urlRequest success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSXMLDocument *document ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error , NSXMLDocument *document ))failure
Parameters
- 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 XML document created from the response data of request.
- failure
A block object to be executed when the operation finishes unsuccessfully, or that finishes successfully, but encountered an error while parsing the response data as XML. 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 XML request operation
Discussion
Creates and returns an AFXMLRequestOperation
object and sets the specified success and failure callbacks.
Declared In
AFXMLRequestOperation.h
XMLParserRequestOperationWithRequest:success:failure:
Creates and returns an AFXMLRequestOperation
object and sets the specified success and failure callbacks.
+ (instancetype)XMLParserRequestOperationWithRequest:(NSURLRequest *)urlRequest success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSXMLParser *XMLParser ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error , NSXMLParser *XMLParser ))failure
Parameters
- 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 XML parser constructed with the response data of request.
- failure
A block object to be executed when the operation finishes unsuccessfully. 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 error that occurred.
Return Value
A new XML request operation
Discussion
Creates and returns an AFXMLRequestOperation
object and sets the specified success and failure callbacks.
Declared In
AFXMLRequestOperation.h