spec/integration_specs/document_alamofire/after/docs/Classes/Request.html in jazzy-0.0.15 vs spec/integration_specs/document_alamofire/after/docs/Classes/Request.html in jazzy-0.0.16
- old
+ new
@@ -1,16 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Request Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
- <link rel="stylesheet" type="text/css" href="../css/github_syntax_highlighting.css" />
+ <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
+ <script type="text/javascript">
+ window.jazzy = {'docset': false}
+ if (typeof window.dash != 'undefined') {
+ document.documentElement.className += ' dash'
+ window.jazzy.docset = true
+ }
+ if (navigator.userAgent.match(/xcode/i)) {
+ document.documentElement.className += ' xcode'
+ window.jazzy.docset = true
+ }
+ </script>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body id="reference" class="Swift">
+ <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
<a title="Request Class Reference"></a>
<header>
<div class="content-wrapper">
<p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
<p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
@@ -172,10 +184,11 @@
<ul class="task-group-list">
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
+ <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -187,13 +200,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public var task: NSURLSessionTask { get }</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">NSURLSessionTask</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
</div>
@@ -202,10 +214,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:C9Alamofire7Request10Serializer">
+ <a name="//apple_ref/swift/Alias/Serializer" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -217,13 +230,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -> (AnyObject?, NSError?)</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Serializer</span> <span class="o">=</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">NSData</span><span class="p">?)</span> <span class="o">-></span> <span class="p">(</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
</div>
@@ -232,10 +244,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
+ <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -247,13 +260,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public let session: NSURLSession</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">NSURLSession</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
</div>
@@ -262,10 +274,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
+ <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -277,13 +290,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public var request: NSURLRequest { get }</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">NSURLRequest</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
</div>
@@ -292,10 +304,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
+ <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -307,13 +320,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public var response: NSHTTPURLResponse? { get }</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
</div>
@@ -322,10 +334,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
+ <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -337,13 +350,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public var progress: NSProgress? { get }</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">NSProgress</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
</div>
@@ -354,20 +366,22 @@
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Authentication"></a>
+ <a name="//apple_ref/swift/Section/Authentication" class="dashAnchor"></a>
<a href="#/Authentication">
<h3 class="section-name">Authentication</h3>
</a>
</div>
<ul class="task-group-list">
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
+ <a name="//apple_ref/swift/Method/authenticate(user:password:)" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -379,13 +393,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func authenticate(#user: String, password: String) -> Self</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="nv">#user</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
+
</div>
</div>
<div class="parameters">
<h4>Parameters</h4>
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
@@ -429,10 +442,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
+ <a name="//apple_ref/swift/Method/authenticate(usingCredential:)" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -444,13 +458,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func authenticate(usingCredential credential: NSURLCredential) -> Self</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">usingCredential</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">NSURLCredential</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
+
</div>
</div>
<div class="parameters">
<h4>Parameters</h4>
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
@@ -484,20 +497,22 @@
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Progress"></a>
+ <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
<a href="#/Progress">
<h3 class="section-name">Progress</h3>
</a>
</div>
<ul class="task-group-list">
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
+ <a name="//apple_ref/swift/Method/progress(closure:)" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -509,13 +524,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func progress(closure: ((Int64, Int64, Int64) -> Void)? = default) -> Self</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">progress</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
+
</div>
</div>
<div class="parameters">
<h4>Parameters</h4>
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
@@ -549,20 +563,22 @@
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Response"></a>
+ <a name="//apple_ref/swift/Section/Response" class="dashAnchor"></a>
<a href="#/Response">
<h3 class="section-name">Response</h3>
</a>
</div>
<ul class="task-group-list">
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
+ <a name="//apple_ref/swift/Method/responseDataSerializer()" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -574,13 +590,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public class func responseDataSerializer() -> Serializer</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">responseDataSerializer</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Serializer</span></code></pre>
+
</div>
</div>
<div class="result-description">
<h4>Return Value</h4>
<p class="para">A data response serializer.</p>
@@ -593,10 +608,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
+ <a name="//apple_ref/swift/Method/response(_:)" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -608,13 +624,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -> Void) -> Self</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
+
</div>
</div>
<div class="parameters">
<h4>Parameters</h4>
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
@@ -646,10 +661,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
+ <a name="//apple_ref/swift/Method/response(queue:serializer:completionHandler:)" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">response(queue:serializer:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -661,13 +677,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -> Void) -> Self</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="n">dispatch_queue_t</span><span class="p">?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
+
</div>
</div>
<div class="parameters">
<h4>Parameters</h4>
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
@@ -723,10 +738,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request7suspendFS0_FT_T_">
+ <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request7suspendFS0_FT_T_">suspend()</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -738,13 +754,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func suspend()</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L661">Show on GitHub</a>
</div>
@@ -753,10 +768,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request6resumeFS0_FT_T_">
+ <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6resumeFS0_FT_T_">resume()</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -768,13 +784,12 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func resume()</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L668">Show on GitHub</a>
</div>
@@ -783,10 +798,11 @@
</li>
<li class="item symbol">
<div class="task-group-term">
<code>
<a name="/s:FC9Alamofire7Request6cancelFS0_FT_T_">
+ <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
<a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6cancelFS0_FT_T_">cancel()</a>
</code>
</div>
<div class="height-container">
<div class="pointy-thing-container"></div>
@@ -798,12 +814,11 @@
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
- <p class="para">
- <code>public func cancel()</code>
- </p>
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
+
</div>
</div>
<div class="result-description view-on-github">
<a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L675">Show on GitHub</a>
</div>