Skip to content
Browse files

Updating documentation for 1.0.1

  • Loading branch information...
1 parent e297d30 commit f3cc146058000ad6459b2894128eef35068d010a @mattt mattt committed Nov 15, 2012
View
14 Categories/UIImageView+AFNetworking.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -112,7 +112,7 @@ <h1 class="title title-header">UIImageView(AFNetworking) Category Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">UIImageView+AFNetworking.h</td>
+ <td class="specification-value">UIImageView+AFNetworking.h<br />UIImageView+AFNetworking.m</td>
</tr>
</tbody></table></div>
@@ -260,7 +260,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<h4 class="method-subtitle">Discussion</h4>
<p>Creates and enqueues an image request operation, which asynchronously downloads the image from the specified URL, and sets it the request is finished. Any previous image request for the receiver will be cancelled. If the image is cached locally, the image is set immediately, otherwise the specified placeholder image will be set immediately, and then the remote image will be set once the request is finished.</p>
-<p>@discussion By default, URL requests have a cache policy of <code>NSURLCacheStorageAllowed</code> and a timeout interval of 30 seconds, and are set to use HTTP pipelining, and not handle cookies. To configure URL requests differently, use <a href="#//api/name/setImageWithURLRequest:placeholderImage:success:failure:"><code>setImageWithURLRequest:placeholderImage:success:failure:</code></a></p>
+<p>@discussion By default, URL requests have a cache policy of <code>NSURLCacheStorageAllowed</code> and a timeout interval of 30 seconds, and are set not handle cookies. To configure URL requests differently, use <a href="#//api/name/setImageWithURLRequest:placeholderImage:success:failure:"><code>setImageWithURLRequest:placeholderImage:success:failure:</code></a></p>
</div>
@@ -305,7 +305,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dt><em>placeholderImage</em></dt>
<dd><p>The image to be set initially, until the image request finishes. If <code>nil</code>, the image view will not change its image until the image request finishes.</p>
-<p>@discussion By default, URL requests have a cache policy of <code>NSURLCacheStorageAllowed</code> and a timeout interval of 30 seconds, and are set to use HTTP pipelining, and not handle cookies. To configure URL requests differently, use <a href="#//api/name/setImageWithURLRequest:placeholderImage:success:failure:"><code>setImageWithURLRequest:placeholderImage:success:failure:</code></a></p></dd>
+<p>@discussion By default, URL requests have a cache policy of <code>NSURLCacheStorageAllowed</code> and a timeout interval of 30 seconds, and are set not handle cookies. To configure URL requests differently, use <a href="#//api/name/setImageWithURLRequest:placeholderImage:success:failure:"><code>setImageWithURLRequest:placeholderImage:success:failure:</code></a></p></dd>
</dl>
</div>
@@ -371,7 +371,9 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>failure</em></dt>
- <dd><p>A block object to be executed when the image request operation finishes unsuccessfully, or that 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 error object describing the network or parsing error that occurred.</p></dd>
+ <dd><p>A block object to be executed when the image request operation finishes unsuccessfully, or that 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 error object describing the network or parsing error that occurred.</p>
+
+<p>@discussion If a success block is specified, it is the responsibility of the block to set the image of the image view before returning. If no success block is specified, the default behavior of setting the image with <code>self.image = image</code> is executed.</p></dd>
</dl>
</div>
@@ -414,7 +416,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
41 Classes/AFHTTPClient.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -244,7 +244,7 @@ <h1 class="title title-header">AFHTTPClient Class Reference</h1>
<td class="specification-value">NSCoding<br />NSCopying</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFHTTPClient.h</td>
+ <td class="specification-value">AFHTTPClient.h<br />AFHTTPClient.m</td>
</tr>
</tbody></table></div>
@@ -275,7 +275,6 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
<p>By default, <code>AFHTTPClient</code> sets the following HTTP headers:</p>
<ul>
-<li><code>Accept-Encoding: gzip</code></li>
<li><code>Accept-Language: (comma-delimited preferred languages), en-us;q=0.8</code></li>
<li><code>User-Agent: (generated user agent)</code></li>
</ul>
@@ -608,7 +607,7 @@ <h3 class="subsubtitle method-title">baseURL</h3>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) NSURL *baseURL</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic) NSURL *baseURL</code></div>
@@ -690,7 +689,7 @@ <h3 class="subsubtitle method-title">operationQueue</h3>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) NSOperationQueue *operationQueue</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic) NSOperationQueue *operationQueue</code></div>
@@ -743,7 +742,7 @@ <h3 class="subsubtitle method-title">parameterEncoding</h3>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>The <code>AFHTTPClientParameterEncoding</code> value corresponding to how parameters are encoded into a request body. This is <code>AFFormURLParameterEncoding</code> by default.</p><div class="warning"><p><strong>Warning:</strong> JSON encoding will automatically use JSONKit, SBJSON, YAJL, or NextiveJSON, if provided. Otherwise, the built-in <code>NSJSONSerialization</code> class is used, if available (iOS 5.0 and Mac OS 10.7). If the build target does not either support <code>NSJSONSerialization</code> or include a third-party JSON library, a runtime exception will be thrown when attempting to encode parameters as JSON.</p></div>
+ <p>The <code>AFHTTPClientParameterEncoding</code> value corresponding to how parameters are encoded into a request body. This is <code>AFFormURLParameterEncoding</code> by default.</p><div class="warning"><p><strong>Warning:</strong> Some nested parameter structures, such as a keyed array of hashes containing inconsistent keys (i.e. <code>@{@"": @[@{@"a" : @(1)}, @{@"b" : @(2)}]}</code>), cannot be unambiguously represented in query strings. It is strongly recommended that an unambiguous encoding, such as <code>AFJSONParameterEncoding</code>, is used when posting complicated or nondeterministic parameter structures.</p></div>
</div>
@@ -830,7 +829,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>url</em></dt>
- <dd><p>The base URL for the HTTP client. This argument must not be nil.</p></dd>
+ <dd><p>The base URL for the HTTP client. This argument must not be <code>nil</code>.</p></dd>
</dl>
</div>
@@ -885,15 +884,15 @@ <h3 class="subsubtitle method-title">HTTPRequestOperationWithRequest:success:fai
- <div class="method-subsection method-declaration"><code>- (AFHTTPRequestOperation *)HTTPRequestOperationWithRequest:(NSURLRequest *)<em>request</em> success:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))<em>success</em> failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))<em>failure</em></code></div>
+ <div class="method-subsection method-declaration"><code>- (AFHTTPRequestOperation *)HTTPRequestOperationWithRequest:(NSURLRequest *)<em>urlRequest</em> success:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))<em>success</em> failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))<em>failure</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
- <dt><em>request</em></dt>
+ <dt><em>urlRequest</em></dt>
<dd><p>The request object to be loaded asynchronously during execution of the operation.</p></dd>
</dl>
@@ -962,7 +961,9 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>path</em></dt>
- <dd><p>The path to match for the cancelled requests.</p></dd>
+ <dd><p>The path appended to the HTTP client base URL to match against the cancelled requests. If <code>nil</code>, no path will be appended to the base URL.</p>
+
+<p>@discussion This method only cancels <code>AFHTTPRequestOperations</code> whose request URL matches the HTTP client base URL with the path appended. For complete control over the lifecycle of enqueued operations, you can access the <a href="#//api/name/operationQueue"><code>operationQueue</code></a> property directly, which allows you to, for instance, cancel operations filtered by a predicate, or simply use <code>-cancelAllRequests</code>. Note that the operation queue may include non-HTTP operations, so be sure to check the type before attempting to directly introspect an operation&rsquo;s <code>request</code> property.</p></dd>
</dl>
</div>
@@ -1237,15 +1238,15 @@ <h3 class="subsubtitle method-title">enqueueBatchOfHTTPRequestOperationsWithRequ
- <div class="method-subsection method-declaration"><code>- (void)enqueueBatchOfHTTPRequestOperationsWithRequests:(NSArray *)<em>requests</em> progressBlock:(void ( ^ ) ( NSUInteger numberOfFinishedOperations , NSUInteger totalNumberOfOperations ))<em>progressBlock</em> completionBlock:(void ( ^ ) ( NSArray *operations ))<em>completionBlock</em></code></div>
+ <div class="method-subsection method-declaration"><code>- (void)enqueueBatchOfHTTPRequestOperationsWithRequests:(NSArray *)<em>urlRequests</em> progressBlock:(void ( ^ ) ( NSUInteger numberOfFinishedOperations , NSUInteger totalNumberOfOperations ))<em>progressBlock</em> completionBlock:(void ( ^ ) ( NSArray *operations ))<em>completionBlock</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
- <dt><em>requests</em></dt>
+ <dt><em>urlRequests</em></dt>
<dd><p>The <code>NSURLRequest</code> objects used to create and enqueue operations.</p></dd>
</dl>
@@ -1435,7 +1436,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>url</em></dt>
- <dd><p>The base URL for the HTTP client. This argument must not be nil.</p>
+ <dd><p>The base URL for the HTTP client. This argument must not be <code>nil</code>.</p>
<p>@discussion This is the designated initializer.</p></dd>
</dl>
@@ -1493,7 +1494,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>method</em></dt>
- <dd><p>The HTTP method for the request. Must be either <code>POST</code>, <code>PUT</code>, or <code>DELETE</code>.</p></dd>
+ <dd><p>The HTTP method for the request. This parameter must not be <code>GET</code> or <code>HEAD</code>, or <code>nil</code>.</p></dd>
</dl>
<dl class="argument-def parameter-def">
@@ -1510,7 +1511,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dt><em>block</em></dt>
<dd><p>A block that takes a single argument and appends data to the HTTP body. The block argument is an object adopting the <a href="../Protocols/AFMultipartFormData.html"><code>AFMultipartFormData</code></a> protocol. This can be used to upload files, encode HTTP body as JSON or XML, or specify multiple values for the same parameter, as one might for array values.</p>
-<p>@discussion The multipart form data is constructed synchronously in the specified block, so in cases where large amounts of data are being added to the request, you should consider performing this method in the background. Likewise, the form data is constructed in-memory, so it may be advantageous to instead write parts of the form data to a file and stream the request body using the <code>HTTPBodyStream</code> property of <code>NSURLRequest</code>.</p></dd>
+<p>@discussion Multipart form requests are automatically streamed, reading files directly from disk along with in-memory data in a single HTTP body. The resulting <code>NSMutableURLRequest</code> object has an <code>HTTPBodyStream</code> property, so refrain from setting <code>HTTPBodyStream</code> or <code>HTTPBody</code> on this request object, as it will clear out the multipart form body stream.</p></dd>
</dl>
</div>
@@ -1528,7 +1529,7 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>Creates an <code>NSMutableURLRequest</code> object with the specified HTTP method and path, and constructs a <code>multipart/form-data</code> HTTP body, using the specified parameters and multipart form data block. See <a href="http://www.w3.org/TR/html4/interact/forms.html">http://www.w3.org/TR/html4/interact/forms.html</a>#h-17.13.4.2</p><div class="warning"><p><strong>Warning:</strong> An exception will be raised if the specified method is not <code>POST</code>, <code>PUT</code> or <code>DELETE</code>.</p></div>
+ <p>Creates an <code>NSMutableURLRequest</code> object with the specified HTTP method and path, and constructs a <code>multipart/form-data</code> HTTP body, using the specified parameters and multipart form data block. See <a href="http://www.w3.org/TR/html4/interact/forms.html">http://www.w3.org/TR/html4/interact/forms.html</a>#h-17.13.4.2</p>
</div>
@@ -1849,12 +1850,12 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>method</em></dt>
- <dd><p>The HTTP method for the request, such as <code>GET</code>, <code>POST</code>, <code>PUT</code>, or <code>DELETE</code>.</p></dd>
+ <dd><p>The HTTP method for the request, such as <code>GET</code>, <code>POST</code>, <code>PUT</code>, or <code>DELETE</code>. This parameter must not be <code>nil</code>.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>path</em></dt>
- <dd><p>The path to be appended to the HTTP client&rsquo;s base URL and used as the request URL.</p></dd>
+ <dd><p>The path to be appended to the HTTP client&rsquo;s base URL and used as the request URL. If <code>nil</code>, no path will be appended to the base URL.</p></dd>
</dl>
<dl class="argument-def parameter-def">
@@ -1879,7 +1880,7 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>
<h4 class="method-subtitle">Discussion</h4>
<p>Creates an <code>NSMutableURLRequest</code> object with the specified HTTP method and path.</p>
-<p>If the HTTP method is <code>GET</code>, the parameters will be used to construct a url-encoded query string that is appended to the request&rsquo;s URL. Otherwise, the parameters will be encoded according to the value of the <a href="#//api/name/parameterEncoding"><code>parameterEncoding</code></a> property, and set as the request body.</p>
+<p>If the HTTP method is <code>GET</code>, <code>HEAD</code>, or <code>DELETE</code>, the parameters will be used to construct a url-encoded query string that is appended to the request&rsquo;s URL. Otherwise, the parameters will be encoded according to the value of the <a href="#//api/name/parameterEncoding"><code>parameterEncoding</code></a> property, and set as the request body.</p>
</div>
@@ -2174,7 +2175,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
261 Classes/AFHTTPRequestOperation.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -46,6 +46,8 @@ <h1 class="hideInXcode">AFHTTPRequestOperation Class Reference</h1>
<option value="//api/name/hasAcceptableStatusCode">&nbsp;&nbsp;&nbsp;&nbsp;hasAcceptableStatusCode</option>
+ <option value="//api/name/request">&nbsp;&nbsp;&nbsp;&nbsp;request</option>
+
<option value="//api/name/response">&nbsp;&nbsp;&nbsp;&nbsp;response</option>
<option value="//api/name/successCallbackQueue">&nbsp;&nbsp;&nbsp;&nbsp;successCallbackQueue</option>
@@ -70,6 +72,12 @@ <h1 class="hideInXcode">AFHTTPRequestOperation Class Reference</h1>
<option value="instance_methods">Instance Methods</option>
+ <option value="//api/name/error">&nbsp;&nbsp;&nbsp;&nbsp;- error</option>
+
+ <option value="//api/name/pause">&nbsp;&nbsp;&nbsp;&nbsp;- pause</option>
+
+ <option value="//api/name/responseString">&nbsp;&nbsp;&nbsp;&nbsp;- responseString</option>
+
<option value="//api/name/setCompletionBlockWithSuccess:failure:">&nbsp;&nbsp;&nbsp;&nbsp;- setCompletionBlockWithSuccess:failure:</option>
@@ -98,6 +106,8 @@ <h1 class="hideInXcode">AFHTTPRequestOperation Class Reference</h1>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Setting Completion Block Success / Failure Callbacks">Setting Completion Block Success / Failure Callbacks</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Extension Methods">Extension Methods</a></span></li>
+
</ul></li>
@@ -112,6 +122,8 @@ <h1 class="hideInXcode">AFHTTPRequestOperation Class Reference</h1>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hasAcceptableStatusCode">hasAcceptableStatusCode</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/request">request</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/response">response</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/successCallbackQueue">successCallbackQueue</a></span></li>
@@ -138,6 +150,12 @@ <h1 class="hideInXcode">AFHTTPRequestOperation Class Reference</h1>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/error">error</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/pause">pause</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/responseString">responseString</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setCompletionBlockWithSuccess:failure:">setCompletionBlockWithSuccess:failure:</a></span></li>
</ul></li>
@@ -167,7 +185,7 @@ <h1 class="title title-header">AFHTTPRequestOperation Class Reference</h1>
<td class="specification-value"><a href="../Classes/AFURLConnectionOperation.html">AFURLConnectionOperation</a> : NSOperation</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFHTTPRequestOperation.h</td>
+ <td class="specification-value">AFHTTPRequestOperation.h<br />AFHTTPRequestOperation.m</td>
</tr>
</tbody></table></div>
@@ -177,7 +195,7 @@ <h1 class="title title-header">AFHTTPRequestOperation Class Reference</h1>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
- <p><code>AFHTTPRequestOperation</code> is a subclass of <a href="../Classes/AFURLConnectionOperation.html"><code>AFURLConnectionOperation</code></a> 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.</p>
+ <p><code>AFHTTPRequestOperation</code> is a subclass of <a href="../Classes/AFURLConnectionOperation.html"><code>AFURLConnectionOperation</code></a> 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 <a href="#//api/name/request">request</a>.</p>
</div>
@@ -247,7 +265,7 @@ <h3 class="subsubtitle task-title">Managing Acceptable HTTP Status Codes &amp; C
<li>
<span class="tooltip">
<code><a href="#//api/name/acceptableStatusCodes">+&nbsp;acceptableStatusCodes</a></code>
- <span class="tooltip"><p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p></span>
+ <span class="tooltip"><p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p></span>
</span>
@@ -261,7 +279,7 @@ <h3 class="subsubtitle task-title">Managing Acceptable HTTP Status Codes &amp; C
</li><li>
<span class="tooltip">
<code><a href="#//api/name/acceptableContentTypes">+&nbsp;acceptableContentTypes</a></code>
- <span class="tooltip"><p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p></span>
+ <span class="tooltip"><p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p></span>
</span>
@@ -283,7 +301,7 @@ <h3 class="subsubtitle task-title">Determining Whether A Request Can Be Processe
<li>
<span class="tooltip">
<code><a href="#//api/name/canProcessRequest:">+&nbsp;canProcessRequest:</a></code>
- <span class="tooltip"><p>A Boolean value determining whether or not the class can process the specified request. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p></span>
+ <span class="tooltip"><p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p></span>
</span>
@@ -298,13 +316,57 @@ <h3 class="subsubtitle task-title">Setting Completion Block Success / Failure Ca
<li>
<span class="tooltip">
<code><a href="#//api/name/setCompletionBlockWithSuccess:failure:">&ndash;&nbsp;setCompletionBlockWithSuccess:failure:</a></code>
- <span class="tooltip"><p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If <code>error</code> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p></span>
+ <span class="tooltip"><p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p></span>
</span>
</li>
</ul>
+
+
+ <h3 class="subsubtitle task-title">Other Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/error">&ndash;&nbsp;error</a></code>
+
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/responseString">&ndash;&nbsp;responseString</a></code>
+ <span class="tooltip"><p>The string representation of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/response">response</a> data.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/pause">&ndash;&nbsp;pause</a></code>
+ <span class="tooltip"><p>Pauses the execution of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a> operation.</p></span>
+ </span>
+
+
+</li>
+ </ul>
+
+
+ <a title="Extension Methods" name="task_Extension Methods"></a>
+ <h3 class="subsubtitle task-title">Extension Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/request">&nbsp;&nbsp;request</a></code>
+ <span class="tooltip"><p>The request used by the operation&rsquo;s <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a>.</p></span>
+ </span>
+ <span class="task-item-suffix">property</span>
+
+</li>
+ </ul>
+
</div>
@@ -439,6 +501,47 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
<div class="section-method">
+ <a name="//api/name/request" title="request"></a>
+ <h3 class="subsubtitle method-title">request</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>The request used by the operation&rsquo;s <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a>.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>@property (readwrite, nonatomic, strong) NSURLRequest *request</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>The request used by the operation&rsquo;s <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/response" title="response"></a>
<h3 class="subsubtitle method-title">response</h3>
@@ -450,7 +553,7 @@ <h3 class="subsubtitle method-title">response</h3>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) NSHTTPURLResponse *response</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, strong) NSHTTPURLResponse *response</code></div>
@@ -535,7 +638,7 @@ <h3 class="subsubtitle method-title">acceptableContentTypes</h3>
<div class="method-subsection brief-description">
- <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
</div>
@@ -552,7 +655,7 @@ <h3 class="subsubtitle method-title">acceptableContentTypes</h3>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
<p>By default, this is <code>nil</code>.</p>
</div>
@@ -578,7 +681,7 @@ <h3 class="subsubtitle method-title">acceptableStatusCodes</h3>
<div class="method-subsection brief-description">
- <p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p>
+ <p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p>
</div>
@@ -595,7 +698,7 @@ <h3 class="subsubtitle method-title">acceptableStatusCodes</h3>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <code>error</code> property to an error in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p>
+ <p>Returns an <code>NSIndexSet</code> object containing the ranges of acceptable HTTP status codes. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a></p>
<p>By default, this is the range 200 to 299, inclusive.</p>
</div>
@@ -723,7 +826,7 @@ <h3 class="subsubtitle method-title">canProcessRequest:</h3>
<div class="method-subsection brief-description">
- <p>A Boolean value determining whether or not the class can process the specified request. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
</div>
@@ -737,7 +840,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>urlRequest</em></dt>
- <dd><p>The request that is determined to be supported or not supported for this class.</p></dd>
+ <dd><p>The <a href="#//api/name/request">request</a> that is determined to be supported or not supported for this class.</p></dd>
</dl>
</div>
@@ -750,7 +853,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>A Boolean value determining whether or not the class can process the specified request. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
</div>
@@ -776,13 +879,131 @@ <h4 class="method-subtitle">Declared In</h4>
<h2 class="subtitle subtitle-methods">Instance Methods</h2>
<div class="section-method">
+ <a name="//api/name/error" title="error"></a>
+ <h3 class="subsubtitle method-title">error</h3>
+
+
+
+
+
+ <div class="method-subsection method-declaration"><code>- (NSError *)error</code></div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/pause" title="pause"></a>
+ <h3 class="subsubtitle method-title">pause</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Pauses the execution of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a> operation.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>- (void)pause</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Pauses the execution of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a> operation.</p>
+
+<p>@discussion A paused operation returns <code>NO</code> for <a href="../Classes/AFURLConnectionOperation.html#//api/name/isReady"><code>isReady</code></a>, <a href="../Classes/AFURLConnectionOperation.html#//api/name/isExecuting"><code>isExecuting</code></a>, and <a href="../Classes/AFURLConnectionOperation.html#//api/name/isFinished"><code>isFinished</code></a>. As such, it will remain in an <code>NSOperationQueue</code> until it is either <a href="../Classes/AFURLConnectionOperation.html#//api/name/cancelled">cancelled</a> or resumed. Pausing a finished, <a href="../Classes/AFURLConnectionOperation.html#//api/name/cancelled">cancelled</a>, or paused operation has no effect.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/responseString" title="responseString"></a>
+ <h3 class="subsubtitle method-title">responseString</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>The string representation of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/response">response</a> data.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>- (NSString *)responseString</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>The string representation of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/response">response</a> data.</p>
+
+<p>@discussion This method uses the string encoding of the <a href="../Classes/AFURLConnectionOperation.html#//api/name/response">response</a>, or if UTF-8 if not specified, to construct a string from the <a href="../Classes/AFURLConnectionOperation.html#//api/name/response">response</a> data.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/setCompletionBlockWithSuccess:failure:" title="setCompletionBlockWithSuccess:failure:"></a>
<h3 class="subsubtitle method-title">setCompletionBlockWithSuccess:failure:</h3>
<div class="method-subsection brief-description">
- <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If <code>error</code> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
</div>
@@ -796,12 +1017,12 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>success</em></dt>
- <dd><p>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 <a href="#//api/name/response">response</a> data of the request.</p></dd>
+ <dd><p>The block to be executed on the completion of a successful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the object constructed from the <a href="#//api/name/response">response</a> data of the <a href="#//api/name/request">request</a>.</p></dd>
</dl>
<dl class="argument-def parameter-def">
<dt><em>failure</em></dt>
- <dd><p>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.</p>
+ <dd><p>The block to be executed on the completion of an unsuccessful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the <a href="#//api/name/error">error</a> that occurred during the <a href="#//api/name/request">request</a>.</p>
<p>@discussion This method should be overridden in subclasses in order to specify the <a href="#//api/name/response">response</a> object passed into the success block.</p></dd>
</dl>
@@ -816,7 +1037,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the request on completion. If <code>error</code> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
</div>
@@ -846,7 +1067,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
280 Classes/AFImageRequestOperation.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -49,13 +49,24 @@ <h1 class="hideInXcode">AFImageRequestOperation Class Reference</h1>
<option value="class_methods">Class Methods</option>
+ <option value="//api/name/acceptableContentTypes">&nbsp;&nbsp;&nbsp;&nbsp;+ acceptableContentTypes</option>
+
+ <option value="//api/name/canProcessRequest:">&nbsp;&nbsp;&nbsp;&nbsp;+ canProcessRequest:</option>
+
<option value="//api/name/imageRequestOperationWithRequest:imageProcessingBlock:success:failure:">&nbsp;&nbsp;&nbsp;&nbsp;+ imageRequestOperationWithRequest:imageProcessingBlock:success:failure:</option>
<option value="//api/name/imageRequestOperationWithRequest:success:">&nbsp;&nbsp;&nbsp;&nbsp;+ imageRequestOperationWithRequest:success:</option>
+ <option value="instance_methods">Instance Methods</option>
+
+ <option value="//api/name/initWithRequest:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithRequest:</option>
+
+ <option value="//api/name/setCompletionBlockWithSuccess:failure:">&nbsp;&nbsp;&nbsp;&nbsp;- setCompletionBlockWithSuccess:failure:</option>
+
+
</select>
</li>
@@ -89,6 +100,10 @@ <h1 class="hideInXcode">AFImageRequestOperation Class Reference</h1>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/acceptableContentTypes">acceptableContentTypes</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/canProcessRequest:">canProcessRequest:</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/imageRequestOperationWithRequest:imageProcessingBlock:success:failure:">imageRequestOperationWithRequest:imageProcessingBlock:success:failure:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/imageRequestOperationWithRequest:success:">imageRequestOperationWithRequest:success:</a></span></li>
@@ -97,6 +112,14 @@ <h1 class="hideInXcode">AFImageRequestOperation Class Reference</h1>
+<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithRequest:">initWithRequest:</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setCompletionBlockWithSuccess:failure:">setCompletionBlockWithSuccess:failure:</a></span></li>
+
+</ul></li>
+
</ul>
</nav>
@@ -122,7 +145,7 @@ <h1 class="title title-header">AFImageRequestOperation Class Reference</h1>
<td class="specification-value"><a href="../Classes/AFHTTPRequestOperation.html">AFHTTPRequestOperation</a> : <a href="../Classes/AFURLConnectionOperation.html">AFURLConnectionOperation</a> : NSOperation</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFImageRequestOperation.h</td>
+ <td class="specification-value">AFImageRequestOperation.h<br />AFImageRequestOperation.m</td>
</tr>
</tbody></table></div>
@@ -163,7 +186,7 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
-
+ <h3 class="subsubtitle task-title">Other Methods</h3>
<ul class="task-list">
<li>
@@ -197,6 +220,42 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
</li>
</ul>
+
+
+ <h3 class="subsubtitle task-title">Other Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/initWithRequest:">&ndash;&nbsp;initWithRequest:</a></code>
+ <span class="tooltip"><p>Initializes and returns a newly allocated operation object with a url <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a> configured with the specified url <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a>.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/acceptableContentTypes">+&nbsp;acceptableContentTypes</a></code>
+ <span class="tooltip"><p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/canProcessRequest:">+&nbsp;canProcessRequest:</a></code>
+ <span class="tooltip"><p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/setCompletionBlockWithSuccess:failure:">&ndash;&nbsp;setCompletionBlockWithSuccess:failure:</a></code>
+ <span class="tooltip"><p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p></span>
+ </span>
+
+
+</li>
+ </ul>
+
</div>
@@ -260,7 +319,7 @@ <h3 class="subsubtitle method-title">responseImage</h3>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) UIImage *responseImage</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, strong) UIImage *responseImage</code></div>
@@ -298,6 +357,100 @@ <h4 class="method-subtitle">Declared In</h4>
<h2 class="subtitle subtitle-methods">Class Methods</h2>
<div class="section-method">
+ <a name="//api/name/acceptableContentTypes" title="acceptableContentTypes"></a>
+ <h3 class="subsubtitle method-title">acceptableContentTypes</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (NSSet *)acceptableContentTypes</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+
+<p>By default, this is <code>nil</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/canProcessRequest:" title="canProcessRequest:"></a>
+ <h3 class="subsubtitle method-title">canProcessRequest:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (BOOL)canProcessRequest:(NSURLRequest *)<em>request</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>urlRequest</em></dt>
+ <dd><p>The <a href="#//api/name/request">request</a> that is determined to be supported or not supported for this class.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/imageRequestOperationWithRequest:imageProcessingBlock:success:failure:" title="imageRequestOperationWithRequest:imageProcessingBlock:success:failure:"></a>
<h3 class="subsubtitle method-title">imageRequestOperationWithRequest:imageProcessingBlock:success:failure:</h3>
@@ -433,6 +586,123 @@ <h4 class="method-subtitle">Declared In</h4>
+ <div class="section section-methods">
+ <a title="Instance Methods" name="instance_methods"></a>
+ <h2 class="subtitle subtitle-methods">Instance Methods</h2>
+
+ <div class="section-method">
+ <a name="//api/name/initWithRequest:" title="initWithRequest:"></a>
+ <h3 class="subsubtitle method-title">initWithRequest:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Initializes and returns a newly allocated operation object with a url <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a> configured with the specified url <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a>.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>- (id)initWithRequest:(NSURLRequest *)<em>urlRequest</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>urlRequest</em></dt>
+ <dd><p>The <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a> object to be used by the operation <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a>.</p>
+
+<p>@discussion This is the designated initializer.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Initializes and returns a newly allocated operation object with a url <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a> configured with the specified url <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/setCompletionBlockWithSuccess:failure:" title="setCompletionBlockWithSuccess:failure:"></a>
+ <h3 class="subsubtitle method-title">setCompletionBlockWithSuccess:failure:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>- (void)setCompletionBlockWithSuccess:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))<em>success</em> failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))<em>failure</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>success</em></dt>
+ <dd><p>The block to be executed on the completion of a successful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the object constructed from the <a href="#//api/name/response">response</a> data of the <a href="#//api/name/request">request</a>.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>failure</em></dt>
+ <dd><p>The block to be executed on the completion of an unsuccessful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the <a href="#//api/name/error">error</a> that occurred during the <a href="#//api/name/request">request</a>.</p>
+
+<p>@discussion This method should be overridden in subclasses in order to specify the <a href="#//api/name/response">response</a> object passed into the success block.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ </div>
+
</div>
<div class="main-navigation navigation-bottom">
@@ -444,7 +714,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
319 Classes/AFJSONRequestOperation.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -40,6 +40,8 @@ <h1 class="hideInXcode">AFJSONRequestOperation Class Reference</h1>
<option value="properties">Properties</option>
+ <option value="//api/name/JSONReadingOptions">&nbsp;&nbsp;&nbsp;&nbsp;JSONReadingOptions</option>
+
<option value="//api/name/responseJSON">&nbsp;&nbsp;&nbsp;&nbsp;responseJSON</option>
@@ -49,8 +51,19 @@ <h1 class="hideInXcode">AFJSONRequestOperation Class Reference</h1>
<option value="//api/name/JSONRequestOperationWithRequest:success:failure:">&nbsp;&nbsp;&nbsp;&nbsp;+ JSONRequestOperationWithRequest:success:failure:</option>
+ <option value="//api/name/acceptableContentTypes">&nbsp;&nbsp;&nbsp;&nbsp;+ acceptableContentTypes</option>
+
+ <option value="//api/name/canProcessRequest:">&nbsp;&nbsp;&nbsp;&nbsp;+ canProcessRequest:</option>
+
+
+ <option value="instance_methods">Instance Methods</option>
+
+ <option value="//api/name/error">&nbsp;&nbsp;&nbsp;&nbsp;- error</option>
+
+ <option value="//api/name/setCompletionBlockWithSuccess:failure:">&nbsp;&nbsp;&nbsp;&nbsp;- setCompletionBlockWithSuccess:failure:</option>
+
</select>
@@ -79,6 +92,8 @@ <h1 class="hideInXcode">AFJSONRequestOperation Class Reference</h1>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/JSONReadingOptions">JSONReadingOptions</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/responseJSON">responseJSON</a></span></li>
</ul></li>
@@ -89,10 +104,22 @@ <h1 class="hideInXcode">AFJSONRequestOperation Class Reference</h1>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/JSONRequestOperationWithRequest:success:failure:">JSONRequestOperationWithRequest:success:failure:</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/acceptableContentTypes">acceptableContentTypes</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/canProcessRequest:">canProcessRequest:</a></span></li>
+
</ul></li>
+<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/error">error</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setCompletionBlockWithSuccess:failure:">setCompletionBlockWithSuccess:failure:</a></span></li>
+
+</ul></li>
+
</ul>
</nav>
@@ -118,7 +145,7 @@ <h1 class="title title-header">AFJSONRequestOperation Class Reference</h1>
<td class="specification-value"><a href="../Classes/AFHTTPRequestOperation.html">AFHTTPRequestOperation</a> : <a href="../Classes/AFURLConnectionOperation.html">AFURLConnectionOperation</a> : NSOperation</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFJSONRequestOperation.h</td>
+ <td class="specification-value">AFJSONRequestOperation.h<br />AFJSONRequestOperation.m</td>
</tr>
</tbody></table></div>
@@ -138,7 +165,7 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
<li><code>application/json</code></li>
<li><code>text/json</code></li>
</ul>
-<div class="warning"><p><strong>Warning:</strong> JSON parsing will automatically use JSONKit, SBJSON, YAJL, or NextiveJSON, if provided. Otherwise, the built-in <code>NSJSONSerialization</code> class is used, if available (iOS 5.0 and Mac OS 10.7). If the build target does not either support <code>NSJSONSerialization</code> or include a third-party JSON library, a runtime exception will be thrown when attempting to parse a JSON request.</p></div>
+<div class="warning"><p><strong>Warning:</strong> JSON parsing will use the built-in <code>NSJSONSerialization</code> class.</p></div>
</div>
@@ -157,7 +184,14 @@ <h3 class="subsubtitle task-title">Getting Response Data</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/responseJSON">&nbsp;&nbsp;responseJSON</a></code>
- <span class="tooltip"><p>A JSON object constructed from the response data. If an error occurs while parsing, <code>nil</code> will be returned, and the <code>error</code> property will be set to the error.</p></span>
+ <span class="tooltip"><p>A JSON object constructed from the response data. If an <a href="#//api/name/error">error</a> occurs while parsing, <code>nil</code> will be returned, and the <a href="#//api/name/error"><code>error</code></a> property will be set to the <a href="#//api/name/error">error</a>.</p></span>
+ </span>
+ <span class="task-item-suffix">property</span>
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/JSONReadingOptions">&nbsp;&nbsp;JSONReadingOptions</a></code>
+ <span class="tooltip"><p>Options for reading the response JSON data and creating the Foundation objects. For possible values, see the <code>NSJSONSerialization</code> documentation section &ldquo;NSJSONReadingOptions&rdquo;.</p></span>
</span>
<span class="task-item-suffix">property</span>
@@ -179,6 +213,42 @@ <h3 class="subsubtitle task-title">Creating Request Operations</h3>
</li>
</ul>
+
+
+ <h3 class="subsubtitle task-title">Other Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/error">&ndash;&nbsp;error</a></code>
+
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/acceptableContentTypes">+&nbsp;acceptableContentTypes</a></code>
+ <span class="tooltip"><p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/canProcessRequest:">+&nbsp;canProcessRequest:</a></code>
+ <span class="tooltip"><p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/setCompletionBlockWithSuccess:failure:">&ndash;&nbsp;setCompletionBlockWithSuccess:failure:</a></code>
+ <span class="tooltip"><p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p></span>
+ </span>
+
+
+</li>
+ </ul>
+
</div>
@@ -190,18 +260,59 @@ <h3 class="subsubtitle task-title">Creating Request Operations</h3>
<h2 class="subtitle subtitle-methods">Properties</h2>
<div class="section-method">
+ <a name="//api/name/JSONReadingOptions" title="JSONReadingOptions"></a>
+ <h3 class="subsubtitle method-title">JSONReadingOptions</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Options for reading the response JSON data and creating the Foundation objects. For possible values, see the <code>NSJSONSerialization</code> documentation section &ldquo;NSJSONReadingOptions&rdquo;.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSJSONReadingOptions JSONReadingOptions</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Options for reading the response JSON data and creating the Foundation objects. For possible values, see the <code>NSJSONSerialization</code> documentation section &ldquo;NSJSONReadingOptions&rdquo;.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFJSONRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/responseJSON" title="responseJSON"></a>
<h3 class="subsubtitle method-title">responseJSON</h3>
<div class="method-subsection brief-description">
- <p>A JSON object constructed from the response data. If an error occurs while parsing, <code>nil</code> will be returned, and the <code>error</code> property will be set to the error.</p>
+ <p>A JSON object constructed from the response data. If an <a href="#//api/name/error">error</a> occurs while parsing, <code>nil</code> will be returned, and the <a href="#//api/name/error"><code>error</code></a> property will be set to the <a href="#//api/name/error">error</a>.</p>
</div>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) id responseJSON</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, strong) id responseJSON</code></div>
@@ -213,7 +324,7 @@ <h3 class="subsubtitle method-title">responseJSON</h3>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p>A JSON object constructed from the response data. If an error occurs while parsing, <code>nil</code> will be returned, and the <code>error</code> property will be set to the error.</p>
+ <p>A JSON object constructed from the response data. If an <a href="#//api/name/error">error</a> occurs while parsing, <code>nil</code> will be returned, and the <a href="#//api/name/error"><code>error</code></a> property will be set to the <a href="#//api/name/error">error</a>.</p>
</div>
@@ -269,7 +380,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>failure</em></dt>
- <dd><p>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.</p></dd>
+ <dd><p>A block object to be executed when the operation finishes unsuccessfully, or that finishes successfully, but encountered an <a href="#//api/name/error">error</a> 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 <a href="#//api/name/error">error</a> describing the network or parsing <a href="#//api/name/error">error</a> that occurred.</p></dd>
</dl>
</div>
@@ -304,10 +415,200 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
+ <div class="section-method">
+ <a name="//api/name/acceptableContentTypes" title="acceptableContentTypes"></a>
+ <h3 class="subsubtitle method-title">acceptableContentTypes</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (NSSet *)acceptableContentTypes</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+
+<p>By default, this is <code>nil</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/canProcessRequest:" title="canProcessRequest:"></a>
+ <h3 class="subsubtitle method-title">canProcessRequest:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (BOOL)canProcessRequest:(NSURLRequest *)<em>request</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>urlRequest</em></dt>
+ <dd><p>The <a href="#//api/name/request">request</a> that is determined to be supported or not supported for this class.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
</div>
+ <div class="section section-methods">
+ <a title="Instance Methods" name="instance_methods"></a>
+ <h2 class="subtitle subtitle-methods">Instance Methods</h2>
+
+ <div class="section-method">
+ <a name="//api/name/error" title="error"></a>
+ <h3 class="subsubtitle method-title">error</h3>
+
+
+
+
+
+ <div class="method-subsection method-declaration"><code>- (NSError *)error</code></div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFURLConnectionOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/setCompletionBlockWithSuccess:failure:" title="setCompletionBlockWithSuccess:failure:"></a>
+ <h3 class="subsubtitle method-title">setCompletionBlockWithSuccess:failure:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>- (void)setCompletionBlockWithSuccess:(void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))<em>success</em> failure:(void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))<em>failure</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>success</em></dt>
+ <dd><p>The block to be executed on the completion of a successful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the object constructed from the <a href="#//api/name/response">response</a> data of the <a href="#//api/name/request">request</a>.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>failure</em></dt>
+ <dd><p>The block to be executed on the completion of an unsuccessful <a href="#//api/name/request">request</a>. This block has no return value and takes two arguments: the receiver operation and the <a href="#//api/name/error">error</a> that occurred during the <a href="#//api/name/request">request</a>.</p>
+
+<p>@discussion This method should be overridden in subclasses in order to specify the <a href="#//api/name/response">response</a> object passed into the success block.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ </div>
+
</div>
<div class="main-navigation navigation-bottom">
@@ -319,7 +620,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
16 Classes/AFNetworkActivityIndicatorManager.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -133,7 +133,7 @@ <h1 class="title title-header">AFNetworkActivityIndicatorManager Class Reference
<td class="specification-value">NSObject</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFNetworkActivityIndicatorManager.h</td>
+ <td class="specification-value">AFNetworkActivityIndicatorManager.h<br />AFNetworkActivityIndicatorManager.m</td>
</tr>
</tbody></table></div>
@@ -145,7 +145,15 @@ <h1 class="title title-header">AFNetworkActivityIndicatorManager Class Reference
<h2 class="subtitle subtitle-overview">Overview</h2>
<p><code>AFNetworkActivityIndicatorManager</code> manages the state of the network activity indicator in the status bar. When <a href="#//api/name/enabled">enabled</a>, it will listen for notifications indicating that a network request operation has started or finished, and start or stop animating the indicator accordingly. The number of active requests is incremented and decremented much like a stack or a semaphore, and the activity indicator will animate so long as that number is greater than zero.</p>
-<p>@discussion By setting <a href="#//api/name/isNetworkActivityIndicatorVisible"><code>isNetworkActivityIndicatorVisible</code></a> to <code>YES</code> for <a href="#//api/name/sharedManager"><code>sharedManager</code></a>, the network activity indicator will show and hide automatically as requests start and finish. You should not ever need to call <a href="#//api/name/incrementActivityCount"><code>incrementActivityCount</code></a> or <a href="#//api/name/decrementActivityCount"><code>decrementActivityCount</code></a> yourself.</p>
+<p>You should enable the shared instance of <code>AFNetworkActivityIndicatorManager</code> when your application finishes launching. In <code>AppDelegate application:didFinishLaunchingWithOptions:</code> you can do so with the following code:</p>
+
+<pre><code> [[AFNetworkActivityIndicatorManager sharedManager] setEnabled:YES];
+</code></pre>
+
+<p>By setting <a href="#//api/name/networkActivityIndicatorVisible"><code>isNetworkActivityIndicatorVisible</code></a> to <code>YES</code> for <a href="#//api/name/sharedManager"><code>sharedManager</code></a>, the network activity indicator will show and hide automatically as requests start and finish. You should not ever need to call <a href="#//api/name/incrementActivityCount"><code>incrementActivityCount</code></a> or <a href="#//api/name/decrementActivityCount"><code>decrementActivityCount</code></a> yourself.</p>
+
+<p>See the Apple Human Interface Guidelines section about the Network Activity Indicator for more information:
+<a href="http://developer.apple.com/library/iOS/">http://developer.apple.com/library/iOS/</a>#documentation/UserExperience/Conceptual/MobileHIG/UIElementGuidelines/UIElementGuidelines.html#//apple_ref/doc/uid/TP40006556-CH13-SW44</p>
</div>
@@ -450,7 +458,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2012 AFNetworking. All rights reserved. (Last updated: 2012-09-05)</span><br />
+ <p><span class="copyright">&copy; 2012 Gowalla. All rights reserved. (Last updated: 2012-11-15)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
View
323 Classes/AFPropertyListRequestOperation.html
@@ -13,7 +13,7 @@
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">AFNetworking </a></h1>
- <a id="developerHome" href="../index.html">AFNetworking</a>
+ <a id="developerHome" href="../index.html">Gowalla</a>
</div>
<div id="title" role="banner">
@@ -49,11 +49,24 @@ <h1 class="hideInXcode">AFPropertyListRequestOperation Class Reference</h1>
<option value="class_methods">Class Methods</option>
+ <option value="//api/name/acceptableContentTypes">&nbsp;&nbsp;&nbsp;&nbsp;+ acceptableContentTypes</option>
+
+ <option value="//api/name/canProcessRequest:">&nbsp;&nbsp;&nbsp;&nbsp;+ canProcessRequest:</option>
+
<option value="//api/name/propertyListRequestOperationWithRequest:success:failure:">&nbsp;&nbsp;&nbsp;&nbsp;+ propertyListRequestOperationWithRequest:success:failure:</option>
+ <option value="instance_methods">Instance Methods</option>
+
+ <option value="//api/name/error">&nbsp;&nbsp;&nbsp;&nbsp;- error</option>
+
+ <option value="//api/name/initWithRequest:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithRequest:</option>
+
+ <option value="//api/name/setCompletionBlockWithSuccess:failure:">&nbsp;&nbsp;&nbsp;&nbsp;- setCompletionBlockWithSuccess:failure:</option>
+
+
</select>
</li>
@@ -91,12 +104,26 @@ <h1 class="hideInXcode">AFPropertyListRequestOperation Class Reference</h1>
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/acceptableContentTypes">acceptableContentTypes</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/canProcessRequest:">canProcessRequest:</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/propertyListRequestOperationWithRequest:success:failure:">propertyListRequestOperationWithRequest:success:failure:</a></span></li>
</ul></li>
+<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/error">error</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithRequest:">initWithRequest:</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setCompletionBlockWithSuccess:failure:">setCompletionBlockWithSuccess:failure:</a></span></li>
+
+</ul></li>
+
</ul>
</nav>
@@ -122,7 +149,7 @@ <h1 class="title title-header">AFPropertyListRequestOperation Class Reference</h
<td class="specification-value"><a href="../Classes/AFHTTPRequestOperation.html">AFHTTPRequestOperation</a> : <a href="../Classes/AFURLConnectionOperation.html">AFURLConnectionOperation</a> : NSOperation</td>
</tr><tr>
<td class="specification-title">Declared in</td>
- <td class="specification-value">AFPropertyListRequestOperation.h</td>
+ <td class="specification-value">AFPropertyListRequestOperation.h<br />AFPropertyListRequestOperation.m</td>
</tr>
</tbody></table></div>
@@ -189,6 +216,49 @@ <h3 class="subsubtitle task-title">Managing Property List Behavior</h3>
</li>
</ul>
+
+
+ <h3 class="subsubtitle task-title">Other Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/initWithRequest:">&ndash;&nbsp;initWithRequest:</a></code>
+ <span class="tooltip"><p>Initializes and returns a newly allocated operation object with a url <a href="../Classes/AFURLConnectionOperation.html#//api/name/connection">connection</a> configured with the specified url <a href="../Classes/AFURLConnectionOperation.html#//api/name/request">request</a>.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/error">&ndash;&nbsp;error</a></code>
+
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/acceptableContentTypes">+&nbsp;acceptableContentTypes</a></code>
+ <span class="tooltip"><p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/canProcessRequest:">+&nbsp;canProcessRequest:</a></code>
+ <span class="tooltip"><p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/setCompletionBlockWithSuccess:failure:">&ndash;&nbsp;setCompletionBlockWithSuccess:failure:</a></code>
+ <span class="tooltip"><p>Sets the <code>completionBlock</code> property with a block that executes either the specified success or failure block, depending on the state of the <a href="#//api/name/request">request</a> on completion. If <a href="#//api/name/error"><code>error</code></a> returns a value, which can be caused by an unacceptable status code or content type, then <code>failure</code> is executed. Otherwise, <code>success</code> is executed.</p></span>
+ </span>
+
+
+</li>
+ </ul>
+
</div>
@@ -252,7 +322,7 @@ <h3 class="subsubtitle method-title">responsePropertyList</h3>
- <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic, retain) id responsePropertyList</code></div>
+ <div class="method-subsection method-declaration"><code>@property (readonly, nonatomic) id responsePropertyList</code></div>
@@ -290,6 +360,100 @@ <h4 class="method-subtitle">Declared In</h4>
<h2 class="subtitle subtitle-methods">Class Methods</h2>
<div class="section-method">
+ <a name="//api/name/acceptableContentTypes" title="acceptableContentTypes"></a>
+ <h3 class="subsubtitle method-title">acceptableContentTypes</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (NSSet *)acceptableContentTypes</code></div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>Returns an <code>NSSet</code> object containing the acceptable MIME types. When non-<code>nil</code>, the operation will set the <a href="#//api/name/error"><code>error</code></a> property to an <a href="#//api/name/error">error</a> in <code>AFErrorDomain</code>. See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html</a>#sec14.17</p>
+
+<p>By default, this is <code>nil</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AFHTTPRequestOperation.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/canProcessRequest:" title="canProcessRequest:"></a>
+ <h3 class="subsubtitle method-title">canProcessRequest:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+ <div class="method-subsection method-declaration"><code>+ (BOOL)canProcessRequest:(NSURLRequest *)<em>request</em></code></div>
+
+
+
+ <div class="method-subsection arguments-section parameters">
+ <h4 class="method-subtitle parameter-title">Parameters</h4>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>urlRequest</em></dt>
+ <dd><p>The <a href="#//api/name/request">request</a> that is determined to be supported or not supported for this class.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+ <p>A Boolean value determining whether or not the class can process the specified <a href="#//api/name/request">request</a>. For example, <a href="../Classes/AFJSONRequestOperation.html"><code>AFJSONRequestOperation</code></a> may check to make sure the content type was <code>application/json</code> or the URL path extension was <code>.json</code>.</p>
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">