jazzy 0.0.15 → 0.0.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +7 -5
  3. data/Rakefile +2 -0
  4. data/bin/jazzy +1 -1
  5. data/jazzy.gemspec +1 -0
  6. data/lib/jazzy.rb +1 -0
  7. data/lib/jazzy/assets/css/highlight.css.scss +63 -0
  8. data/lib/jazzy/assets/css/jazzy.css.scss +27 -1
  9. data/lib/jazzy/assets/js/jazzy.js +8 -2
  10. data/lib/jazzy/config.rb +32 -0
  11. data/lib/jazzy/doc.mustache +15 -1
  12. data/lib/jazzy/doc_builder.rb +24 -12
  13. data/lib/jazzy/docset_builder.rb +77 -0
  14. data/lib/jazzy/docset_builder/info_plist.mustache +20 -0
  15. data/lib/jazzy/gem_version.rb +1 -1
  16. data/lib/jazzy/highlighter.rb +10 -0
  17. data/lib/jazzy/partials/task.mustache +3 -3
  18. data/lib/jazzy/source_declaration.rb +3 -3
  19. data/lib/jazzy/source_declaration/type.rb +136 -0
  20. data/lib/jazzy/source_module.rb +10 -0
  21. data/lib/jazzy/sourcekitten.rb +35 -62
  22. data/logo.sketch +0 -0
  23. data/spec/integration_spec.rb +10 -0
  24. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Info.plist +20 -0
  25. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes.html +267 -0
  26. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager.html +488 -0
  27. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager/init(configuration:).html +218 -0
  28. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html +841 -0
  29. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums.html +257 -0
  30. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums/ParameterEncoding.html +346 -0
  31. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions.html +708 -0
  32. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Manager.html +344 -0
  33. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Request.html +368 -0
  34. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Functions.html +1040 -0
  35. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Global Variables.html +226 -0
  36. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager.html +344 -0
  37. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager/init(configuration:).html +218 -0
  38. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/ParameterEncoding.html +346 -0
  39. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols.html +275 -0
  40. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLRequestConvertible.html +227 -0
  41. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html +227 -0
  42. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Request.html +368 -0
  43. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLRequestConvertible.html +227 -0
  44. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLStringConvertible.html +227 -0
  45. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/carat.png +0 -0
  46. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/highlight.css +202 -0
  47. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
  48. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/dash.png +0 -0
  49. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/gh.png +0 -0
  50. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/highlight.css +202 -0
  51. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/carat.png +0 -0
  52. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/dash.png +0 -0
  53. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/gh.png +0 -0
  54. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/index.html +755 -0
  55. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/init(configuration:).html +218 -0
  56. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.css +708 -0
  57. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.js +21 -0
  58. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jquery.min.js +4 -0
  59. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
  60. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
  61. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/docSet.dsidx.csv +81 -0
  62. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +18 -7
  63. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +31 -19
  64. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html +14 -1
  65. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +61 -46
  66. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +18 -7
  67. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +20 -4
  68. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +68 -48
  69. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +21 -7
  70. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +22 -10
  71. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +51 -34
  72. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +15 -4
  73. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +20 -7
  74. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +16 -4
  75. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +16 -4
  76. data/spec/integration_specs/document_alamofire/after/docs/css/highlight.css +202 -0
  77. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +14 -0
  78. data/spec/integration_specs/document_alamofire/after/docs/index.html +53 -42
  79. data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +8 -2
  80. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +34 -22
  81. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +16 -4
  82. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +16 -4
  83. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +14 -1
  84. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +16 -4
  85. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Info.plist +20 -0
  86. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes.html +309 -0
  87. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +143 -0
  88. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/DocumentedEnum.html +134 -0
  89. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums.html +147 -0
  90. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +134 -0
  91. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Global Variables.html +146 -0
  92. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/ImplicitlyInternalTopLevelClass.html +143 -0
  93. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/carat.png +0 -0
  94. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/highlight.css +202 -0
  95. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
  96. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/dash.png +0 -0
  97. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/gh.png +0 -0
  98. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/highlight.css +202 -0
  99. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/carat.png +0 -0
  100. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/dash.png +0 -0
  101. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/gh.png +0 -0
  102. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +106 -0
  103. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.css +708 -0
  104. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.js +21 -0
  105. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js +4 -0
  106. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
  107. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
  108. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +15 -0
  109. data/spec/integration_specs/misc_jazzy_features/after/docs/css/highlight.css +202 -0
  110. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +14 -0
  111. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +12 -1
  112. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +8 -2
  113. metadata +88 -5
  114. data/lib/jazzy/assets/css/github_syntax_highlighting.css.scss +0 -142
  115. data/spec/integration_specs/document_alamofire/after/docs/css/github_syntax_highlighting.css +0 -98
  116. data/spec/integration_specs/misc_jazzy_features/after/docs/css/github_syntax_highlighting.css +0 -98
