jazzy 0.0.4 → 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -2
  3. data/.gitmodules +3 -0
  4. data/.rubocop.yml +67 -0
  5. data/.rubocop_todo.yml +16 -0
  6. data/.travis.yml +6 -0
  7. data/Gemfile +15 -7
  8. data/Gemfile.lock +62 -12
  9. data/LICENSE +0 -0
  10. data/README.md +39 -12
  11. data/Rakefile +87 -1
  12. data/bin/jazzy +10 -44
  13. data/bin/sourcekitten +0 -0
  14. data/jazzy.gemspec +16 -16
  15. data/lib/jazzy.rb +1 -159
  16. data/lib/jazzy/assets/css/jazzy.css +561 -0
  17. data/lib/{assets/Images/carat_2x.png → jazzy/assets/img/carat.png} +0 -0
  18. data/lib/jazzy/assets/img/dash.png +0 -0
  19. data/lib/jazzy/assets/img/gh.png +0 -0
  20. data/lib/jazzy/assets/js/jazzy.js +15 -0
  21. data/lib/jazzy/assets/js/jquery.min.js +4 -0
  22. data/lib/jazzy/config.rb +100 -0
  23. data/lib/jazzy/doc.mustache +46 -0
  24. data/lib/jazzy/doc.rb +23 -0
  25. data/lib/jazzy/doc_builder.rb +166 -0
  26. data/lib/jazzy/gem_version.rb +3 -0
  27. data/lib/jazzy/jazzy_markdown.rb +13 -0
  28. data/lib/jazzy/partials/footer.mustache +4 -0
  29. data/lib/jazzy/partials/nav.mustache +16 -0
  30. data/lib/jazzy/partials/parameter.mustache +12 -0
  31. data/lib/jazzy/partials/task.mustache +66 -0
  32. data/lib/jazzy/partials/tasks.mustache +7 -0
  33. data/lib/jazzy/source_declaration.rb +19 -0
  34. data/lib/jazzy/sourcekitten.rb +146 -0
  35. data/lib/jazzy/xml_helper.rb +15 -0
  36. data/screenshot.jpg +0 -0
  37. data/spec/.gitkeep +0 -0
  38. data/spec/integration_spec.rb +89 -0
  39. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +266 -0
  40. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +677 -0
  41. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/SessionDelegate.html +866 -0
  42. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/Singleton.html +246 -0
  43. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +1376 -0
  44. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/DataTaskDelegate.html +486 -0
  45. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/TaskDelegate.html +506 -0
  46. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +266 -0
  47. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +391 -0
  48. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +641 -0
  49. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +376 -0
  50. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURL.html +226 -0
  51. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLComponents.html +226 -0
  52. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLRequest.html +226 -0
  53. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +377 -0
  54. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/DownloadTaskDelegate.html +406 -0
  55. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/MIMEType.html +286 -0
  56. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/UploadTaskDelegate.html +266 -0
  57. data/spec/integration_specs/document_alamofire/after/docs/Extensions/String.html +226 -0
  58. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +1001 -0
  59. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +236 -0
  60. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +266 -0
  61. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +236 -0
  62. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +236 -0
  63. data/spec/integration_specs/document_alamofire/after/docs/Typealiases.html +266 -0
  64. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +561 -0
  65. data/spec/integration_specs/document_alamofire/after/docs/img/carat.png +0 -0
  66. data/spec/integration_specs/document_alamofire/after/docs/img/dash.png +0 -0
  67. data/spec/integration_specs/document_alamofire/after/docs/img/gh.png +0 -0
  68. data/spec/integration_specs/document_alamofire/after/docs/index.html +194 -0
  69. data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +15 -0
  70. data/spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js +4 -0
  71. data/spec/integration_specs/document_alamofire/after/execution_output.txt +2 -0
  72. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +317 -0
  73. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
  74. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +155 -0
  75. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +128 -0
  76. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +138 -0
  77. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +561 -0
  78. data/spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png +0 -0
  79. data/spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png +0 -0
  80. data/spec/integration_specs/misc_jazzy_features/after/docs/img/gh.png +0 -0
  81. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +99 -0
  82. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +15 -0
  83. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js +4 -0
  84. data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +2 -0
  85. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj +293 -0
  86. data/{parser/ASTDump.xcodeproj → spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj}/project.xcworkspace/contents.xcworkspacedata +1 -1
  87. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +60 -0
  88. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Info.plist +28 -0
  89. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/MiscJazzyFeatures.h +10 -0
  90. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes.html +317 -0
  91. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
  92. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums.html +155 -0
  93. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums/DocumentedEnum.html +128 -0
  94. data/spec/integration_specs/misc_jazzy_features/before/docs/Global Variables.html +138 -0
  95. data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +561 -0
  96. data/spec/integration_specs/misc_jazzy_features/before/docs/img/carat.png +0 -0
  97. data/spec/integration_specs/misc_jazzy_features/before/docs/img/dash.png +0 -0
  98. data/spec/integration_specs/misc_jazzy_features/before/docs/img/gh.png +0 -0
  99. data/spec/integration_specs/misc_jazzy_features/before/docs/index.html +99 -0
  100. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jazzy.js +15 -0
  101. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jquery.min.js +4 -0
  102. metadata +112 -76
  103. data/DEV_README.md +0 -35
  104. data/bin/ASTDump +0 -0
  105. data/bin/generate_swift_header.sh +0 -14
  106. data/lib/assets/CSS/style-1.1.15.css +0 -3366
  107. data/lib/assets/Images/apple2.png +0 -0
  108. data/lib/assets/Images/check.png +0 -0
  109. data/lib/assets/Images/class_node_parent_and_child_2x.png +0 -0
  110. data/lib/assets/Images/class_node_subclass_last_child_2x.png +0 -0
  111. data/lib/assets/Images/class_node_subclass_with_siblings_2x.png +0 -0
  112. data/lib/assets/Images/closebox_2x.png +0 -0
  113. data/lib/assets/Images/collection_last_child_2x.png +0 -0
  114. data/lib/assets/Images/collection_last_child_orphan_grandparent_2x.png +0 -0
  115. data/lib/assets/Images/collection_last_child_orphan_parent_2x.png +0 -0
  116. data/lib/assets/Images/collection_last_child_orphan_parent_and_grandparent_2x.png +0 -0
  117. data/lib/assets/Images/collection_node_2x.png +0 -0
  118. data/lib/assets/Images/collection_node_orphan_grandparent_2x.png +0 -0
  119. data/lib/assets/Images/collection_node_orphan_parent_2x.png +0 -0
  120. data/lib/assets/Images/collection_node_orphan_parent_and_grandparent_2x.png +0 -0
  121. data/lib/assets/Images/collection_node_parent_2x.png +0 -0
  122. data/lib/assets/Images/collection_node_parent_last_child_orphan_parent_2x.png +0 -0
  123. data/lib/assets/Images/collection_node_parent_orphan_parent_2x.png +0 -0
  124. data/lib/assets/Images/collection_parent_last_child_2x.png +0 -0
  125. data/lib/assets/Images/download_2x.png +0 -0
  126. data/lib/assets/Images/left_arrow_2x.png +0 -0
  127. data/lib/assets/Images/magnify_2x.png +0 -0
  128. data/lib/assets/Images/minus_2x.png +0 -0
  129. data/lib/assets/Images/playbutton.svg +0 -15
  130. data/lib/assets/Images/plus_2x.png +0 -0
  131. data/lib/assets/Images/right_arrow_2x.png +0 -0
  132. data/lib/assets/Images/search_2x.png +0 -0
  133. data/lib/assets/Images/shortstack_2x.png +0 -0
  134. data/lib/assets/JavaScript/devpubs-1.1.15.js +0 -1293
  135. data/lib/jazzy/jazzhtml.rb +0 -7
  136. data/lib/jazzy/klass.mustache +0 -150
  137. data/lib/jazzy/klass.rb +0 -23
  138. data/lib/jazzy/partials/klass-method.mustache +0 -70
  139. data/lib/jazzy/partials/klass-overview.mustache +0 -6
  140. data/lib/jazzy/partials/klass-property.mustache +0 -41
  141. data/parser/ASTDump.xcodeproj/project.pbxproj +0 -301
  142. data/parser/ASTDump.xcodeproj/project.xcworkspace/xcshareddata/ASTDump.xccheckout +0 -41
  143. data/parser/ASTDump.xcodeproj/project.xcworkspace/xcuserdata/ta.xcuserdatad/UserInterfaceState.xcuserstate +0 -0
  144. data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/ASTDump.xcscheme +0 -86
  145. data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/xcschememanagement.plist +0 -22
  146. data/parser/ASTDump/main.cpp +0 -71
  147. data/parser/clang-c/BuildSystem.h +0 -148
  148. data/parser/clang-c/CXCompilationDatabase.h +0 -170
  149. data/parser/clang-c/CXErrorCode.h +0 -64
  150. data/parser/clang-c/CXString.h +0 -61
  151. data/parser/clang-c/Documentation.h +0 -554
  152. data/parser/clang-c/Index.h +0 -5454
  153. data/parser/clang-c/Platform.h +0 -45
  154. data/sample/JAZMusician.h +0 -38
  155. data/sample/JAZMusician.m +0 -19
  156. data/sample/Musician.swift +0 -37
