Adding notes in documentation about JSON libraries necessary for decoding responses in AFJSONRequestOperation and encoding requests in AFHTTPClient

This commit is contained in:
Mattt Thompson 2012-03-20 10:23:57 -07:00
parent c1205689ce
commit c198eaf251
2 changed files with 4 additions and 0 deletions

View file

@ -139,6 +139,8 @@ extern NSString * AFQueryStringFromParametersWithEncoding(NSDictionary *paramete
/**
The `AFHTTPClientParameterEncoding` value corresponding to how parameters are encoded into a request body. This is `AFFormURLParameterEncoding` by default.
@warning JSON encoding will automatically use JSONKit, SBJSON, YAJL, or NextiveJSON, if provided. Otherwise, the built-in `NSJSONSerialization` class is used, if available (iOS 5.0 and Mac OS 10.7). If the build target does not either support `NSJSONSerialization` or include a third-party JSON library, a runtime exception will be thrown when attempting to encode parameters as JSON.
*/
@property (nonatomic, assign) AFHTTPClientParameterEncoding parameterEncoding;

View file

@ -32,6 +32,8 @@
- `application/json`
- `text/json`
@warning JSON parsing will automatically use JSONKit, SBJSON, YAJL, or NextiveJSON, if provided. Otherwise, the built-in `NSJSONSerialization` class is used, if available (iOS 5.0 and Mac OS 10.7). If the build target does not either support `NSJSONSerialization` or include a third-party JSON library, a runtime exception will be thrown when attempting to parse a JSON request.
*/
@interface AFJSONRequestOperation : AFHTTPRequestOperation {
@private