jazzy 0.0.10 → 0.0.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/bin/sourcekitten +0 -0
  4. data/lib/jazzy/config.rb +1 -1
  5. data/lib/jazzy/doc_builder.rb +8 -5
  6. data/lib/jazzy/gem_version.rb +1 -1
  7. data/lib/jazzy/jazzy_markdown.rb +1 -1
  8. data/lib/jazzy/sourcekitten.rb +2 -4
  9. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/{Singleton.html → init(configuration:).html} +11 -51
  10. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +4 -214
  11. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +41 -626
  12. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +4 -24
  13. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +16 -76
  14. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +5 -25
  15. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +4 -64
  16. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +4 -24
  17. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +4 -64
  18. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +4 -44
  19. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +4 -24
  20. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +4 -24
  21. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +4 -24
  22. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +4 -24
  23. data/spec/integration_specs/document_alamofire/after/docs/index.html +4 -24
  24. data/spec/integration_specs/document_alamofire/after/execution_output.txt +3 -0
  25. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +0 -6
  26. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +0 -23
  27. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +0 -6
  28. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +0 -23
  29. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +0 -6
  30. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +0 -6
  31. data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +3 -0
  32. metadata +2 -13
  33. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/SessionDelegate.html +0 -865
  34. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/DataTaskDelegate.html +0 -485
  35. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/TaskDelegate.html +0 -505
  36. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURL.html +0 -225
  37. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLComponents.html +0 -225
  38. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLRequest.html +0 -225
  39. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/DownloadTaskDelegate.html +0 -405
  40. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/MIMEType.html +0 -285
  41. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/UploadTaskDelegate.html +0 -265
  42. data/spec/integration_specs/document_alamofire/after/docs/Extensions/String.html +0 -225
  43. data/spec/integration_specs/document_alamofire/after/docs/Typealiases.html +0 -265
data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html CHANGED
@@ -61,19 +61,13 @@
61
61
  <a href="../Extensions.html">Extensions</a>
62
62
  <ul class="nav-chapters">
63
63
  <li class="nav-chapter">
64
- <a href="../Extensions/String.html">String</a>
64
+ <a href="../Extensions.html#/s:SS">String</a>
65
65
  </li>
66
66
  <li class="nav-chapter">
67
- <a href="../Extensions/NSURL.html">NSURL</a>
67
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
68
68
  </li>
69
69
  <li class="nav-chapter">
70
- <a href="../Extensions/NSURLComponents.html">NSURLComponents</a>
71
- </li>
72
- <li class="nav-chapter">
73
- <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
74
- </li>
75
- <li class="nav-chapter">
76
- <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
70
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
77
71
  </li>
78
72
  <li class="nav-chapter">
79
73
  <a href="../Extensions/Request.html">Request</a>
@@ -82,7 +76,7 @@
82
76
  <a href="../Extensions/Manager.html">Manager</a>
83
77
  </li>
84
78
  <li class="nav-chapter">
85
- <a href="../Extensions/Request.html">Request</a>
79
+ <a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
86
80
  </li>
87
81
  <li class="nav-chapter">
88
82
  <a href="../Extensions/Manager.html">Manager</a>
@@ -110,9 +104,6 @@
110
104
  <li class="part-name tasks">
111
105
  <a href="../Functions.html">Functions</a>
112
106
  <ul class="nav-chapters">
113
- <li class="nav-chapter">
114
- <a href="../Functions.html#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</a>
115
- </li>
116
107
  <li class="nav-chapter">
117
108
  <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
118
109
  </li>
@@ -147,388 +138,38 @@
147
138
  <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
148
139
  </li>
149
140
  </ul>
