Inherits from AFHTTPRequestOperation : AFURLConnectionOperation : NSOperation
Declared in AFJSONRequestOperation.h

Overview

AFJSONRequestOperation is a subclass of AFHTTPRequestOperation for downloading and working with JSON response data.

Acceptable Content Types

By default, AFJSONRequestOperation accepts the following MIME types, which includes the official standard, application/json, as well as other commonly-used types:

  • application/json
  • text/json

Warning: JSON parsing will use the built-in NSJSONSerialization class.

Tasks

Getting Response Data

  •   responseJSON

    A JSON 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
  •   JSONReadingOptions

    Options for reading the response JSON data and creating the Foundation objects. For possible values, see the NSJSONSerialization documentation section “NSJSONReadingOptions”.

    property

Creating Request Operations

Properties

JSONReadingOptions

Options for reading the response JSON data and creating the Foundation objects. For possible values, see the NSJSONSerialization documentation section “NSJSONReadingOptions”.

@property (nonatomic, assign) NSJSONReadingOptions JSONReadingOptions

Discussion

Options for reading the response JSON data and creating the Foundation objects. For possible values, see the NSJSONSerialization documentation section “NSJSONReadingOptions”.

Declared In

AFJSONRequestOperation.h

responseJSON

A JSON 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) id responseJSON

Discussion

A JSON 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

AFJSONRequestOperation.h

Class Methods

JSONRequestOperationWithRequest:success:failure:

Creates and returns an AFJSONRequestOperation object and sets the specified success and failure callbacks.

+ (instancetype)JSONRequestOperationWithRequest:(NSURLRequest *)urlRequest success:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , id JSON ))success failure:(void ( ^ ) ( NSURLRequest *request , NSHTTPURLResponse *response , NSError *error , id JSON ))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 JSON object 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 JSON. 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 JSON request operation

Discussion

Creates and returns an AFJSONRequestOperation object and sets the specified success and failure callbacks.

Declared In

AFJSONRequestOperation.h