@@ -0,0 +1,246 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Singleton Struct Reference</title>
5
+ <link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
6
+ <meta charset='utf-8'>
7
+ <script src="../../js/jquery.min.js" defer></script>
8
+ <script src="../../js/jazzy.js" defer></script>
9
+ </head>
10
+ <body id="reference" class="Swift">
11
+ <a title="Singleton Struct Reference"></a>
12
+ <header>
13
+ <div class="content-wrapper">
14
+ <p class="header-text"><a href="#">Alamofire Docs</a></p>
15
+ <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>
16
+ <p id="header-links"><a href=""><img id="header-icon" src="../../img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
17
+ </div>
18
+ </header>
19
+ <section id="valence">
20
+ <div class="content-wrapper">
21
+ <p id="hierarchial_navigation">
22
+ <a href="#" id="design_resources_link">Alamofire Reference</a>
23
+ <img id="carat" src="../../img/carat.png" height="10px" width="6px" />
24
+ Singleton Struct Reference
25
+ </p>
26
+ </div>
27
+ </section>
28
+ <div class="content-wrapper">
29
+ <nav class="book-parts">
30
+ <ul class="nav-parts">
31
+ <li class="part-name tasks">
32
+ <a href="../../Classes.html">Classes</a>
33
+ <ul class="nav-chapters">
34
+ <li class="nav-chapter">
35
+ <a href="../../Classes/Manager.html">Manager</a>
36
+ </li>
37
+ <li class="nav-chapter">
38
+ <a href="../../Classes/Request.html">Request</a>
39
+ </li>
40
+ </ul>
41
+ </li>
42
+ <li class="part-name tasks">
43
+ <a href="../../Global Variables.html">Global Variables</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="../../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
47
+ </li>
48
+ </ul>
49
+ </li>
50
+ <li class="part-name tasks">
51
+ <a href="../../Enums.html">Enums</a>
52
+ <ul class="nav-chapters">
53
+ <li class="nav-chapter">
54
+ <a href="../../Enums.html#/s:O9Alamofire6Method">Method</a>
55
+ </li>
56
+ <li class="nav-chapter">
57
+ <a href="../../Enums/ParameterEncoding.html">ParameterEncoding</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="../../Extensions.html">Extensions</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="../../Extensions/String.html">String</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="../../Extensions/NSURL.html">NSURL</a>
69
+ </li>
70
+ <li class="nav-chapter">
71
+ <a href="../../Extensions/NSURLComponents.html">NSURLComponents</a>
72
+ </li>
73
+ <li class="nav-chapter">
74
+ <a href="../../Extensions/NSURLRequest.html">NSURLRequest</a>
75
+ </li>
76
+ <li class="nav-chapter">
77
+ <a href="../../Extensions/NSURLRequest.html">NSURLRequest</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../../Extensions/Request.html">Request</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../../Extensions/Manager.html">Manager</a>
84
+ </li>
85
+ <li class="nav-chapter">
86
+ <a href="../../Extensions/Request.html">Request</a>
87
+ </li>
88
+ <li class="nav-chapter">
89
+ <a href="../../Extensions/Manager.html">Manager</a>
90
+ </li>
91
+ <li class="nav-chapter">
92
+ <a href="../../Extensions/Request.html">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../../Extensions/Request.html">Request</a>
96
+ </li>
97
+ <li class="nav-chapter">
98
+ <a href="../../Extensions/Request.html">Request</a>
99
+ </li>
100
+ <li class="nav-chapter">
101
+ <a href="../../Extensions/Request.html">Request</a>
102
+ </li>
103
+ <li class="nav-chapter">
104
+ <a href="../../Extensions/Request.html">Request</a>
105
+ </li>
106
+ <li class="nav-chapter">
107
+ <a href="../../Extensions/Request.html">Request</a>
108
+ </li>
109
+ </ul>
110
+ </li>
111
+ <li class="part-name tasks">
112
+ <a href="../../Functions.html">Functions</a>
113
+ <ul class="nav-chapters">
114
+ <li class="nav-chapter">
115
+ <a href="../../Functions.html#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</a>
116
+ </li>
117
+ <li class="nav-chapter">
118
+ <a href="../../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
119
+ </li>
120
+ <li class="nav-chapter">
121
+ <a href="../../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
149
+ </li>
150
+ </ul>
151
+ </li>
152
+ <li class="part-name tasks">
153
+ <a href="../../Protocols.html">Protocols</a>
154
+ <ul class="nav-chapters">
155
+ <li class="nav-chapter">
156
+ <a href="../../Protocols/URLStringConvertible.html">URLStringConvertible</a>
157
+ </li>
158
+ <li class="nav-chapter">
159
+ <a href="../../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
160
+ </li>
161
+ </ul>
162
+ </li>
163
+ <li class="part-name tasks">
164
+ <a href="../../Typealiases.html">Typealiases</a>
165
+ <ul class="nav-chapters">
166
+ <li class="nav-chapter">
167
+ <a href="../../Typealiases.html#/s:C9Alamofire7Request10Validation">Validation</a>
168
+ </li>
169
+ <li class="nav-chapter">
170
+ <a href="../../Typealiases.html#/s:C9Alamofire7Request23DownloadFileDestination">DownloadFileDestination</a>
171
+ </li>
172
+ </ul>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <div class="pixel-line"></div>
177
+ <div class="rubber-band-gap"></div>
178
+ <article class="chapter">
179
+ <a name="/"></a>
180
+ <h1 class="chapter-name">Singleton</h1>
181
+ <section>
182
+ <section class="section">
183
+ <p class="para">Undocumented</p>
184
+ </section>
185
+ <section class="section task-group-section">
186
+ <div class="task-group">
187
+ <div class="task-name-container">
188
+ <a name="/Children"></a>
189
+ <a href="#/Children">
190
+ <h3 class="section-name"></h3>
191
+ </a>
192
+ </div>
193
+ <ul class="task-group-list">
194
+ <li class="item symbol">
195
+ <div class="task-group-term">
196
+ <code>
197
+ <a name="/s:vVFC9Alamofire7Managerg14sharedInstanceS0_L_9Singleton13configurationCSo25NSURLSessionConfiguration">
198
+ <a class="x-instance-method Swift" href="#/s:vVFC9Alamofire7Managerg14sharedInstanceS0_L_9Singleton13configurationCSo25NSURLSessionConfiguration">configuration</a>
199
+ </code>
200
+ </div>
201
+ <div class="height-container">
202
+ <div class="pointy-thing-container"></div>
203
+ <section class="section instance-method">
204
+ <div class="pointy-thing"></div>
205
+ <div class="abstract">
206
+ <p class="para">Undocumented</p>
207
+ </div>
208
+ <div class="result-description view-on-github">
209
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
210
+ </div>
211
+ </section>
212
+ </div>
213
+ </li>
214
+ <li class="item symbol">
215
+ <div class="task-group-term">
216
+ <code>
217
+ <a name="/s:vVFC9Alamofire7Managerg14sharedInstanceS0_L_9Singleton8instanceS0_">
218
+ <a class="x-instance-method Swift" href="#/s:vVFC9Alamofire7Managerg14sharedInstanceS0_L_9Singleton8instanceS0_">instance</a>
219
+ </code>
220
+ </div>
221
+ <div class="height-container">
222
+ <div class="pointy-thing-container"></div>
223
+ <section class="section instance-method">
224
+ <div class="pointy-thing"></div>
225
+ <div class="abstract">
226
+ <p class="para">Undocumented</p>
227
+ </div>
228
+ <div class="result-description view-on-github">
229
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
230
+ </div>
231
+ </section>
232
+ </div>
233
+ </li>
234
+ </ul>
235
+ </div>
236
+ </section>
237
+ </section>
238
+ <section id="footer">
239
+ <p class="copyright">&copy; 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
240
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.0.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
241
+ </section>
242
+ </article>
243
+ </div>
244
+ </body>
245
+ </div>
246
+ </html>
@@ -0,0 +1,1376 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Request Class Reference</title>
5
+ <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6
+ <meta charset='utf-8'>
7
+ <script src="../js/jquery.min.js" defer></script>
8
+ <script src="../js/jazzy.js" defer></script>
9
+ </head>
10
+ <body id="reference" class="Swift">
11
+ <a title="Request Class Reference"></a>
12
+ <header>
13
+ <div class="content-wrapper">
14
+ <p class="header-text"><a href="#">Alamofire Docs</a></p>
15
+ <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>
16
+ <p id="header-links"><a href=""><img id="header-icon" src="../img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
17
+ </div>
18
+ </header>
19
+ <section id="valence">
20
+ <div class="content-wrapper">
21
+ <p id="hierarchial_navigation">
22
+ <a href="#" id="design_resources_link">Alamofire Reference</a>
23
+ <img id="carat" src="../img/carat.png" height="10px" width="6px" />
24
+ Request Class Reference
25
+ </p>
26
+ </div>
27
+ </section>
28
+ <div class="content-wrapper">
29
+ <nav class="book-parts">
30
+ <ul class="nav-parts">
31
+ <li class="part-name tasks">
32
+ <a href="../Classes.html">Classes</a>
33
+ <ul class="nav-chapters">
34
+ <li class="nav-chapter">
35
+ <a href="../Classes/Manager.html">Manager</a>
36
+ </li>
37
+ <li class="nav-chapter">
38
+ <a href="../Classes/Request.html">Request</a>
39
+ </li>
40
+ </ul>
41
+ </li>
42
+ <li class="part-name tasks">
43
+ <a href="../Global Variables.html">Global Variables</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
47
+ </li>
48
+ </ul>
49
+ </li>
50
+ <li class="part-name tasks">
51
+ <a href="../Enums.html">Enums</a>
52
+ <ul class="nav-chapters">
53
+ <li class="nav-chapter">
54
+ <a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
55
+ </li>
56
+ <li class="nav-chapter">
57
+ <a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="../Extensions.html">Extensions</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="../Extensions/String.html">String</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="../Extensions/NSURL.html">NSURL</a>
69
+ </li>
70
+ <li class="nav-chapter">
71
+ <a href="../Extensions/NSURLComponents.html">NSURLComponents</a>
72
+ </li>
73
+ <li class="nav-chapter">
74
+ <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
75
+ </li>
76
+ <li class="nav-chapter">
77
+ <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../Extensions/Request.html">Request</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../Extensions/Manager.html">Manager</a>
84
+ </li>
85
+ <li class="nav-chapter">
86
+ <a href="../Extensions/Request.html">Request</a>
87
+ </li>
88
+ <li class="nav-chapter">
89
+ <a href="../Extensions/Manager.html">Manager</a>
90
+ </li>
91
+ <li class="nav-chapter">
92
+ <a href="../Extensions/Request.html">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../Extensions/Request.html">Request</a>
96
+ </li>
97
+ <li class="nav-chapter">
98
+ <a href="../Extensions/Request.html">Request</a>
99
+ </li>
100
+ <li class="nav-chapter">
101
+ <a href="../Extensions/Request.html">Request</a>
102
+ </li>
103
+ <li class="nav-chapter">
104
+ <a href="../Extensions/Request.html">Request</a>
105
+ </li>
106
+ <li class="nav-chapter">
107
+ <a href="../Extensions/Request.html">Request</a>
108
+ </li>
109
+ </ul>
110
+ </li>
111
+ <li class="part-name tasks">
112
+ <a href="../Functions.html">Functions</a>
113
+ <ul class="nav-chapters">
114
+ <li class="nav-chapter">
115
+ <a href="../Functions.html#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</a>
116
+ </li>
117
+ <li class="nav-chapter">
118
+ <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
119
+ </li>
120
+ <li class="nav-chapter">
121
+ <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
149
+ </li>
150
+ </ul>
151
+ </li>
152
+ <li class="part-name tasks">
153
+ <a href="../Protocols.html">Protocols</a>
154
+ <ul class="nav-chapters">
155
+ <li class="nav-chapter">
156
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
157
+ </li>
158
+ <li class="nav-chapter">
159
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
160
+ </li>
161
+ </ul>
162
+ </li>
163
+ <li class="part-name tasks">
164
+ <a href="../Typealiases.html">Typealiases</a>
165
+ <ul class="nav-chapters">
166
+ <li class="nav-chapter">
167
+ <a href="../Typealiases.html#/s:C9Alamofire7Request10Validation">Validation</a>
168
+ </li>
169
+ <li class="nav-chapter">
170
+ <a href="../Typealiases.html#/s:C9Alamofire7Request23DownloadFileDestination">DownloadFileDestination</a>
171
+ </li>
172
+ </ul>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <div class="pixel-line"></div>
177
+ <div class="rubber-band-gap"></div>
178
+ <article class="chapter">
179
+ <a name="/"></a>
180
+ <h1 class="chapter-name">Request</h1>
181
+ <section>
182
+ <section class="section">
183
+ <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>
184
+ </section>
185
+ <section class="section task-group-section">
186
+ <div class="task-group">
187
+ <div class="task-name-container">
188
+ <a name="/Children"></a>
189
+ <a href="#/Children">
190
+ <h3 class="section-name"></h3>
191
+ </a>
192
+ </div>
193
+ <ul class="task-group-list">
194
+ <li class="item symbol">
195
+ <div class="task-group-term">
196
+ <code>
197
+ <a name="/s:vC9Alamofire7RequestP33_A313450CFC1FC3D0CBEF4411412DB9E88delegateCS0_12TaskDelegate">
198
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7RequestP33_A313450CFC1FC3D0CBEF4411412DB9E88delegateCS0_12TaskDelegate">delegate</a>
199
+ </code>
200
+ </div>
201
+ <div class="height-container">
202
+ <div class="pointy-thing-container"></div>
203
+ <section class="section instance-method">
204
+ <div class="pointy-thing"></div>
205
+ <div class="abstract">
206
+ <p class="para">Undocumented</p>
207
+ </div>
208
+ <div class="result-description view-on-github">
209
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
210
+ </div>
211
+ </section>
212
+ </div>
213
+ </li>
214
+ <li class="item symbol">
215
+ <div class="task-group-term">
216
+ <code>
217
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
218
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
219
+ </code>
220
+ </div>
221
+ <div class="height-container">
222
+ <div class="pointy-thing-container"></div>
223
+ <section class="section instance-method">
224
+ <div class="pointy-thing"></div>
225
+ <div class="abstract">
226
+ <p class="para">Associates an HTTP Basic credential with the request.</p>
227
+ </div>
228
+ <div class="declaration">
229
+ <h4>Declaration</h4>
230
+
231
+ <div class="Swift">
232
+ <p class="aside-title">Swift</p>
233
+ <p class="para">
234
+ <code>public func authenticate(#user: String, password: String) -&gt; Self</code>
235
+ </p>
236
+ </div>
237
+ </div>
238
+ <div class="parameters">
239
+ <h4>Parameters</h4>
240
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
241
+ <tbody>
242
+ <tr>
243
+ <td scope="row">
244
+ <code>
245
+ <em class="term">user</em>
246
+ </code>
247
+ </td>
248
+ <td>
249
+ <div class="definition">
250
+ <p class="para">The user.</p>
251
+ </div>
252
+ </td>
253
+ </tr>
254
+ <tr>
255
+ <td scope="row">
256
+ <code>
257
+ <em class="term">password</em>
258
+ </code>
259
+ </td>
260
+ <td>
261
+ <div class="definition">
262
+ <p class="para">The password.</p>
263
+ </div>
264
+ </td>
265
+ </tr>
266
+ </tbody>
267
+ </table>
268
+ </div>
269
+ <div class="result-description">
270
+ <h4>Return Value</h4>
271
+ <p class="para">The request.</p>
272
+ </div>
273
+ <div class="result-description view-on-github">
274
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L565">Show on GitHub</a>
275
+ </div>
276
+ </section>
277
+ </div>
278
+ </li>
279
+ <li class="item symbol">
280
+ <div class="task-group-term">
281
+ <code>
282
+ <a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
283
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
284
+ </code>
285
+ </div>
286
+ <div class="height-container">
287
+ <div class="pointy-thing-container"></div>
288
+ <section class="section instance-method">
289
+ <div class="pointy-thing"></div>
290
+ <div class="abstract">
291
+ <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>
292
+ </div>
293
+ <div class="declaration">
294
+ <h4>Declaration</h4>
295
+
296
+ <div class="Swift">
297
+ <p class="aside-title">Swift</p>
298
+ <p class="para">
299
+ <code>public func progress(closure: ((Int64, Int64, Int64) -&gt; Void)? = default) -&gt; Self</code>
300
+ </p>
301
+ </div>
302
+ </div>
303
+ <div class="parameters">
304
+ <h4>Parameters</h4>
305
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
306
+ <tbody>
307
+ <tr>
308
+ <td scope="row">
309
+ <code>
310
+ <em class="term">closure</em>
311
+ </code>
312
+ </td>
313
+ <td>
314
+ <div class="definition">
315
+ <p class="para">The code to be executed periodically during the lifecycle of the request.</p>
316
+ </div>
317
+ </td>
318
+ </tr>
319
+ </tbody>
320
+ </table>
321
+ </div>
322
+ <div class="result-description">
323
+ <h4>Return Value</h4>
324
+ <p class="para">The request.</p>
325
+ </div>
326
+ <div class="result-description view-on-github">
327
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L596">Show on GitHub</a>
328
+ </div>
329
+ </section>
330
+ </div>
331
+ </li>
332
+ <li class="item symbol">
333
+ <div class="task-group-term">
334
+ <code>
335
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
336
+ <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>
337
+ </code>
338
+ </div>
339
+ <div class="height-container">
340
+ <div class="pointy-thing-container"></div>
341
+ <section class="section instance-method">
342
+ <div class="pointy-thing"></div>
343
+ <div class="abstract">
344
+ <p class="para">Adds a handler to be called once the request has finished.</p>
345
+ </div>
346
+ <div class="declaration">
347
+ <h4>Declaration</h4>
348
+
349
+ <div class="Swift">
350
+ <p class="aside-title">Swift</p>
351
+ <p class="para">
352
+ <code>public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
353
+ </p>
354
+ </div>
355
+ </div>
356
+ <div class="parameters">
357
+ <h4>Parameters</h4>
358
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
359
+ <tbody>
360
+ <tr>
361
+ <td scope="row">
362
+ <code>
363
+ <em class="term">queue</em>
364
+ </code>
365
+ </td>
366
+ <td>
367
+ <div class="definition">
368
+ <p class="para">The queue on which the completion handler is dispatched.</p>
369
+ </div>
370
+ </td>
371
+ </tr>
372
+ <tr>
373
+ <td scope="row">
374
+ <code>
375
+ <em class="term">serializer</em>
376
+ </code>
377
+ </td>
378
+ <td>
379
+ <div class="definition">
380
+ <p class="para">The closure responsible for serializing the request, response, and data.</p>
381
+ </div>
382
+ </td>
383
+ </tr>
384
+ <tr>
385
+ <td scope="row">
386
+ <code>
387
+ <em class="term">completionHandler</em>
388
+ </code>
389
+ </td>
390
+ <td>
391
+ <div class="definition">
392
+ <p class="para">The code to be executed once the request has finished.</p>
393
+ </div>
394
+ </td>
395
+ </tr>
396
+ </tbody>
397
+ </table>
398
+ </div>
399
+ <div class="result-description">
400
+ <h4>Return Value</h4>
401
+ <p class="para">The request.</p>
402
+ </div>
403
+ <div class="result-description view-on-github">
404
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L646">Show on GitHub</a>
405
+ </div>
406
+ </section>
407
+ </div>
408
+ </li>
409
+ <li class="item symbol">
410
+ <div class="task-group-term">
411
+ <code>
412
+ <a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
413
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
414
+ </code>
415
+ </div>
416
+ <div class="height-container">
417
+ <div class="pointy-thing-container"></div>
418
+ <section class="section instance-method">
419
+ <div class="pointy-thing"></div>
420
+ <div class="abstract">
421
+ <p class="para">The request sent or to be sent to the server.</p>
422
+ </div>
423
+ <div class="declaration">
424
+ <h4>Declaration</h4>
425
+
426
+ <div class="Swift">
427
+ <p class="aside-title">Swift</p>
428
+ <p class="para">
429
+ <code>public var request: NSURLRequest { get }</code>
430
+ </p>
431
+ </div>
432
+ </div>
433
+ <div class="result-description view-on-github">
434
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
435
+ </div>
436
+ </section>
437
+ </div>
438
+ </li>
439
+ <li class="item symbol">
440
+ <div class="task-group-term">
441
+ <code>
442
+ <a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
443
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
444
+ </code>
445
+ </div>
446
+ <div class="height-container">
447
+ <div class="pointy-thing-container"></div>
448
+ <section class="section instance-method">
449
+ <div class="pointy-thing"></div>
450
+ <div class="abstract">
451
+ <p class="para">The response received from the server, if any.</p>
452
+ </div>
453
+ <div class="declaration">
454
+ <h4>Declaration</h4>
455
+
456
+ <div class="Swift">
457
+ <p class="aside-title">Swift</p>
458
+ <p class="para">
459
+ <code>public var response: NSHTTPURLResponse? { get }</code>
460
+ </p>
461
+ </div>
462
+ </div>
463
+ <div class="result-description view-on-github">
464
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
465
+ </div>
466
+ </section>
467
+ </div>
468
+ </li>
469
+ <li class="item symbol">
470
+ <div class="task-group-term">
471
+ <code>
472
+ <a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
473
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
474
+ </code>
475
+ </div>
476
+ <div class="height-container">
477
+ <div class="pointy-thing-container"></div>
478
+ <section class="section instance-method">
479
+ <div class="pointy-thing"></div>
480
+ <div class="abstract">
481
+ <p class="para">Creates a response serializer that returns the associated data as-is.</p>
482
+ </div>
483
+ <div class="declaration">
484
+ <h4>Declaration</h4>
485
+
486
+ <div class="Swift">
487
+ <p class="aside-title">Swift</p>
488
+ <p class="para">
489
+ <code>public class func responseDataSerializer() -&gt; Serializer</code>
490
+ </p>
491
+ </div>
492
+ </div>
493
+ <div class="result-description">
494
+ <h4>Return Value</h4>
495
+ <p class="para">A data response serializer.</p>
496
+ </div>
497
+ <div class="result-description view-on-github">
498
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L620">Show on GitHub</a>
499
+ </div>
500
+ </section>
501
+ </div>
502
+ </li>
503
+ <li class="item symbol">
504
+ <div class="task-group-term">
505
+ <code>
506
+ <a name="/s:C9Alamofire7Request10Serializer">
507
+ <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
508
+ </code>
509
+ </div>
510
+ <div class="height-container">
511
+ <div class="pointy-thing-container"></div>
512
+ <section class="section instance-method">
513
+ <div class="pointy-thing"></div>
514
+ <div class="abstract">
515
+ <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>
516
+ </div>
517
+ <div class="declaration">
518
+ <h4>Declaration</h4>
519
+
520
+ <div class="Swift">
521
+ <p class="aside-title">Swift</p>
522
+ <p class="para">
523
+ <code>public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -&gt; (AnyObject?, NSError?)</code>
524
+ </p>
525
+ </div>
526
+ </div>
527
+ <div class="result-description view-on-github">
528
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
529
+ </div>
530
+ </section>
531
+ </div>
532
+ </li>
533
+ <li class="item symbol">
534
+ <div class="task-group-term">
535
+ <code>
536
+ <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
537
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
538
+ </code>
539
+ </div>
540
+ <div class="height-container">
541
+ <div class="pointy-thing-container"></div>
542
+ <section class="section instance-method">
543
+ <div class="pointy-thing"></div>
544
+ <div class="abstract">
545
+ <p class="para">The underlying task.</p>
546
+ </div>
547
+ <div class="declaration">
548
+ <h4>Declaration</h4>
549
+
550
+ <div class="Swift">
551
+ <p class="aside-title">Swift</p>
552
+ <p class="para">
553
+ <code>public var task: NSURLSessionTask { get }</code>
554
+ </p>
555
+ </div>
556
+ </div>
557
+ <div class="result-description view-on-github">
558
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
559
+ </div>
560
+ </section>
561
+ </div>
562
+ </li>
563
+ <li class="item symbol">
564
+ <div class="task-group-term">
565
+ <code>
566
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
567
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
568
+ </code>
569
+ </div>
570
+ <div class="height-container">
571
+ <div class="pointy-thing-container"></div>
572
+ <section class="section instance-method">
573
+ <div class="pointy-thing"></div>
574
+ <div class="abstract">
575
+ <p class="para">Associates a specified credential with the request.</p>
576
+ </div>
577
+ <div class="declaration">
578
+ <h4>Declaration</h4>
579
+
580
+ <div class="Swift">
581
+ <p class="aside-title">Swift</p>
582
+ <p class="para">
583
+ <code>public func authenticate(usingCredential credential: NSURLCredential) -&gt; Self</code>
584
+ </p>
585
+ </div>
586
+ </div>
587
+ <div class="parameters">
588
+ <h4>Parameters</h4>
589
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
590
+ <tbody>
591
+ <tr>
592
+ <td scope="row">
593
+ <code>
594
+ <em class="term">credential</em>
595
+ </code>
596
+ </td>
597
+ <td>
598
+ <div class="definition">
599
+ <p class="para">The credential.</p>
600
+ </div>
601
+ </td>
602
+ </tr>
603
+ </tbody>
604
+ </table>
605
+ </div>
606
+ <div class="result-description">
607
+ <h4>Return Value</h4>
608
+ <p class="para">The request.</p>
609
+ </div>
610
+ <div class="result-description view-on-github">
611
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L578">Show on GitHub</a>
612
+ </div>
613
+ </section>
614
+ </div>
615
+ </li>
616
+ <li class="item symbol">
617
+ <div class="task-group-term">
618
+ <code>
619
+ <a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
620
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
621
+ </code>
622
+ </div>
623
+ <div class="height-container">
624
+ <div class="pointy-thing-container"></div>
625
+ <section class="section instance-method">
626
+ <div class="pointy-thing"></div>
627
+ <div class="abstract">
628
+ <p class="para">The progress of the request lifecycle.</p>
629
+ </div>
630
+ <div class="declaration">
631
+ <h4>Declaration</h4>
632
+
633
+ <div class="Swift">
634
+ <p class="aside-title">Swift</p>
635
+ <p class="para">
636
+ <code>public var progress: NSProgress? { get }</code>
637
+ </p>
638
+ </div>
639
+ </div>
640
+ <div class="result-description view-on-github">
641
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
642
+ </div>
643
+ </section>
644
+ </div>
645
+ </li>
646
+ <li class="item symbol">
647
+ <div class="task-group-term">
648
+ <code>
649
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
650
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
651
+ </code>
652
+ </div>
653
+ <div class="height-container">
654
+ <div class="pointy-thing-container"></div>
655
+ <section class="section instance-method">
656
+ <div class="pointy-thing"></div>
657
+ <div class="abstract">
658
+ <p class="para">Adds a handler to be called once the request has finished.</p>
659
+ </div>
660
+ <div class="declaration">
661
+ <h4>Declaration</h4>
662
+
663
+ <div class="Swift">
664
+ <p class="aside-title">Swift</p>
665
+ <p class="para">
666
+ <code>public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
667
+ </p>
668
+ </div>
669
+ </div>
670
+ <div class="parameters">
671
+ <h4>Parameters</h4>
672
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
673
+ <tbody>
674
+ <tr>
675
+ <td scope="row">
676
+ <code>
677
+ <em class="term">completionHandler</em>
678
+ </code>
679
+ </td>
680
+ <td>
681
+ <div class="definition">
682
+ <p class="para">The code to be executed once the request has finished.</p>
683
+ </div>
684
+ </td>
685
+ </tr>
686
+ </tbody>
687
+ </table>
688
+ </div>
689
+ <div class="result-description">
690
+ <h4>Return Value</h4>
691
+ <p class="para">The request.</p>
692
+ </div>
693
+ <div class="result-description view-on-github">
694
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L633">Show on GitHub</a>
695
+ </div>
696
+ </section>
697
+ </div>
698
+ </li>
699
+ <li class="item symbol">
700
+ <div class="task-group-term">
701
+ <code>
702
+ <a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
703
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
704
+ </code>
705
+ </div>
706
+ <div class="height-container">
707
+ <div class="pointy-thing-container"></div>
708
+ <section class="section instance-method">
709
+ <div class="pointy-thing"></div>
710
+ <div class="abstract">
711
+ <p class="para">The session belonging to the underlying task.</p>
712
+ </div>
713
+ <div class="declaration">
714
+ <h4>Declaration</h4>
715
+
716
+ <div class="Swift">
717
+ <p class="aside-title">Swift</p>
718
+ <p class="para">
719
+ <code>public let session: NSURLSession</code>
720
+ </p>
721
+ </div>
722
+ </div>
723
+ <div class="result-description view-on-github">
724
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
725
+ </div>
726
+ </section>
727
+ </div>
728
+ </li>
729
+ <li class="item symbol">
730
+ <div class="task-group-term">
731
+ <code>
732
+ <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
733
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
734
+ </code>
735
+ </div>
736
+ <div class="height-container">
737
+ <div class="pointy-thing-container"></div>
738
+ <section class="section instance-method">
739
+ <div class="pointy-thing"></div>
740
+ <div class="abstract">
741
+ <p class="para">The underlying task.</p>
742
+ </div>
743
+ <div class="declaration">
744
+ <h4>Declaration</h4>
745
+
746
+ <div class="Swift">
747
+ <p class="aside-title">Swift</p>
748
+ <p class="para">
749
+ <code>public var task: NSURLSessionTask { get }</code>
750
+ </p>
751
+ </div>
752
+ </div>
753
+ <div class="result-description view-on-github">
754
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
755
+ </div>
756
+ </section>
757
+ </div>
758
+ </li>
759
+ <li class="item symbol">
760
+ <div class="task-group-term">
761
+ <code>
762
+ <a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
763
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
764
+ </code>
765
+ </div>
766
+ <div class="height-container">
767
+ <div class="pointy-thing-container"></div>
768
+ <section class="section instance-method">
769
+ <div class="pointy-thing"></div>
770
+ <div class="abstract">
771
+ <p class="para">The session belonging to the underlying task.</p>
772
+ </div>
773
+ <div class="declaration">
774
+ <h4>Declaration</h4>
775
+
776
+ <div class="Swift">
777
+ <p class="aside-title">Swift</p>
778
+ <p class="para">
779
+ <code>public let session: NSURLSession</code>
780
+ </p>
781
+ </div>
782
+ </div>
783
+ <div class="result-description view-on-github">
784
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
785
+ </div>
786
+ </section>
787
+ </div>
788
+ </li>
789
+ <li class="item symbol">
790
+ <div class="task-group-term">
791
+ <code>
792
+ <a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
793
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
794
+ </code>
795
+ </div>
796
+ <div class="height-container">
797
+ <div class="pointy-thing-container"></div>
798
+ <section class="section instance-method">
799
+ <div class="pointy-thing"></div>
800
+ <div class="abstract">
801
+ <p class="para">The request sent or to be sent to the server.</p>
802
+ </div>
803
+ <div class="declaration">
804
+ <h4>Declaration</h4>
805
+
806
+ <div class="Swift">
807
+ <p class="aside-title">Swift</p>
808
+ <p class="para">
809
+ <code>public var request: NSURLRequest { get }</code>
810
+ </p>
811
+ </div>
812
+ </div>
813
+ <div class="result-description view-on-github">
814
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
815
+ </div>
816
+ </section>
817
+ </div>
818
+ </li>
819
+ <li class="item symbol">
820
+ <div class="task-group-term">
821
+ <code>
822
+ <a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
823
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
824
+ </code>
825
+ </div>
826
+ <div class="height-container">
827
+ <div class="pointy-thing-container"></div>
828
+ <section class="section instance-method">
829
+ <div class="pointy-thing"></div>
830
+ <div class="abstract">
831
+ <p class="para">The response received from the server, if any.</p>
832
+ </div>
833
+ <div class="declaration">
834
+ <h4>Declaration</h4>
835
+
836
+ <div class="Swift">
837
+ <p class="aside-title">Swift</p>
838
+ <p class="para">
839
+ <code>public var response: NSHTTPURLResponse? { get }</code>
840
+ </p>
841
+ </div>
842
+ </div>
843
+ <div class="result-description view-on-github">
844
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
845
+ </div>
846
+ </section>
847
+ </div>
848
+ </li>
849
+ <li class="item symbol">
850
+ <div class="task-group-term">
851
+ <code>
852
+ <a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
853
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
854
+ </code>
855
+ </div>
856
+ <div class="height-container">
857
+ <div class="pointy-thing-container"></div>
858
+ <section class="section instance-method">
859
+ <div class="pointy-thing"></div>
860
+ <div class="abstract">
861
+ <p class="para">The progress of the request lifecycle.</p>
862
+ </div>
863
+ <div class="declaration">
864
+ <h4>Declaration</h4>
865
+
866
+ <div class="Swift">
867
+ <p class="aside-title">Swift</p>
868
+ <p class="para">
869
+ <code>public var progress: NSProgress? { get }</code>
870
+ </p>
871
+ </div>
872
+ </div>
873
+ <div class="result-description view-on-github">
874
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
875
+ </div>
876
+ </section>
877
+ </div>
878
+ </li>
879
+ <li class="item symbol">
880
+ <div class="task-group-term">
881
+ <code>
882
+ <a name="/s:FC9Alamofire7RequestcFMS0_FT7sessionCSo12NSURLSession4taskCSo16NSURLSessionTask_S0_">
883
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7RequestcFMS0_FT7sessionCSo12NSURLSession4taskCSo16NSURLSessionTask_S0_">init(session:task:)</a>
884
+ </code>
885
+ </div>
886
+ <div class="height-container">
887
+ <div class="pointy-thing-container"></div>
888
+ <section class="section instance-method">
889
+ <div class="pointy-thing"></div>
890
+ <div class="abstract">
891
+ <p class="para">Undocumented</p>
892
+ </div>
893
+ <div class="result-description view-on-github">
894
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
895
+ </div>
896
+ </section>
897
+ </div>
898
+ </li>
899
+ <li class="item symbol">
900
+ <div class="task-group-term">
901
+ <code>
902
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
903
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
904
+ </code>
905
+ </div>
906
+ <div class="height-container">
907
+ <div class="pointy-thing-container"></div>
908
+ <section class="section instance-method">
909
+ <div class="pointy-thing"></div>
910
+ <div class="abstract">
911
+ <p class="para">Associates an HTTP Basic credential with the request.</p>
912
+ </div>
913
+ <div class="declaration">
914
+ <h4>Declaration</h4>
915
+
916
+ <div class="Swift">
917
+ <p class="aside-title">Swift</p>
918
+ <p class="para">
919
+ <code>public func authenticate(#user: String, password: String) -&gt; Self</code>
920
+ </p>
921
+ </div>
922
+ </div>
923
+ <div class="parameters">
924
+ <h4>Parameters</h4>
925
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
926
+ <tbody>
927
+ <tr>
928
+ <td scope="row">
929
+ <code>
930
+ <em class="term">user</em>
931
+ </code>
932
+ </td>
933
+ <td>
934
+ <div class="definition">
935
+ <p class="para">The user.</p>
936
+ </div>
937
+ </td>
938
+ </tr>
939
+ <tr>
940
+ <td scope="row">
941
+ <code>
942
+ <em class="term">password</em>
943
+ </code>
944
+ </td>
945
+ <td>
946
+ <div class="definition">
947
+ <p class="para">The password.</p>
948
+ </div>
949
+ </td>
950
+ </tr>
951
+ </tbody>
952
+ </table>
953
+ </div>
954
+ <div class="result-description">
955
+ <h4>Return Value</h4>
956
+ <p class="para">The request.</p>
957
+ </div>
958
+ <div class="result-description view-on-github">
959
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L565">Show on GitHub</a>
960
+ </div>
961
+ </section>
962
+ </div>
963
+ </li>
964
+ <li class="item symbol">
965
+ <div class="task-group-term">
966
+ <code>
967
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
968
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
969
+ </code>
970
+ </div>
971
+ <div class="height-container">
972
+ <div class="pointy-thing-container"></div>
973
+ <section class="section instance-method">
974
+ <div class="pointy-thing"></div>
975
+ <div class="abstract">
976
+ <p class="para">Associates a specified credential with the request.</p>
977
+ </div>
978
+ <div class="declaration">
979
+ <h4>Declaration</h4>
980
+
981
+ <div class="Swift">
982
+ <p class="aside-title">Swift</p>
983
+ <p class="para">
984
+ <code>public func authenticate(usingCredential credential: NSURLCredential) -&gt; Self</code>
985
+ </p>
986
+ </div>
987
+ </div>
988
+ <div class="parameters">
989
+ <h4>Parameters</h4>
990
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
991
+ <tbody>
992
+ <tr>
993
+ <td scope="row">
994
+ <code>
995
+ <em class="term">credential</em>
996
+ </code>
997
+ </td>
998
+ <td>
999
+ <div class="definition">
1000
+ <p class="para">The credential.</p>
1001
+ </div>
1002
+ </td>
1003
+ </tr>
1004
+ </tbody>
1005
+ </table>
1006
+ </div>
1007
+ <div class="result-description">
1008
+ <h4>Return Value</h4>
1009
+ <p class="para">The request.</p>
1010
+ </div>
1011
+ <div class="result-description view-on-github">
1012
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L578">Show on GitHub</a>
1013
+ </div>
1014
+ </section>
1015
+ </div>
1016
+ </li>
1017
+ <li class="item symbol">
1018
+ <div class="task-group-term">
1019
+ <code>
1020
+ <a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
1021
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
1022
+ </code>
1023
+ </div>
1024
+ <div class="height-container">
1025
+ <div class="pointy-thing-container"></div>
1026
+ <section class="section instance-method">
1027
+ <div class="pointy-thing"></div>
1028
+ <div class="abstract">
1029
+ <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>
1030
+ </div>
1031
+ <div class="declaration">
1032
+ <h4>Declaration</h4>
1033
+
1034
+ <div class="Swift">
1035
+ <p class="aside-title">Swift</p>
1036
+ <p class="para">
1037
+ <code>public func progress(closure: ((Int64, Int64, Int64) -&gt; Void)? = default) -&gt; Self</code>
1038
+ </p>
1039
+ </div>
1040
+ </div>
1041
+ <div class="parameters">
1042
+ <h4>Parameters</h4>
1043
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
1044
+ <tbody>
1045
+ <tr>
1046
+ <td scope="row">
1047
+ <code>
1048
+ <em class="term">closure</em>
1049
+ </code>
1050
+ </td>
1051
+ <td>
1052
+ <div class="definition">
1053
+ <p class="para">The code to be executed periodically during the lifecycle of the request.</p>
1054
+ </div>
1055
+ </td>
1056
+ </tr>
1057
+ </tbody>
1058
+ </table>
1059
+ </div>
1060
+ <div class="result-description">
1061
+ <h4>Return Value</h4>
1062
+ <p class="para">The request.</p>
1063
+ </div>
1064
+ <div class="result-description view-on-github">
1065
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L596">Show on GitHub</a>
1066
+ </div>
1067
+ </section>
1068
+ </div>
1069
+ </li>
1070
+ <li class="item symbol">
1071
+ <div class="task-group-term">
1072
+ <code>
1073
+ <a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
1074
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
1075
+ </code>
1076
+ </div>
1077
+ <div class="height-container">
1078
+ <div class="pointy-thing-container"></div>
1079
+ <section class="section instance-method">
1080
+ <div class="pointy-thing"></div>
1081
+ <div class="abstract">
1082
+ <p class="para">Creates a response serializer that returns the associated data as-is.</p>
1083
+ </div>
1084
+ <div class="declaration">
1085
+ <h4>Declaration</h4>
1086
+
1087
+ <div class="Swift">
1088
+ <p class="aside-title">Swift</p>
1089
+ <p class="para">
1090
+ <code>public class func responseDataSerializer() -&gt; Serializer</code>
1091
+ </p>
1092
+ </div>
1093
+ </div>
1094
+ <div class="result-description">
1095
+ <h4>Return Value</h4>
1096
+ <p class="para">A data response serializer.</p>
1097
+ </div>
1098
+ <div class="result-description view-on-github">
1099
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L620">Show on GitHub</a>
1100
+ </div>
1101
+ </section>
1102
+ </div>
1103
+ </li>
1104
+ <li class="item symbol">
1105
+ <div class="task-group-term">
1106
+ <code>
1107
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
1108
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
1109
+ </code>
1110
+ </div>
1111
+ <div class="height-container">
1112
+ <div class="pointy-thing-container"></div>
1113
+ <section class="section instance-method">
1114
+ <div class="pointy-thing"></div>
1115
+ <div class="abstract">
1116
+ <p class="para">Adds a handler to be called once the request has finished.</p>
1117
+ </div>
1118
+ <div class="declaration">
1119
+ <h4>Declaration</h4>
1120
+
1121
+ <div class="Swift">
1122
+ <p class="aside-title">Swift</p>
1123
+ <p class="para">
1124
+ <code>public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
1125
+ </p>
1126
+ </div>
1127
+ </div>
1128
+ <div class="parameters">
1129
+ <h4>Parameters</h4>
1130
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
1131
+ <tbody>
1132
+ <tr>
1133
+ <td scope="row">
1134
+ <code>
1135
+ <em class="term">completionHandler</em>
1136
+ </code>
1137
+ </td>
1138
+ <td>
1139
+ <div class="definition">
1140
+ <p class="para">The code to be executed once the request has finished.</p>
1141
+ </div>
1142
+ </td>
1143
+ </tr>
1144
+ </tbody>
1145
+ </table>
1146
+ </div>
1147
+ <div class="result-description">
1148
+ <h4>Return Value</h4>
1149
+ <p class="para">The request.</p>
1150
+ </div>
1151
+ <div class="result-description view-on-github">
1152
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L633">Show on GitHub</a>
1153
+ </div>
1154
+ </section>
1155
+ </div>
1156
+ </li>
1157
+ <li class="item symbol">
1158
+ <div class="task-group-term">
1159
+ <code>
1160
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
1161
+ <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>
1162
+ </code>
1163
+ </div>
1164
+ <div class="height-container">
1165
+ <div class="pointy-thing-container"></div>
1166
+ <section class="section instance-method">
1167
+ <div class="pointy-thing"></div>
1168
+ <div class="abstract">
1169
+ <p class="para">Adds a handler to be called once the request has finished.</p>
1170
+ </div>
1171
+ <div class="declaration">
1172
+ <h4>Declaration</h4>
1173
+
1174
+ <div class="Swift">
1175
+ <p class="aside-title">Swift</p>
1176
+ <p class="para">
1177
+ <code>public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
1178
+ </p>
1179
+ </div>
1180
+ </div>
1181
+ <div class="parameters">
1182
+ <h4>Parameters</h4>
1183
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
1184
+ <tbody>
1185
+ <tr>
1186
+ <td scope="row">
1187
+ <code>
1188
+ <em class="term">queue</em>
1189
+ </code>
1190
+ </td>
1191
+ <td>
1192
+ <div class="definition">
1193
+ <p class="para">The queue on which the completion handler is dispatched.</p>
1194
+ </div>
1195
+ </td>
1196
+ </tr>
1197
+ <tr>
1198
+ <td scope="row">
1199
+ <code>
1200
+ <em class="term">serializer</em>
1201
+ </code>
1202
+ </td>
1203
+ <td>
1204
+ <div class="definition">
1205
+ <p class="para">The closure responsible for serializing the request, response, and data.</p>
1206
+ </div>
1207
+ </td>
1208
+ </tr>
1209
+ <tr>
1210
+ <td scope="row">
1211
+ <code>
1212
+ <em class="term">completionHandler</em>
1213
+ </code>
1214
+ </td>
1215
+ <td>
1216
+ <div class="definition">
1217
+ <p class="para">The code to be executed once the request has finished.</p>
1218
+ </div>
1219
+ </td>
1220
+ </tr>
1221
+ </tbody>
1222
+ </table>
1223
+ </div>
1224
+ <div class="result-description">
1225
+ <h4>Return Value</h4>
1226
+ <p class="para">The request.</p>
1227
+ </div>
1228
+ <div class="result-description view-on-github">
1229
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L646">Show on GitHub</a>
1230
+ </div>
1231
+ </section>
1232
+ </div>
1233
+ </li>
1234
+ <li class="item symbol">
1235
+ <div class="task-group-term">
1236
+ <code>
1237
+ <a name="/s:FC9Alamofire7Request7suspendFS0_FT_T_">
1238
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request7suspendFS0_FT_T_">suspend()</a>
1239
+ </code>
1240
+ </div>
1241
+ <div class="height-container">
1242
+ <div class="pointy-thing-container"></div>
1243
+ <section class="section instance-method">
1244
+ <div class="pointy-thing"></div>
1245
+ <div class="abstract">
1246
+ <p class="para">Suspends the request.</p>
1247
+ </div>
1248
+ <div class="declaration">
1249
+ <h4>Declaration</h4>
1250
+
1251
+ <div class="Swift">
1252
+ <p class="aside-title">Swift</p>
1253
+ <p class="para">
1254
+ <code>public func suspend()</code>
1255
+ </p>
1256
+ </div>
1257
+ </div>
1258
+ <div class="result-description view-on-github">
1259
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L661">Show on GitHub</a>
1260
+ </div>
1261
+ </section>
1262
+ </div>
1263
+ </li>
1264
+ <li class="item symbol">
1265
+ <div class="task-group-term">
1266
+ <code>
1267
+ <a name="/s:FC9Alamofire7Request6resumeFS0_FT_T_">
1268
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6resumeFS0_FT_T_">resume()</a>
1269
+ </code>
1270
+ </div>
1271
+ <div class="height-container">
1272
+ <div class="pointy-thing-container"></div>
1273
+ <section class="section instance-method">
1274
+ <div class="pointy-thing"></div>
1275
+ <div class="abstract">
1276
+ <p class="para">Resumes the request.</p>
1277
+ </div>
1278
+ <div class="declaration">
1279
+ <h4>Declaration</h4>
1280
+
1281
+ <div class="Swift">
1282
+ <p class="aside-title">Swift</p>
1283
+ <p class="para">
1284
+ <code>public func resume()</code>
1285
+ </p>
1286
+ </div>
1287
+ </div>
1288
+ <div class="result-description view-on-github">
1289
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L668">Show on GitHub</a>
1290
+ </div>
1291
+ </section>
1292
+ </div>
1293
+ </li>
1294
+ <li class="item symbol">
1295
+ <div class="task-group-term">
1296
+ <code>
1297
+ <a name="/s:FC9Alamofire7Request6cancelFS0_FT_T_">
1298
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6cancelFS0_FT_T_">cancel()</a>
1299
+ </code>
1300
+ </div>
1301
+ <div class="height-container">
1302
+ <div class="pointy-thing-container"></div>
1303
+ <section class="section instance-method">
1304
+ <div class="pointy-thing"></div>
1305
+ <div class="abstract">
1306
+ <p class="para">Cancels the request.</p>
1307
+ </div>
1308
+ <div class="declaration">
1309
+ <h4>Declaration</h4>
1310
+
1311
+ <div class="Swift">
1312
+ <p class="aside-title">Swift</p>
1313
+ <p class="para">
1314
+ <code>public func cancel()</code>
1315
+ </p>
1316
+ </div>
1317
+ </div>
1318
+ <div class="result-description view-on-github">
1319
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L675">Show on GitHub</a>
1320
+ </div>
1321
+ </section>
1322
+ </div>
1323
+ </li>
1324
+ <li class="item symbol">
1325
+ <div class="task-group-term">
1326
+ <code>
1327
+ <a name="/s:CC9Alamofire7Request12TaskDelegate">
1328
+ <a class="x-instance-method Swift" href="#/s:CC9Alamofire7Request12TaskDelegate">TaskDelegate</a>
1329
+ </code>
1330
+ </div>
1331
+ <div class="height-container">
1332
+ <div class="pointy-thing-container"></div>
1333
+ <section class="section instance-method">
1334
+ <div class="pointy-thing"></div>
1335
+ <div class="abstract">
1336
+ <p class="para">Undocumented</p>
1337
+ </div>
1338
+ <div class="result-description view-on-github">
1339
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
1340
+ </div>
1341
+ </section>
1342
+ </div>
1343
+ </li>
1344
+ <li class="item symbol">
1345
+ <div class="task-group-term">
1346
+ <code>
1347
+ <a name="/s:CC9Alamofire7Request16DataTaskDelegate">
1348
+ <a class="x-instance-method Swift" href="#/s:CC9Alamofire7Request16DataTaskDelegate">DataTaskDelegate</a>
1349
+ </code>
1350
+ </div>
1351
+ <div class="height-container">
1352
+ <div class="pointy-thing-container"></div>
1353
+ <section class="section instance-method">
1354
+ <div class="pointy-thing"></div>
1355
+ <div class="abstract">
1356
+ <p class="para">Undocumented</p>
1357
+ </div>
1358
+ <div class="result-description view-on-github">
1359
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
1360
+ </div>
1361
+ </section>
1362
+ </div>
1363
+ </li>
1364
+ </ul>
1365
+ </div>
1366
+ </section>
1367
+ </section>
1368
+ <section id="footer">
1369
+ <p class="copyright">&copy; 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
1370
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.0.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1371
+ </section>
1372
+ </article>
1373
+ </div>
1374
+ </body>
1375
+ </div>
1376
+ </html>