150
- </li>
151
- <li class="part-name tasks">
152
- <a href="../Protocols.html">Protocols</a>
153
- <ul class="nav-chapters">
154
- <li class="nav-chapter">
155
- <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
156
- </li>
157
- <li class="nav-chapter">
158
- <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
159
- </li>
160
- </ul>
161
- </li>
162
- <li class="part-name tasks">
163
- <a href="../Typealiases.html">Typealiases</a>
164
- <ul class="nav-chapters">
165
- <li class="nav-chapter">
166
- <a href="../Typealiases.html#/s:C9Alamofire7Request10Validation">Validation</a>
167
- </li>
168
- <li class="nav-chapter">
169
- <a href="../Typealiases.html#/s:C9Alamofire7Request23DownloadFileDestination">DownloadFileDestination</a>
170
- </li>
171
- </ul>
172
- </li>
173
- </ul>
174
- </nav>
175
- <div class="pixel-line"></div>
176
- <div class="rubber-band-gap"></div>
177
- <article class="chapter">
178
- <a name="/"></a>
179
- <h1 class="chapter-name">Request</h1>
180
- <section>
181
- <section class="section">
182
- <p class="para">Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying <code>NSURLSessionTask</code>.</p>
183
- </section>
184
- <section class="section task-group-section">
185
- <div class="task-group">
186
- <div class="task-name-container">
187
- <a name="/Children"></a>
188
- <a href="#/Children">
189
- <h3 class="section-name"></h3>
190
- </a>
191
- </div>
192
- <ul class="task-group-list">
193
- <li class="item symbol">
194
- <div class="task-group-term">
195
- <code>
196
- <a name="/s:vC9Alamofire7RequestP33_A313450CFC1FC3D0CBEF4411412DB9E88delegateCS0_12TaskDelegate">
197
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7RequestP33_A313450CFC1FC3D0CBEF4411412DB9E88delegateCS0_12TaskDelegate">delegate</a>
198
- </code>
199
- </div>
200
- <div class="height-container">
201
- <div class="pointy-thing-container"></div>
202
- <section class="section instance-method">
203
- <div class="pointy-thing"></div>
204
- <div class="abstract">
205
- <p class="para">Undocumented</p>
206
- </div>
207
- <div class="result-description view-on-github">
208
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
209
- </div>
210
- </section>
211
- </div>
212
- </li>
213
- <li class="item symbol">
214
- <div class="task-group-term">
215
- <code>
216
- <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
217
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
218
- </code>
219
- </div>
220
- <div class="height-container">
221
- <div class="pointy-thing-container"></div>
222
- <section class="section instance-method">
223
- <div class="pointy-thing"></div>
224
- <div class="abstract">
225
- <p class="para">Associates an HTTP Basic credential with the request.</p>
226
- </div>
227
- <div class="declaration">
228
- <h4>Declaration</h4>
229
-
230
- <div class="Swift">
231
- <p class="aside-title">Swift</p>
232
- <p class="para">
233
- <code>public func authenticate(#user: String, password: String) -&gt; Self</code>
234
- </p>
235
- </div>
236
- </div>
237
- <div class="parameters">
238
- <h4>Parameters</h4>
239
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
240
- <tbody>
241
- <tr>
242
- <td scope="row">
243
- <code>
244
- <em class="term">user</em>
245
- </code>
246
- </td>
247
- <td>
248
- <div class="definition">
249
- <p class="para">The user.</p>
250
- </div>
251
- </td>
252
- </tr>
253
- <tr>
254
- <td scope="row">
255
- <code>
256
- <em class="term">password</em>
257
- </code>
258
- </td>
259
- <td>
260
- <div class="definition">
261
- <p class="para">The password.</p>
262
- </div>
263
- </td>
264
- </tr>
265
- </tbody>
266
- </table>
267
- </div>
268
- <div class="result-description">
269
- <h4>Return Value</h4>
270
- <p class="para">The request.</p>
271
- </div>
272
- <div class="result-description view-on-github">
273
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L565">Show on GitHub</a>
274
- </div>
275
- </section>
276
- </div>
277
- </li>
278
- <li class="item symbol">
279
- <div class="task-group-term">
280
- <code>
281
- <a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
282
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
283
- </code>
284
- </div>
285
- <div class="height-container">
286
- <div class="pointy-thing-container"></div>
287
- <section class="section instance-method">
288
- <div class="pointy-thing"></div>
289
- <div class="abstract">
290
- <p class="para">Sets a closure to be called periodically during the lifecycle of the request as data is written to or read from the server.<ul><li>For uploads, the progress closure returns the bytes written, total bytes written, and total bytes expected to write.</li><li>For downloads, the progress closure returns the bytes read, total bytes read, and total bytes expected to write.</li></ul></p>
291
- </div>
292
- <div class="declaration">
293
- <h4>Declaration</h4>
294
-
295
- <div class="Swift">
296
- <p class="aside-title">Swift</p>
297
- <p class="para">
298
- <code>public func progress(closure: ((Int64, Int64, Int64) -&gt; Void)? = default) -&gt; Self</code>
299
- </p>
300
- </div>
301
- </div>
302
- <div class="parameters">
303
- <h4>Parameters</h4>
304
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
305
- <tbody>
306
- <tr>
307
- <td scope="row">
308
- <code>
309
- <em class="term">closure</em>
310
- </code>
311
- </td>
312
- <td>
313
- <div class="definition">
314
- <p class="para">The code to be executed periodically during the lifecycle of the request.</p>
315
- </div>
316
- </td>
317
- </tr>
318
- </tbody>
319
- </table>
320
- </div>
321
- <div class="result-description">
322
- <h4>Return Value</h4>
323
- <p class="para">The request.</p>
324
- </div>
325
- <div class="result-description view-on-github">
326
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L596">Show on GitHub</a>
327
- </div>
328
- </section>
329
- </div>
330
- </li>
331
- <li class="item symbol">
332
- <div class="task-group-term">
333
- <code>
334
- <a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
335
- <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>
336
- </code>
337
- </div>
338
- <div class="height-container">
339
- <div class="pointy-thing-container"></div>
340
- <section class="section instance-method">
341
- <div class="pointy-thing"></div>
342
- <div class="abstract">
343
- <p class="para">Adds a handler to be called once the request has finished.</p>
344
- </div>
345
- <div class="declaration">
346
- <h4>Declaration</h4>
347
-
348
- <div class="Swift">
349
- <p class="aside-title">Swift</p>
350
- <p class="para">
351
- <code>public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
352
- </p>
353
- </div>
354
- </div>
355
- <div class="parameters">
356
- <h4>Parameters</h4>
357
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
358
- <tbody>
359
- <tr>
360
- <td scope="row">
361
- <code>
362
- <em class="term">queue</em>
363
- </code>
364
- </td>
365
- <td>
366
- <div class="definition">
367
- <p class="para">The queue on which the completion handler is dispatched.</p>
368
- </div>
369
- </td>
370
- </tr>
371
- <tr>
372
- <td scope="row">
373
- <code>
374
- <em class="term">serializer</em>
375
- </code>
376
- </td>
377
- <td>
378
- <div class="definition">
379
- <p class="para">The closure responsible for serializing the request, response, and data.</p>
380
- </div>
381
- </td>
382
- </tr>
383
- <tr>
384
- <td scope="row">
385
- <code>
386
- <em class="term">completionHandler</em>
387
- </code>
388
- </td>
389
- <td>
390
- <div class="definition">
391
- <p class="para">The code to be executed once the request has finished.</p>
392
- </div>
393
- </td>
394
- </tr>
395
- </tbody>
396
- </table>
397
- </div>
398
- <div class="result-description">
399
- <h4>Return Value</h4>
400
- <p class="para">The request.</p>
401
- </div>
402
- <div class="result-description view-on-github">
403
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L646">Show on GitHub</a>
404
- </div>
405
- </section>
406
- </div>
407
- </li>
408
- <li class="item symbol">
409
- <div class="task-group-term">
410
- <code>
411
- <a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
412
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
413
- </code>
414
- </div>
415
- <div class="height-container">
416
- <div class="pointy-thing-container"></div>
417
- <section class="section instance-method">
418
- <div class="pointy-thing"></div>
419
- <div class="abstract">
420
- <p class="para">The request sent or to be sent to the server.</p>
421
- </div>
422
- <div class="declaration">
423
- <h4>Declaration</h4>
424
-
425
- <div class="Swift">
426
- <p class="aside-title">Swift</p>
427
- <p class="para">
428
- <code>public var request: NSURLRequest { get }</code>
429
- </p>
430
- </div>
431
- </div>
432
- <div class="result-description view-on-github">
433
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
434
- </div>
435
- </section>
436
- </div>
437
- </li>
438
- <li class="item symbol">
439
- <div class="task-group-term">
440
- <code>
441
- <a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
442
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
443
- </code>
444
- </div>
445
- <div class="height-container">
446
- <div class="pointy-thing-container"></div>
447
- <section class="section instance-method">
448
- <div class="pointy-thing"></div>
449
- <div class="abstract">
450
- <p class="para">The response received from the server, if any.</p>
451
- </div>
452
- <div class="declaration">
453
- <h4>Declaration</h4>
454
-
455
- <div class="Swift">
456
- <p class="aside-title">Swift</p>
457
- <p class="para">
458
- <code>public var response: NSHTTPURLResponse? { get }</code>
459
- </p>
460
- </div>
461
- </div>
462
- <div class="result-description view-on-github">
463
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
464
- </div>
465
- </section>
466
- </div>
467
- </li>
468
- <li class="item symbol">
469
- <div class="task-group-term">
470
- <code>
471
- <a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
472
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
473
- </code>
474
- </div>
475
- <div class="height-container">
476
- <div class="pointy-thing-container"></div>
477
- <section class="section instance-method">
478
- <div class="pointy-thing"></div>
479
- <div class="abstract">
480
- <p class="para">Creates a response serializer that returns the associated data as-is.</p>
481
- </div>
482
- <div class="declaration">
483
- <h4>Declaration</h4>
484
-
485
- <div class="Swift">
486
- <p class="aside-title">Swift</p>
487
- <p class="para">
488
- <code>public class func responseDataSerializer() -&gt; Serializer</code>
489
- </p>
490
- </div>
491
- </div>
492
- <div class="result-description">
493
- <h4>Return Value</h4>
494
- <p class="para">A data response serializer.</p>
495
- </div>
496
- <div class="result-description view-on-github">
497
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L620">Show on GitHub</a>
498
- </div>
499
- </section>
500
- </div>
501
- </li>
502
- <li class="item symbol">
503
- <div class="task-group-term">
504
- <code>
505
- <a name="/s:C9Alamofire7Request10Serializer">
506
- <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
507
- </code>
508
- </div>
509
- <div class="height-container">
510
- <div class="pointy-thing-container"></div>
511
- <section class="section instance-method">
512
- <div class="pointy-thing"></div>
513
- <div class="abstract">
514
- <p class="para">A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</p>
515
- </div>
516
- <div class="declaration">
517
- <h4>Declaration</h4>
518
-
519
- <div class="Swift">
520
- <p class="aside-title">Swift</p>
521
- <p class="para">
522
- <code>public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -&gt; (AnyObject?, NSError?)</code>
523
- </p>
524
- </div>
525
- </div>
526
- <div class="result-description view-on-github">
527
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
528
- </div>
529
- </section>
530
- </div>
531
- </li>
141
+ </li>
142
+ <li class="part-name tasks">
143
+ <a href="../Protocols.html">Protocols</a>
144
+ <ul class="nav-chapters">
145
+ <li class="nav-chapter">
146
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
147
+ </li>
148
+ <li class="nav-chapter">
149
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
150
+ </li>
151
+ </ul>
152
+ </li>
153
+ </ul>
154
+ </nav>
155
+ <div class="pixel-line"></div>
156
+ <div class="rubber-band-gap"></div>
157
+ <article class="chapter">
158
+ <a name="/"></a>
159
+ <h1 class="chapter-name">Request</h1>
160
+ <section>
161
+ <section class="section">
162
+ <p class="para">Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying <code>NSURLSessionTask</code>.</p>
163
+ </section>
164
+ <section class="section task-group-section">
165
+ <div class="task-group">
166
+ <div class="task-name-container">
167
+ <a name="/Children"></a>
168
+ <a href="#/Children">
169
+ <h3 class="section-name"></h3>
170
+ </a>
171
+ </div>
172
+ <ul class="task-group-list">
532
173
  <li class="item symbol">
533
174
  <div class="task-group-term">
534
175
  <code>
@@ -562,174 +203,8 @@
562
203
  <li class="item symbol">
563
204
  <div class="task-group-term">
564
205
  <code>
565
- <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
566
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
567
- </code>
568
- </div>
569
- <div class="height-container">
570
- <div class="pointy-thing-container"></div>
571
- <section class="section instance-method">
572
- <div class="pointy-thing"></div>
573
- <div class="abstract">
574
- <p class="para">Associates a specified credential with the request.</p>
575
- </div>
576
- <div class="declaration">
577
- <h4>Declaration</h4>
578
-
579
- <div class="Swift">
580
- <p class="aside-title">Swift</p>
581
- <p class="para">
582
- <code>public func authenticate(usingCredential credential: NSURLCredential) -&gt; Self</code>
583
- </p>
584
- </div>
585
- </div>
586
- <div class="parameters">
587
- <h4>Parameters</h4>
588
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
589
- <tbody>
590
- <tr>
591
- <td scope="row">
592
- <code>
593
- <em class="term">credential</em>
594
- </code>
595
- </td>
596
- <td>
597
- <div class="definition">
598
- <p class="para">The credential.</p>
599
- </div>
600
- </td>
601
- </tr>
602
- </tbody>
603
- </table>
604
- </div>
605
- <div class="result-description">
606
- <h4>Return Value</h4>
607
- <p class="para">The request.</p>
608
- </div>
609
- <div class="result-description view-on-github">
610
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L578">Show on GitHub</a>
611
- </div>
612
- </section>
613
- </div>
614
- </li>
615
- <li class="item symbol">
616
- <div class="task-group-term">
617
- <code>
618
- <a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
619
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
620
- </code>
621
- </div>
622
- <div class="height-container">
623
- <div class="pointy-thing-container"></div>
624
- <section class="section instance-method">
625
- <div class="pointy-thing"></div>
626
- <div class="abstract">
627
- <p class="para">The progress of the request lifecycle.</p>
628
- </div>
629
- <div class="declaration">
630
- <h4>Declaration</h4>
631
-
632
- <div class="Swift">
633
- <p class="aside-title">Swift</p>
634
- <p class="para">
635
- <code>public var progress: NSProgress? { get }</code>
636
- </p>
637
- </div>
638
- </div>
639
- <div class="result-description view-on-github">
640
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
641
- </div>
642
- </section>
643
- </div>
644
- </li>
645
- <li class="item symbol">
646
- <div class="task-group-term">
647
- <code>
648
- <a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
649
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
650
- </code>
651
- </div>
652
- <div class="height-container">
653
- <div class="pointy-thing-container"></div>
654
- <section class="section instance-method">
655
- <div class="pointy-thing"></div>
656
- <div class="abstract">
657
- <p class="para">Adds a handler to be called once the request has finished.</p>
658
- </div>
659
- <div class="declaration">
660
- <h4>Declaration</h4>
661
-
662
- <div class="Swift">
663
- <p class="aside-title">Swift</p>
664
- <p class="para">
665
- <code>public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
666
- </p>
667
- </div>
668
- </div>
669
- <div class="parameters">
670
- <h4>Parameters</h4>
671
- <table class="graybox" border="0" cellspacing="0" cellpadding="5">
672
- <tbody>
673
- <tr>
674
- <td scope="row">
675
- <code>
676
- <em class="term">completionHandler</em>
677
- </code>
678
- </td>
679
- <td>
680
- <div class="definition">
681
- <p class="para">The code to be executed once the request has finished.</p>
682
- </div>
683
- </td>
684
- </tr>
685
- </tbody>
686
- </table>
687
- </div>
688
- <div class="result-description">
689
- <h4>Return Value</h4>
690
- <p class="para">The request.</p>
691
- </div>
692
- <div class="result-description view-on-github">
693
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L633">Show on GitHub</a>
694
- </div>
695
- </section>
696
- </div>
697
- </li>
698
- <li class="item symbol">
699
- <div class="task-group-term">
700
- <code>
701
- <a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
702
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
703
- </code>
704
- </div>
705
- <div class="height-container">
706
- <div class="pointy-thing-container"></div>
707
- <section class="section instance-method">
708
- <div class="pointy-thing"></div>
709
- <div class="abstract">
710
- <p class="para">The session belonging to the underlying task.</p>
711
- </div>
712
- <div class="declaration">
713
- <h4>Declaration</h4>
714
-
715
- <div class="Swift">
716
- <p class="aside-title">Swift</p>
717
- <p class="para">
718
- <code>public let session: NSURLSession</code>
719
- </p>
720
- </div>
721
- </div>
722
- <div class="result-description view-on-github">
723
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
724
- </div>
725
- </section>
726
- </div>
727
- </li>
728
- <li class="item symbol">
729
- <div class="task-group-term">
730
- <code>
731
- <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
732
- <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
206
+ <a name="/s:C9Alamofire7Request10Serializer">
207
+ <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
733
208
  </code>
734
209
  </div>
735
210
  <div class="height-container">
@@ -737,7 +212,7 @@
737
212
  <section class="section instance-method">
738
213
  <div class="pointy-thing"></div>
739
214
  <div class="abstract">
740
- <p class="para">The underlying task.</p>
215
+ <p class="para">A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</p>
741
216
  </div>
742
217
  <div class="declaration">
743
218
  <h4>Declaration</h4>
@@ -745,12 +220,12 @@
745
220
  <div class="Swift">
746
221
  <p class="aside-title">Swift</p>
747
222
  <p class="para">
748
- <code>public var task: NSURLSessionTask { get }</code>
223
+ <code>public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -&gt; (AnyObject?, NSError?)</code>
749
224
  </p>
750
225
  </div>
751
226
  </div>
752
227
  <div class="result-description view-on-github">
753
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
228
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
754
229
  </div>
755
230
  </section>
756
231
  </div>
@@ -875,26 +350,6 @@
875
350
  </section>
876
351
  </div>
877
352
  </li>
878
- <li class="item symbol">
879
- <div class="task-group-term">
880
- <code>
881
- <a name="/s:FC9Alamofire7RequestcFMS0_FT7sessionCSo12NSURLSession4taskCSo16NSURLSessionTask_S0_">
882
- <a class="x-instance-method Swift" href="#/s:FC9Alamofire7RequestcFMS0_FT7sessionCSo12NSURLSession4taskCSo16NSURLSessionTask_S0_">init(session:task:)</a>
883
- </code>
884
- </div>
885
- <div class="height-container">
886
- <div class="pointy-thing-container"></div>
887
- <section class="section instance-method">
888
- <div class="pointy-thing"></div>
889
- <div class="abstract">
890
- <p class="para">Undocumented</p>
891
- </div>
892
- <div class="result-description view-on-github">
893
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
894
- </div>
895
- </section>
896
- </div>
897
- </li>
898
353
  <li class="item symbol">
899
354
  <div class="task-group-term">
900
355
  <code>
@@ -1320,46 +775,6 @@
1320
775
  </section>
1321
776
  </div>
1322
777
  </li>
1323
- <li class="item symbol">
1324
- <div class="task-group-term">
1325
- <code>
1326
- <a name="/s:CC9Alamofire7Request12TaskDelegate">
1327
- <a class="x-instance-method Swift" href="#/s:CC9Alamofire7Request12TaskDelegate">TaskDelegate</a>
1328
- </code>
1329
- </div>
1330
- <div class="height-container">
1331
- <div class="pointy-thing-container"></div>
1332
- <section class="section instance-method">
1333
- <div class="pointy-thing"></div>
1334
- <div class="abstract">
1335
- <p class="para">Undocumented</p>
1336
- </div>
1337
- <div class="result-description view-on-github">
1338
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
1339
- </div>
1340
- </section>
1341
- </div>
1342
- </li>
1343
- <li class="item symbol">
1344
- <div class="task-group-term">
1345
- <code>
1346
- <a name="/s:CC9Alamofire7Request16DataTaskDelegate">
1347
- <a class="x-instance-method Swift" href="#/s:CC9Alamofire7Request16DataTaskDelegate">DataTaskDelegate</a>
1348
- </code>
1349
- </div>
1350
- <div class="height-container">
1351
- <div class="pointy-thing-container"></div>
1352
- <section class="section instance-method">
1353
- <div class="pointy-thing"></div>
1354
- <div class="abstract">
1355
- <p class="para">Undocumented</p>
1356
- </div>
1357
- <div class="result-description view-on-github">
1358
- <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
1359
- </div>
1360
- </section>
1361
- </div>
1362
- </li>
1363
778
  </ul>
1364
779
  </div>
1365
780
  </section>