data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager/init(configuration:).html ADDED
@@ -0,0 +1,218 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>init(configuration:) Instance Method Reference</title>
5
+ <link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
6
+ <link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
7
+ <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
19
+ <script src="../../js/jquery.min.js" defer></script>
20
+ <script src="../../js/jazzy.js" defer></script>
21
+ </head>
22
+ <body id="reference" class="Swift">
23
+ <a name="//apple_ref/swift/Method/init(configuration:)" class="dashAnchor"></a>
24
+ <a title="init(configuration:) Instance Method Reference"></a>
25
+ <header>
26
+ <div class="content-wrapper">
27
+ <p class="header-text"><a href="../../index.html">Alamofire Docs</a> (40% documented)</p>
28
+ <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>
29
+ </div>
30
+ </header>
31
+ <section id="valence">
32
+ <div class="content-wrapper">
33
+ <p id="hierarchial_navigation">
34
+ <a href="../../index.html" id="design_resources_link">Alamofire Reference</a>
35
+ <img id="carat" src="../../img/carat.png" height="10px" width="6px" />
36
+ init(configuration:) Instance Method Reference
37
+ </p>
38
+ </div>
39
+ </section>
40
+ <div class="content-wrapper">
41
+ <nav class="book-parts">
42
+ <ul class="nav-parts">
43
+ <li class="part-name tasks">
44
+ <a href="../../Classes.html">Classes</a>
45
+ <ul class="nav-chapters">
46
+ <li class="nav-chapter">
47
+ <a href="../../Classes/Manager.html">Manager</a>
48
+ </li>
49
+ <li class="nav-chapter">
50
+ <a href="../../Classes/Request.html">Request</a>
51
+ </li>
52
+ </ul>
53
+ </li>
54
+ <li class="part-name tasks">
55
+ <a href="../../Global Variables.html">Global Variables</a>
56
+ <ul class="nav-chapters">
57
+ <li class="nav-chapter">
58
+ <a href="../../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
59
+ </li>
60
+ </ul>
61
+ </li>
62
+ <li class="part-name tasks">
63
+ <a href="../../Enums.html">Enums</a>
64
+ <ul class="nav-chapters">
65
+ <li class="nav-chapter">
66
+ <a href="../../Enums.html#/s:O9Alamofire6Method">Method</a>
67
+ </li>
68
+ <li class="nav-chapter">
69
+ <a href="../../Enums/ParameterEncoding.html">ParameterEncoding</a>
70
+ </li>
71
+ </ul>
72
+ </li>
73
+ <li class="part-name tasks">
74
+ <a href="../../Extensions.html">Extensions</a>
75
+ <ul class="nav-chapters">
76
+ <li class="nav-chapter">
77
+ <a href="../../Extensions.html#/s:SS">String</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</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.html#/s:C9Alamofire7Request">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../../Extensions/Manager.html">Manager</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
+ <li class="nav-chapter">
110
+ <a href="../../Extensions/Request.html">Request</a>
111
+ </li>
112
+ <li class="nav-chapter">
113
+ <a href="../../Extensions/Request.html">Request</a>
114
+ </li>
115
+ </ul>
116
+ </li>
117
+ <li class="part-name tasks">
118
+ <a href="../../Functions.html">Functions</a>
119
+ <ul class="nav-chapters">
120
+ <li class="nav-chapter">
121
+ <a href="../../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
149
+ </li>
150
+ <li class="nav-chapter">
151
+ <a href="../../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
152
+ </li>
153
+ </ul>
154
+ </li>
155
+ <li class="part-name tasks">
156
+ <a href="../../Protocols.html">Protocols</a>
157
+ <ul class="nav-chapters">
158
+ <li class="nav-chapter">
159
+ <a href="../../Protocols/URLStringConvertible.html">URLStringConvertible</a>
160
+ </li>
161
+ <li class="nav-chapter">
162
+ <a href="../../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
163
+ </li>
164
+ </ul>
165
+ </li>
166
+ </ul>
167
+ </nav>
168
+ <div class="pixel-line"></div>
169
+ <div class="rubber-band-gap"></div>
170
+ <article class="chapter">
171
+ <a name="/"></a>
172
+ <h1 class="chapter-name">init(configuration:)</h1>
173
+ <section>
174
+ <section class="section">
175
+
176
+ </section>
177
+ <section class="section task-group-section">
178
+ <div class="task-group">
179
+ <div class="task-name-container">
180
+
181
+ <a name="/Unnamed"></a>
182
+
183
+ </div>
184
+ <ul class="task-group-list">
185
+ <li class="item symbol">
186
+ <div class="task-group-term">
187
+ <code>
188
+ <a name="/s:vFC9Alamofire7ManagercFMS0_FT13configurationGSqCSo25NSURLSessionConfiguration__S0_L_13configurationGSqS1__">
189
+ <a name="//apple_ref/swift/Variable/configuration" class="dashAnchor"></a>
190
+ <a class="x-instance-method Swift" href="#/s:vFC9Alamofire7ManagercFMS0_FT13configurationGSqCSo25NSURLSessionConfiguration__S0_L_13configurationGSqS1__">configuration</a>
191
+ </code>
192
+ </div>
193
+ <div class="height-container">
194
+ <div class="pointy-thing-container"></div>
195
+ <section class="section instance-method">
196
+ <div class="pointy-thing"></div>
197
+ <div class="abstract">
198
+ <p class="para">Undocumented</p>
199
+ </div>
200
+ <div class="result-description view-on-github">
201
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
202
+ </div>
203
+ </section>
204
+ </div>
205
+ </li>
206
+ </ul>
207
+ </div>
208
+ </section>
209
+ </section>
210
+ <section id="footer">
211
+ <p class="copyright">&copy; YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
212
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
213
+ </section>
214
+ </article>
215
+ </div>
216
+ </body>
217
+ </div>
218
+ </html>
data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html ADDED
@@ -0,0 +1,841 @@
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
+ <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7
+ <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
19
+ <script src="../js/jquery.min.js" defer></script>
20
+ <script src="../js/jazzy.js" defer></script>
21
+ </head>
22
+ <body id="reference" class="Swift">
23
+ <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
24
+ <a title="Request Class Reference"></a>
25
+ <header>
26
+ <div class="content-wrapper">
27
+ <p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
28
+ <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>
29
+ </div>
30
+ </header>
31
+ <section id="valence">
32
+ <div class="content-wrapper">
33
+ <p id="hierarchial_navigation">
34
+ <a href="../index.html" id="design_resources_link">Alamofire Reference</a>
35
+ <img id="carat" src="../img/carat.png" height="10px" width="6px" />
36
+ Request Class Reference
37
+ </p>
38
+ </div>
39
+ </section>
40
+ <div class="content-wrapper">
41
+ <nav class="book-parts">
42
+ <ul class="nav-parts">
43
+ <li class="part-name tasks">
44
+ <a href="../Classes.html">Classes</a>
45
+ <ul class="nav-chapters">
46
+ <li class="nav-chapter">
47
+ <a href="../Classes/Manager.html">Manager</a>
48
+ </li>
49
+ <li class="nav-chapter">
50
+ <a href="../Classes/Request.html">Request</a>
51
+ </li>
52
+ </ul>
53
+ </li>
54
+ <li class="part-name tasks">
55
+ <a href="../Global Variables.html">Global Variables</a>
56
+ <ul class="nav-chapters">
57
+ <li class="nav-chapter">
58
+ <a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
59
+ </li>
60
+ </ul>
61
+ </li>
62
+ <li class="part-name tasks">
63
+ <a href="../Enums.html">Enums</a>
64
+ <ul class="nav-chapters">
65
+ <li class="nav-chapter">
66
+ <a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
67
+ </li>
68
+ <li class="nav-chapter">
69
+ <a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
70
+ </li>
71
+ </ul>
72
+ </li>
73
+ <li class="part-name tasks">
74
+ <a href="../Extensions.html">Extensions</a>
75
+ <ul class="nav-chapters">
76
+ <li class="nav-chapter">
77
+ <a href="../Extensions.html#/s:SS">String</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</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.html#/s:C9Alamofire7Request">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../Extensions/Manager.html">Manager</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
+ <li class="nav-chapter">
110
+ <a href="../Extensions/Request.html">Request</a>
111
+ </li>
112
+ <li class="nav-chapter">
113
+ <a href="../Extensions/Request.html">Request</a>
114
+ </li>
115
+ </ul>
116
+ </li>
117
+ <li class="part-name tasks">
118
+ <a href="../Functions.html">Functions</a>
119
+ <ul class="nav-chapters">
120
+ <li class="nav-chapter">
121
+ <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
149
+ </li>
150
+ <li class="nav-chapter">
151
+ <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
152
+ </li>
153
+ </ul>
154
+ </li>
155
+ <li class="part-name tasks">
156
+ <a href="../Protocols.html">Protocols</a>
157
+ <ul class="nav-chapters">
158
+ <li class="nav-chapter">
159
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
160
+ </li>
161
+ <li class="nav-chapter">
162
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
163
+ </li>
164
+ </ul>
165
+ </li>
166
+ </ul>
167
+ </nav>
168
+ <div class="pixel-line"></div>
169
+ <div class="rubber-band-gap"></div>
170
+ <article class="chapter">
171
+ <a name="/"></a>
172
+ <h1 class="chapter-name">Request</h1>
173
+ <section>
174
+ <section class="section">
175
+ <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>
176
+ </section>
177
+ <section class="section task-group-section">
178
+ <div class="task-group">
179
+ <div class="task-name-container">
180
+
181
+ <a name="/Unnamed"></a>
182
+
183
+ </div>
184
+ <ul class="task-group-list">
185
+ <li class="item symbol">
186
+ <div class="task-group-term">
187
+ <code>
188
+ <a name="/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">
189
+ <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
190
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request4taskCSo16NSURLSessionTask">task</a>
191
+ </code>
192
+ </div>
193
+ <div class="height-container">
194
+ <div class="pointy-thing-container"></div>
195
+ <section class="section instance-method">
196
+ <div class="pointy-thing"></div>
197
+ <div class="abstract">
198
+ <p class="para">The underlying task.</p>
199
+ </div>
200
+ <div class="declaration">
201
+ <h4>Declaration</h4>
202
+
203
+ <div class="Swift">
204
+ <p class="aside-title">Swift</p>
205
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">NSURLSessionTask</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
206
+
207
+ </div>
208
+ </div>
209
+ <div class="result-description view-on-github">
210
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L526">Show on GitHub</a>
211
+ </div>
212
+ </section>
213
+ </div>
214
+ </li>
215
+ <li class="item symbol">
216
+ <div class="task-group-term">
217
+ <code>
218
+ <a name="/s:C9Alamofire7Request10Serializer">
219
+ <a name="//apple_ref/swift/Alias/Serializer" class="dashAnchor"></a>
220
+ <a class="x-instance-method Swift" href="#/s:C9Alamofire7Request10Serializer">Serializer</a>
221
+ </code>
222
+ </div>
223
+ <div class="height-container">
224
+ <div class="pointy-thing-container"></div>
225
+ <section class="section instance-method">
226
+ <div class="pointy-thing"></div>
227
+ <div class="abstract">
228
+ <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>
229
+ </div>
230
+ <div class="declaration">
231
+ <h4>Declaration</h4>
232
+
233
+ <div class="Swift">
234
+ <p class="aside-title">Swift</p>
235
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Serializer</span> <span class="o">=</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">NSData</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
236
+
237
+ </div>
238
+ </div>
239
+ <div class="result-description view-on-github">
240
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L613">Show on GitHub</a>
241
+ </div>
242
+ </section>
243
+ </div>
244
+ </li>
245
+ <li class="item symbol">
246
+ <div class="task-group-term">
247
+ <code>
248
+ <a name="/s:vC9Alamofire7Request7sessionCSo12NSURLSession">
249
+ <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
250
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7sessionCSo12NSURLSession">session</a>
251
+ </code>
252
+ </div>
253
+ <div class="height-container">
254
+ <div class="pointy-thing-container"></div>
255
+ <section class="section instance-method">
256
+ <div class="pointy-thing"></div>
257
+ <div class="abstract">
258
+ <p class="para">The session belonging to the underlying task.</p>
259
+ </div>
260
+ <div class="declaration">
261
+ <h4>Declaration</h4>
262
+
263
+ <div class="Swift">
264
+ <p class="aside-title">Swift</p>
265
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">NSURLSession</span></code></pre>
266
+
267
+ </div>
268
+ </div>
269
+ <div class="result-description view-on-github">
270
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L529">Show on GitHub</a>
271
+ </div>
272
+ </section>
273
+ </div>
274
+ </li>
275
+ <li class="item symbol">
276
+ <div class="task-group-term">
277
+ <code>
278
+ <a name="/s:vC9Alamofire7Request7requestCSo12NSURLRequest">
279
+ <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
280
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request7requestCSo12NSURLRequest">request</a>
281
+ </code>
282
+ </div>
283
+ <div class="height-container">
284
+ <div class="pointy-thing-container"></div>
285
+ <section class="section instance-method">
286
+ <div class="pointy-thing"></div>
287
+ <div class="abstract">
288
+ <p class="para">The request sent or to be sent to the server.</p>
289
+ </div>
290
+ <div class="declaration">
291
+ <h4>Declaration</h4>
292
+
293
+ <div class="Swift">
294
+ <p class="aside-title">Swift</p>
295
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">NSURLRequest</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
296
+
297
+ </div>
298
+ </div>
299
+ <div class="result-description view-on-github">
300
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L532">Show on GitHub</a>
301
+ </div>
302
+ </section>
303
+ </div>
304
+ </li>
305
+ <li class="item symbol">
306
+ <div class="task-group-term">
307
+ <code>
308
+ <a name="/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">
309
+ <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
310
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_">response</a>
311
+ </code>
312
+ </div>
313
+ <div class="height-container">
314
+ <div class="pointy-thing-container"></div>
315
+ <section class="section instance-method">
316
+ <div class="pointy-thing"></div>
317
+ <div class="abstract">
318
+ <p class="para">The response received from the server, if any.</p>
319
+ </div>
320
+ <div class="declaration">
321
+ <h4>Declaration</h4>
322
+
323
+ <div class="Swift">
324
+ <p class="aside-title">Swift</p>
325
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
326
+
327
+ </div>
328
+ </div>
329
+ <div class="result-description view-on-github">
330
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L535">Show on GitHub</a>
331
+ </div>
332
+ </section>
333
+ </div>
334
+ </li>
335
+ <li class="item symbol">
336
+ <div class="task-group-term">
337
+ <code>
338
+ <a name="/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">
339
+ <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
340
+ <a class="x-instance-method Swift" href="#/s:vC9Alamofire7Request8progressGSqCSo10NSProgress_">progress</a>
341
+ </code>
342
+ </div>
343
+ <div class="height-container">
344
+ <div class="pointy-thing-container"></div>
345
+ <section class="section instance-method">
346
+ <div class="pointy-thing"></div>
347
+ <div class="abstract">
348
+ <p class="para">The progress of the request lifecycle.</p>
349
+ </div>
350
+ <div class="declaration">
351
+ <h4>Declaration</h4>
352
+
353
+ <div class="Swift">
354
+ <p class="aside-title">Swift</p>
355
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">NSProgress</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
356
+
357
+ </div>
358
+ </div>
359
+ <div class="result-description view-on-github">
360
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L538">Show on GitHub</a>
361
+ </div>
362
+ </section>
363
+ </div>
364
+ </li>
365
+ </ul>
366
+ </div>
367
+ <div class="task-group">
368
+ <div class="task-name-container">
369
+
370
+ <a name="/Authentication"></a>
371
+ <a name="//apple_ref/swift/Section/Authentication" class="dashAnchor"></a>
372
+ <a href="#/Authentication">
373
+ <h3 class="section-name">Authentication</h3>
374
+ </a>
375
+
376
+ </div>
377
+ <ul class="task-group-list">
378
+ <li class="item symbol">
379
+ <div class="task-group-term">
380
+ <code>
381
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">
382
+ <a name="//apple_ref/swift/Method/authenticate(user:password:)" class="dashAnchor"></a>
383
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_">authenticate(user:password:)</a>
384
+ </code>
385
+ </div>
386
+ <div class="height-container">
387
+ <div class="pointy-thing-container"></div>
388
+ <section class="section instance-method">
389
+ <div class="pointy-thing"></div>
390
+ <div class="abstract">
391
+ <p class="para">Associates an HTTP Basic credential with the request.</p>
392
+ </div>
393
+ <div class="declaration">
394
+ <h4>Declaration</h4>
395
+
396
+ <div class="Swift">
397
+ <p class="aside-title">Swift</p>
398
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="nv">#user</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
399
+
400
+ </div>
401
+ </div>
402
+ <div class="parameters">
403
+ <h4>Parameters</h4>
404
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
405
+ <tbody>
406
+ <tr>
407
+ <td scope="row">
408
+ <code>
409
+ <em class="term">user</em>
410
+ </code>
411
+ </td>
412
+ <td>
413
+ <div class="definition">
414
+ <p class="para">The user.</p>
415
+ </div>
416
+ </td>
417
+ </tr>
418
+ <tr>
419
+ <td scope="row">
420
+ <code>
421
+ <em class="term">password</em>
422
+ </code>
423
+ </td>
424
+ <td>
425
+ <div class="definition">
426
+ <p class="para">The password.</p>
427
+ </div>
428
+ </td>
429
+ </tr>
430
+ </tbody>
431
+ </table>
432
+ </div>
433
+ <div class="result-description">
434
+ <h4>Return Value</h4>
435
+ <p class="para">The request.</p>
436
+ </div>
437
+ <div class="result-description view-on-github">
438
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L565">Show on GitHub</a>
439
+ </div>
440
+ </section>
441
+ </div>
442
+ </li>
443
+ <li class="item symbol">
444
+ <div class="task-group-term">
445
+ <code>
446
+ <a name="/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">
447
+ <a name="//apple_ref/swift/Method/authenticate(usingCredential:)" class="dashAnchor"></a>
448
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_">authenticate(usingCredential:)</a>
449
+ </code>
450
+ </div>
451
+ <div class="height-container">
452
+ <div class="pointy-thing-container"></div>
453
+ <section class="section instance-method">
454
+ <div class="pointy-thing"></div>
455
+ <div class="abstract">
456
+ <p class="para">Associates a specified credential with the request.</p>
457
+ </div>
458
+ <div class="declaration">
459
+ <h4>Declaration</h4>
460
+
461
+ <div class="Swift">
462
+ <p class="aside-title">Swift</p>
463
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">usingCredential</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">NSURLCredential</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
464
+
465
+ </div>
466
+ </div>
467
+ <div class="parameters">
468
+ <h4>Parameters</h4>
469
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
470
+ <tbody>
471
+ <tr>
472
+ <td scope="row">
473
+ <code>
474
+ <em class="term">credential</em>
475
+ </code>
476
+ </td>
477
+ <td>
478
+ <div class="definition">
479
+ <p class="para">The credential.</p>
480
+ </div>
481
+ </td>
482
+ </tr>
483
+ </tbody>
484
+ </table>
485
+ </div>
486
+ <div class="result-description">
487
+ <h4>Return Value</h4>
488
+ <p class="para">The request.</p>
489
+ </div>
490
+ <div class="result-description view-on-github">
491
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L578">Show on GitHub</a>
492
+ </div>
493
+ </section>
494
+ </div>
495
+ </li>
496
+ </ul>
497
+ </div>
498
+ <div class="task-group">
499
+ <div class="task-name-container">
500
+
501
+ <a name="/Progress"></a>
502
+ <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
503
+ <a href="#/Progress">
504
+ <h3 class="section-name">Progress</h3>
505
+ </a>
506
+
507
+ </div>
508
+ <ul class="task-group-list">
509
+ <li class="item symbol">
510
+ <div class="task-group-term">
511
+ <code>
512
+ <a name="/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">
513
+ <a name="//apple_ref/swift/Method/progress(closure:)" class="dashAnchor"></a>
514
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_">progress(closure:)</a>
515
+ </code>
516
+ </div>
517
+ <div class="height-container">
518
+ <div class="pointy-thing-container"></div>
519
+ <section class="section instance-method">
520
+ <div class="pointy-thing"></div>
521
+ <div class="abstract">
522
+ <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>
523
+ </div>
524
+ <div class="declaration">
525
+ <h4>Declaration</h4>
526
+
527
+ <div class="Swift">
528
+ <p class="aside-title">Swift</p>
529
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">progress</span><span class="p">(</span><span class="nv">closure</span><span class="p">:</span> <span class="p">((</span><span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">,</span> <span class="kt">Int64</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
530
+
531
+ </div>
532
+ </div>
533
+ <div class="parameters">
534
+ <h4>Parameters</h4>
535
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
536
+ <tbody>
537
+ <tr>
538
+ <td scope="row">
539
+ <code>
540
+ <em class="term">closure</em>
541
+ </code>
542
+ </td>
543
+ <td>
544
+ <div class="definition">
545
+ <p class="para">The code to be executed periodically during the lifecycle of the request.</p>
546
+ </div>
547
+ </td>
548
+ </tr>
549
+ </tbody>
550
+ </table>
551
+ </div>
552
+ <div class="result-description">
553
+ <h4>Return Value</h4>
554
+ <p class="para">The request.</p>
555
+ </div>
556
+ <div class="result-description view-on-github">
557
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L596">Show on GitHub</a>
558
+ </div>
559
+ </section>
560
+ </div>
561
+ </li>
562
+ </ul>
563
+ </div>
564
+ <div class="task-group">
565
+ <div class="task-name-container">
566
+
567
+ <a name="/Response"></a>
568
+ <a name="//apple_ref/swift/Section/Response" class="dashAnchor"></a>
569
+ <a href="#/Response">
570
+ <h3 class="section-name">Response</h3>
571
+ </a>
572
+
573
+ </div>
574
+ <ul class="task-group-list">
575
+ <li class="item symbol">
576
+ <div class="task-group-term">
577
+ <code>
578
+ <a name="/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
579
+ <a name="//apple_ref/swift/Method/responseDataSerializer()" class="dashAnchor"></a>
580
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">responseDataSerializer()</a>
581
+ </code>
582
+ </div>
583
+ <div class="height-container">
584
+ <div class="pointy-thing-container"></div>
585
+ <section class="section instance-method">
586
+ <div class="pointy-thing"></div>
587
+ <div class="abstract">
588
+ <p class="para">Creates a response serializer that returns the associated data as-is.</p>
589
+ </div>
590
+ <div class="declaration">
591
+ <h4>Declaration</h4>
592
+
593
+ <div class="Swift">
594
+ <p class="aside-title">Swift</p>
595
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">responseDataSerializer</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Serializer</span></code></pre>
596
+
597
+ </div>
598
+ </div>
599
+ <div class="result-description">
600
+ <h4>Return Value</h4>
601
+ <p class="para">A data response serializer.</p>
602
+ </div>
603
+ <div class="result-description view-on-github">
604
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L620">Show on GitHub</a>
605
+ </div>
606
+ </section>
607
+ </div>
608
+ </li>
609
+ <li class="item symbol">
610
+ <div class="task-group-term">
611
+ <code>
612
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
613
+ <a name="//apple_ref/swift/Method/response(_:)" class="dashAnchor"></a>
614
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">response(_:)</a>
615
+ </code>
616
+ </div>
617
+ <div class="height-container">
618
+ <div class="pointy-thing-container"></div>
619
+ <section class="section instance-method">
620
+ <div class="pointy-thing"></div>
621
+ <div class="abstract">
622
+ <p class="para">Adds a handler to be called once the request has finished.</p>
623
+ </div>
624
+ <div class="declaration">
625
+ <h4>Declaration</h4>
626
+
627
+ <div class="Swift">
628
+ <p class="aside-title">Swift</p>
629
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
630
+
631
+ </div>
632
+ </div>
633
+ <div class="parameters">
634
+ <h4>Parameters</h4>
635
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
636
+ <tbody>
637
+ <tr>
638
+ <td scope="row">
639
+ <code>
640
+ <em class="term">completionHandler</em>
641
+ </code>
642
+ </td>
643
+ <td>
644
+ <div class="definition">
645
+ <p class="para">The code to be executed once the request has finished.</p>
646
+ </div>
647
+ </td>
648
+ </tr>
649
+ </tbody>
650
+ </table>
651
+ </div>
652
+ <div class="result-description">
653
+ <h4>Return Value</h4>
654
+ <p class="para">The request.</p>
655
+ </div>
656
+ <div class="result-description view-on-github">
657
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L633">Show on GitHub</a>
658
+ </div>
659
+ </section>
660
+ </div>
661
+ </li>
662
+ <li class="item symbol">
663
+ <div class="task-group-term">
664
+ <code>
665
+ <a name="/s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_">
666
+ <a name="//apple_ref/swift/Method/response(queue:serializer:completionHandler:)" class="dashAnchor"></a>
667
+ <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>
668
+ </code>
669
+ </div>
670
+ <div class="height-container">
671
+ <div class="pointy-thing-container"></div>
672
+ <section class="section instance-method">
673
+ <div class="pointy-thing"></div>
674
+ <div class="abstract">
675
+ <p class="para">Adds a handler to be called once the request has finished.</p>
676
+ </div>
677
+ <div class="declaration">
678
+ <h4>Declaration</h4>
679
+
680
+ <div class="Swift">
681
+ <p class="aside-title">Swift</p>
682
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="n">dispatch_queue_t</span><span class="p">?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
683
+
684
+ </div>
685
+ </div>
686
+ <div class="parameters">
687
+ <h4>Parameters</h4>
688
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
689
+ <tbody>
690
+ <tr>
691
+ <td scope="row">
692
+ <code>
693
+ <em class="term">queue</em>
694
+ </code>
695
+ </td>
696
+ <td>
697
+ <div class="definition">
698
+ <p class="para">The queue on which the completion handler is dispatched.</p>
699
+ </div>
700
+ </td>
701
+ </tr>
702
+ <tr>
703
+ <td scope="row">
704
+ <code>
705
+ <em class="term">serializer</em>
706
+ </code>
707
+ </td>
708
+ <td>
709
+ <div class="definition">
710
+ <p class="para">The closure responsible for serializing the request, response, and data.</p>
711
+ </div>
712
+ </td>
713
+ </tr>
714
+ <tr>
715
+ <td scope="row">
716
+ <code>
717
+ <em class="term">completionHandler</em>
718
+ </code>
719
+ </td>
720
+ <td>
721
+ <div class="definition">
722
+ <p class="para">The code to be executed once the request has finished.</p>
723
+ </div>
724
+ </td>
725
+ </tr>
726
+ </tbody>
727
+ </table>
728
+ </div>
729
+ <div class="result-description">
730
+ <h4>Return Value</h4>
731
+ <p class="para">The request.</p>
732
+ </div>
733
+ <div class="result-description view-on-github">
734
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L646">Show on GitHub</a>
735
+ </div>
736
+ </section>
737
+ </div>
738
+ </li>
739
+ <li class="item symbol">
740
+ <div class="task-group-term">
741
+ <code>
742
+ <a name="/s:FC9Alamofire7Request7suspendFS0_FT_T_">
743
+ <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
744
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request7suspendFS0_FT_T_">suspend()</a>
745
+ </code>
746
+ </div>
747
+ <div class="height-container">
748
+ <div class="pointy-thing-container"></div>
749
+ <section class="section instance-method">
750
+ <div class="pointy-thing"></div>
751
+ <div class="abstract">
752
+ <p class="para">Suspends the request.</p>
753
+ </div>
754
+ <div class="declaration">
755
+ <h4>Declaration</h4>
756
+
757
+ <div class="Swift">
758
+ <p class="aside-title">Swift</p>
759
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span></code></pre>
760
+
761
+ </div>
762
+ </div>
763
+ <div class="result-description view-on-github">
764
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L661">Show on GitHub</a>
765
+ </div>
766
+ </section>
767
+ </div>
768
+ </li>
769
+ <li class="item symbol">
770
+ <div class="task-group-term">
771
+ <code>
772
+ <a name="/s:FC9Alamofire7Request6resumeFS0_FT_T_">
773
+ <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
774
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6resumeFS0_FT_T_">resume()</a>
775
+ </code>
776
+ </div>
777
+ <div class="height-container">
778
+ <div class="pointy-thing-container"></div>
779
+ <section class="section instance-method">
780
+ <div class="pointy-thing"></div>
781
+ <div class="abstract">
782
+ <p class="para">Resumes the request.</p>
783
+ </div>
784
+ <div class="declaration">
785
+ <h4>Declaration</h4>
786
+
787
+ <div class="Swift">
788
+ <p class="aside-title">Swift</p>
789
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span></code></pre>
790
+
791
+ </div>
792
+ </div>
793
+ <div class="result-description view-on-github">
794
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L668">Show on GitHub</a>
795
+ </div>
796
+ </section>
797
+ </div>
798
+ </li>
799
+ <li class="item symbol">
800
+ <div class="task-group-term">
801
+ <code>
802
+ <a name="/s:FC9Alamofire7Request6cancelFS0_FT_T_">
803
+ <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
804
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request6cancelFS0_FT_T_">cancel()</a>
805
+ </code>
806
+ </div>
807
+ <div class="height-container">
808
+ <div class="pointy-thing-container"></div>
809
+ <section class="section instance-method">
810
+ <div class="pointy-thing"></div>
811
+ <div class="abstract">
812
+ <p class="para">Cancels the request.</p>
813
+ </div>
814
+ <div class="declaration">
815
+ <h4>Declaration</h4>
816
+
817
+ <div class="Swift">
818
+ <p class="aside-title">Swift</p>
819
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
820
+
821
+ </div>
822
+ </div>
823
+ <div class="result-description view-on-github">
824
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L675">Show on GitHub</a>
825
+ </div>
826
+ </section>
827
+ </div>
828
+ </li>
829
+ </ul>
830
+ </div>
831
+ </section>
832
+ </section>
833
+ <section id="footer">
834
+ <p class="copyright">&copy; YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
835
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
836
+ </section>
837
+ </article>
838
+ </div>
839
+ </body>
840
+ </div>
841
+ </html>