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
data/spec/integration_specs/document_alamofire/after/docs/Extensions/String.html ADDED
@@ -0,0 +1,226 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>String Extension 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="String Extension 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
+ String Extension 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">String</h1>
181
+ <section>
182
+ <section class="section">
183
+ <p class="para">An arbitrary Unicode string value.</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:vE9AlamofireSS9URLStringSS">
198
+ <a class="x-instance-method Swift" href="#/s:vE9AlamofireSS9URLStringSS">URLString</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
+ </ul>
215
+ </div>
216
+ </section>
217
+ </section>
218
+ <section id="footer">
219
+ <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>
220
+ <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>
221
+ </section>
222
+ </article>
223
+ </div>
224
+ </body>
225
+ </div>
226
+ </html>
data/spec/integration_specs/document_alamofire/after/docs/Functions.html ADDED
@@ -0,0 +1,1001 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Functions 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="Functions 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
+ Functions 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">Functions</h1>
181
+ <section>
182
+ <section class="section">
183
+ <p class="para">The following functions are available globally.</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:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">
198
+ <a class="x-instance-method Swift" href="#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</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:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">
218
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</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">Creates a request using the shared manager instance for the specified method, URL string, parameters, and parameter encoding.</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 request(method: Method, URLString: URLStringConvertible, parameters: [String : AnyObject]? = default, encoding: ParameterEncoding = default) -&gt; Request</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">method</em>
246
+ </code>
247
+ </td>
248
+ <td>
249
+ <div class="definition">
250
+ <p class="para">The HTTP method.</p>
251
+ </div>
252
+ </td>
253
+ </tr>
254
+ <tr>
255
+ <td scope="row">
256
+ <code>
257
+ <em class="term">URLString</em>
258
+ </code>
259
+ </td>
260
+ <td>
261
+ <div class="definition">
262
+ <p class="para">The URL string.</p>
263
+ </div>
264
+ </td>
265
+ </tr>
266
+ <tr>
267
+ <td scope="row">
268
+ <code>
269
+ <em class="term">parameters</em>
270
+ </code>
271
+ </td>
272
+ <td>
273
+ <div class="definition">
274
+ <p class="para">The parameters. <code>nil</code> by default.</p>
275
+ </div>
276
+ </td>
277
+ </tr>
278
+ <tr>
279
+ <td scope="row">
280
+ <code>
281
+ <em class="term">encoding</em>
282
+ </code>
283
+ </td>
284
+ <td>
285
+ <div class="definition">
286
+ <p class="para">The parameter encoding. <code>.URL</code> by default.</p>
287
+ </div>
288
+ </td>
289
+ </tr>
290
+ </tbody>
291
+ </table>
292
+ </div>
293
+ <div class="result-description">
294
+ <h4>Return Value</h4>
295
+ <p class="para">The created request.</p>
296
+ </div>
297
+ <div class="result-description view-on-github">
298
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1461">Show on GitHub</a>
299
+ </div>
300
+ </section>
301
+ </div>
302
+ </li>
303
+ <li class="item symbol">
304
+ <div class="task-group-term">
305
+ <code>
306
+ <a name="/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">
307
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
308
+ </code>
309
+ </div>
310
+ <div class="height-container">
311
+ <div class="pointy-thing-container"></div>
312
+ <section class="section instance-method">
313
+ <div class="pointy-thing"></div>
314
+ <div class="abstract">
315
+ <p class="para">Creates a request using the shared manager instance for the specified URL request.If <code>startRequestsImmediately</code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
316
+ </div>
317
+ <div class="declaration">
318
+ <h4>Declaration</h4>
319
+
320
+ <div class="Swift">
321
+ <p class="aside-title">Swift</p>
322
+ <p class="para">
323
+ <code>public func request(URLRequest: URLRequestConvertible) -&gt; Request</code>
324
+ </p>
325
+ </div>
326
+ </div>
327
+ <div class="parameters">
328
+ <h4>Parameters</h4>
329
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
330
+ <tbody>
331
+ <tr>
332
+ <td scope="row">
333
+ <code>
334
+ <em class="term">URLRequest</em>
335
+ </code>
336
+ </td>
337
+ <td>
338
+ <div class="definition">
339
+ <p class="para">The URL request</p>
340
+ </div>
341
+ </td>
342
+ </tr>
343
+ </tbody>
344
+ </table>
345
+ </div>
346
+ <div class="result-description">
347
+ <h4>Return Value</h4>
348
+ <p class="para">The created request.</p>
349
+ </div>
350
+ <div class="result-description view-on-github">
351
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1474">Show on GitHub</a>
352
+ </div>
353
+ </section>
354
+ </div>
355
+ </li>
356
+ <li class="item symbol">
357
+ <div class="task-group-term">
358
+ <code>
359
+ <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">
360
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
361
+ </code>
362
+ </div>
363
+ <div class="height-container">
364
+ <div class="pointy-thing-container"></div>
365
+ <section class="section instance-method">
366
+ <div class="pointy-thing"></div>
367
+ <div class="abstract">
368
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and file.</p>
369
+ </div>
370
+ <div class="declaration">
371
+ <h4>Declaration</h4>
372
+
373
+ <div class="Swift">
374
+ <p class="aside-title">Swift</p>
375
+ <p class="para">
376
+ <code>public func upload(method: Method, URLString: URLStringConvertible, file: NSURL) -&gt; Request</code>
377
+ </p>
378
+ </div>
379
+ </div>
380
+ <div class="parameters">
381
+ <h4>Parameters</h4>
382
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
383
+ <tbody>
384
+ <tr>
385
+ <td scope="row">
386
+ <code>
387
+ <em class="term">method</em>
388
+ </code>
389
+ </td>
390
+ <td>
391
+ <div class="definition">
392
+ <p class="para">The HTTP method.</p>
393
+ </div>
394
+ </td>
395
+ </tr>
396
+ <tr>
397
+ <td scope="row">
398
+ <code>
399
+ <em class="term">URLString</em>
400
+ </code>
401
+ </td>
402
+ <td>
403
+ <div class="definition">
404
+ <p class="para">The URL string.</p>
405
+ </div>
406
+ </td>
407
+ </tr>
408
+ <tr>
409
+ <td scope="row">
410
+ <code>
411
+ <em class="term">file</em>
412
+ </code>
413
+ </td>
414
+ <td>
415
+ <div class="definition">
416
+ <p class="para">The file to upload.</p>
417
+ </div>
418
+ </td>
419
+ </tr>
420
+ </tbody>
421
+ </table>
422
+ </div>
423
+ <div class="result-description">
424
+ <h4>Return Value</h4>
425
+ <p class="para">The created upload request.</p>
426
+ </div>
427
+ <div class="result-description view-on-github">
428
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1491">Show on GitHub</a>
429
+ </div>
430
+ </section>
431
+ </div>
432
+ </li>
433
+ <li class="item symbol">
434
+ <div class="task-group-term">
435
+ <code>
436
+ <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">
437
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
438
+ </code>
439
+ </div>
440
+ <div class="height-container">
441
+ <div class="pointy-thing-container"></div>
442
+ <section class="section instance-method">
443
+ <div class="pointy-thing"></div>
444
+ <div class="abstract">
445
+ <p class="para">Creates an upload request using the shared manager instance for the specified URL request and file.</p>
446
+ </div>
447
+ <div class="declaration">
448
+ <h4>Declaration</h4>
449
+
450
+ <div class="Swift">
451
+ <p class="aside-title">Swift</p>
452
+ <p class="para">
453
+ <code>public func upload(URLRequest: URLRequestConvertible, file: NSURL) -&gt; Request</code>
454
+ </p>
455
+ </div>
456
+ </div>
457
+ <div class="parameters">
458
+ <h4>Parameters</h4>
459
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
460
+ <tbody>
461
+ <tr>
462
+ <td scope="row">
463
+ <code>
464
+ <em class="term">URLRequest</em>
465
+ </code>
466
+ </td>
467
+ <td>
468
+ <div class="definition">
469
+ <p class="para">The URL request.</p>
470
+ </div>
471
+ </td>
472
+ </tr>
473
+ <tr>
474
+ <td scope="row">
475
+ <code>
476
+ <em class="term">file</em>
477
+ </code>
478
+ </td>
479
+ <td>
480
+ <div class="definition">
481
+ <p class="para">The file to upload.</p>
482
+ </div>
483
+ </td>
484
+ </tr>
485
+ </tbody>
486
+ </table>
487
+ </div>
488
+ <div class="result-description">
489
+ <h4>Return Value</h4>
490
+ <p class="para">The created upload request.</p>
491
+ </div>
492
+ <div class="result-description view-on-github">
493
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1503">Show on GitHub</a>
494
+ </div>
495
+ </section>
496
+ </div>
497
+ </li>
498
+ <li class="item symbol">
499
+ <div class="task-group-term">
500
+ <code>
501
+ <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">
502
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
503
+ </code>
504
+ </div>
505
+ <div class="height-container">
506
+ <div class="pointy-thing-container"></div>
507
+ <section class="section instance-method">
508
+ <div class="pointy-thing"></div>
509
+ <div class="abstract">
510
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and data.</p>
511
+ </div>
512
+ <div class="declaration">
513
+ <h4>Declaration</h4>
514
+
515
+ <div class="Swift">
516
+ <p class="aside-title">Swift</p>
517
+ <p class="para">
518
+ <code>public func upload(method: Method, URLString: URLStringConvertible, data: NSData) -&gt; Request</code>
519
+ </p>
520
+ </div>
521
+ </div>
522
+ <div class="parameters">
523
+ <h4>Parameters</h4>
524
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
525
+ <tbody>
526
+ <tr>
527
+ <td scope="row">
528
+ <code>
529
+ <em class="term">method</em>
530
+ </code>
531
+ </td>
532
+ <td>
533
+ <div class="definition">
534
+ <p class="para">The HTTP method.</p>
535
+ </div>
536
+ </td>
537
+ </tr>
538
+ <tr>
539
+ <td scope="row">
540
+ <code>
541
+ <em class="term">URLString</em>
542
+ </code>
543
+ </td>
544
+ <td>
545
+ <div class="definition">
546
+ <p class="para">The URL string.</p>
547
+ </div>
548
+ </td>
549
+ </tr>
550
+ <tr>
551
+ <td scope="row">
552
+ <code>
553
+ <em class="term">data</em>
554
+ </code>
555
+ </td>
556
+ <td>
557
+ <div class="definition">
558
+ <p class="para">The data to upload.</p>
559
+ </div>
560
+ </td>
561
+ </tr>
562
+ </tbody>
563
+ </table>
564
+ </div>
565
+ <div class="result-description">
566
+ <h4>Return Value</h4>
567
+ <p class="para">The created upload request.</p>
568
+ </div>
569
+ <div class="result-description view-on-github">
570
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1518">Show on GitHub</a>
571
+ </div>
572
+ </section>
573
+ </div>
574
+ </li>
575
+ <li class="item symbol">
576
+ <div class="task-group-term">
577
+ <code>
578
+ <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">
579
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
580
+ </code>
581
+ </div>
582
+ <div class="height-container">
583
+ <div class="pointy-thing-container"></div>
584
+ <section class="section instance-method">
585
+ <div class="pointy-thing"></div>
586
+ <div class="abstract">
587
+ <p class="para">Creates an upload request using the shared manager instance for the specified URL request and data.</p>
588
+ </div>
589
+ <div class="declaration">
590
+ <h4>Declaration</h4>
591
+
592
+ <div class="Swift">
593
+ <p class="aside-title">Swift</p>
594
+ <p class="para">
595
+ <code>public func upload(URLRequest: URLRequestConvertible, data: NSData) -&gt; Request</code>
596
+ </p>
597
+ </div>
598
+ </div>
599
+ <div class="parameters">
600
+ <h4>Parameters</h4>
601
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
602
+ <tbody>
603
+ <tr>
604
+ <td scope="row">
605
+ <code>
606
+ <em class="term">URLRequest</em>
607
+ </code>
608
+ </td>
609
+ <td>
610
+ <div class="definition">
611
+ <p class="para">The URL request.</p>
612
+ </div>
613
+ </td>
614
+ </tr>
615
+ <tr>
616
+ <td scope="row">
617
+ <code>
618
+ <em class="term">data</em>
619
+ </code>
620
+ </td>
621
+ <td>
622
+ <div class="definition">
623
+ <p class="para">The data to upload.</p>
624
+ </div>
625
+ </td>
626
+ </tr>
627
+ </tbody>
628
+ </table>
629
+ </div>
630
+ <div class="result-description">
631
+ <h4>Return Value</h4>
632
+ <p class="para">The created upload request.</p>
633
+ </div>
634
+ <div class="result-description view-on-github">
635
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1530">Show on GitHub</a>
636
+ </div>
637
+ </section>
638
+ </div>
639
+ </li>
640
+ <li class="item symbol">
641
+ <div class="task-group-term">
642
+ <code>
643
+ <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">
644
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
645
+ </code>
646
+ </div>
647
+ <div class="height-container">
648
+ <div class="pointy-thing-container"></div>
649
+ <section class="section instance-method">
650
+ <div class="pointy-thing"></div>
651
+ <div class="abstract">
652
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and stream.</p>
653
+ </div>
654
+ <div class="declaration">
655
+ <h4>Declaration</h4>
656
+
657
+ <div class="Swift">
658
+ <p class="aside-title">Swift</p>
659
+ <p class="para">
660
+ <code>public func upload(method: Method, URLString: URLStringConvertible, stream: NSInputStream) -&gt; Request</code>
661
+ </p>
662
+ </div>
663
+ </div>
664
+ <div class="parameters">
665
+ <h4>Parameters</h4>
666
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
667
+ <tbody>
668
+ <tr>
669
+ <td scope="row">
670
+ <code>
671
+ <em class="term">method</em>
672
+ </code>
673
+ </td>
674
+ <td>
675
+ <div class="definition">
676
+ <p class="para">The HTTP method.</p>
677
+ </div>
678
+ </td>
679
+ </tr>
680
+ <tr>
681
+ <td scope="row">
682
+ <code>
683
+ <em class="term">URLString</em>
684
+ </code>
685
+ </td>
686
+ <td>
687
+ <div class="definition">
688
+ <p class="para">The URL string.</p>
689
+ </div>
690
+ </td>
691
+ </tr>
692
+ <tr>
693
+ <td scope="row">
694
+ <code>
695
+ <em class="term">stream</em>
696
+ </code>
697
+ </td>
698
+ <td>
699
+ <div class="definition">
700
+ <p class="para">The stream to upload.</p>
701
+ </div>
702
+ </td>
703
+ </tr>
704
+ </tbody>
705
+ </table>
706
+ </div>
707
+ <div class="result-description">
708
+ <h4>Return Value</h4>
709
+ <p class="para">The created upload request.</p>
710
+ </div>
711
+ <div class="result-description view-on-github">
712
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1545">Show on GitHub</a>
713
+ </div>
714
+ </section>
715
+ </div>
716
+ </li>
717
+ <li class="item symbol">
718
+ <div class="task-group-term">
719
+ <code>
720
+ <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">
721
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
722
+ </code>
723
+ </div>
724
+ <div class="height-container">
725
+ <div class="pointy-thing-container"></div>
726
+ <section class="section instance-method">
727
+ <div class="pointy-thing"></div>
728
+ <div class="abstract">
729
+ <p class="para">Creates an upload request using the shared manager instance for the specified URL request and stream.</p>
730
+ </div>
731
+ <div class="declaration">
732
+ <h4>Declaration</h4>
733
+
734
+ <div class="Swift">
735
+ <p class="aside-title">Swift</p>
736
+ <p class="para">
737
+ <code>public func upload(URLRequest: URLRequestConvertible, stream: NSInputStream) -&gt; Request</code>
738
+ </p>
739
+ </div>
740
+ </div>
741
+ <div class="parameters">
742
+ <h4>Parameters</h4>
743
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
744
+ <tbody>
745
+ <tr>
746
+ <td scope="row">
747
+ <code>
748
+ <em class="term">URLRequest</em>
749
+ </code>
750
+ </td>
751
+ <td>
752
+ <div class="definition">
753
+ <p class="para">The URL request.</p>
754
+ </div>
755
+ </td>
756
+ </tr>
757
+ <tr>
758
+ <td scope="row">
759
+ <code>
760
+ <em class="term">stream</em>
761
+ </code>
762
+ </td>
763
+ <td>
764
+ <div class="definition">
765
+ <p class="para">The stream to upload.</p>
766
+ </div>
767
+ </td>
768
+ </tr>
769
+ </tbody>
770
+ </table>
771
+ </div>
772
+ <div class="result-description">
773
+ <h4>Return Value</h4>
774
+ <p class="para">The created upload request.</p>
775
+ </div>
776
+ <div class="result-description view-on-github">
777
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1557">Show on GitHub</a>
778
+ </div>
779
+ </section>
780
+ </div>
781
+ </li>
782
+ <li class="item symbol">
783
+ <div class="task-group-term">
784
+ <code>
785
+ <a name="/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
786
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
787
+ </code>
788
+ </div>
789
+ <div class="height-container">
790
+ <div class="pointy-thing-container"></div>
791
+ <section class="section instance-method">
792
+ <div class="pointy-thing"></div>
793
+ <div class="abstract">
794
+ <p class="para">Creates a download request using the shared manager instance for the specified method and URL string.</p>
795
+ </div>
796
+ <div class="declaration">
797
+ <h4>Declaration</h4>
798
+
799
+ <div class="Swift">
800
+ <p class="aside-title">Swift</p>
801
+ <p class="para">
802
+ <code>public func download(method: Method, URLString: URLStringConvertible, destination: Request.DownloadFileDestination) -&gt; Request</code>
803
+ </p>
804
+ </div>
805
+ </div>
806
+ <div class="parameters">
807
+ <h4>Parameters</h4>
808
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
809
+ <tbody>
810
+ <tr>
811
+ <td scope="row">
812
+ <code>
813
+ <em class="term">method</em>
814
+ </code>
815
+ </td>
816
+ <td>
817
+ <div class="definition">
818
+ <p class="para">The HTTP method.</p>
819
+ </div>
820
+ </td>
821
+ </tr>
822
+ <tr>
823
+ <td scope="row">
824
+ <code>
825
+ <em class="term">URLString</em>
826
+ </code>
827
+ </td>
828
+ <td>
829
+ <div class="definition">
830
+ <p class="para">The URL string.</p>
831
+ </div>
832
+ </td>
833
+ </tr>
834
+ <tr>
835
+ <td scope="row">
836
+ <code>
837
+ <em class="term">destination</em>
838
+ </code>
839
+ </td>
840
+ <td>
841
+ <div class="definition">
842
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
843
+ </div>
844
+ </td>
845
+ </tr>
846
+ </tbody>
847
+ </table>
848
+ </div>
849
+ <div class="result-description">
850
+ <h4>Return Value</h4>
851
+ <p class="para">The created download request.</p>
852
+ </div>
853
+ <div class="result-description view-on-github">
854
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1574">Show on GitHub</a>
855
+ </div>
856
+ </section>
857
+ </div>
858
+ </li>
859
+ <li class="item symbol">
860
+ <div class="task-group-term">
861
+ <code>
862
+ <a name="/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
863
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
864
+ </code>
865
+ </div>
866
+ <div class="height-container">
867
+ <div class="pointy-thing-container"></div>
868
+ <section class="section instance-method">
869
+ <div class="pointy-thing"></div>
870
+ <div class="abstract">
871
+ <p class="para">Creates a download request using the shared manager instance for the specified URL request.</p>
872
+ </div>
873
+ <div class="declaration">
874
+ <h4>Declaration</h4>
875
+
876
+ <div class="Swift">
877
+ <p class="aside-title">Swift</p>
878
+ <p class="para">
879
+ <code>public func download(URLRequest: URLRequestConvertible, destination: Request.DownloadFileDestination) -&gt; Request</code>
880
+ </p>
881
+ </div>
882
+ </div>
883
+ <div class="parameters">
884
+ <h4>Parameters</h4>
885
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
886
+ <tbody>
887
+ <tr>
888
+ <td scope="row">
889
+ <code>
890
+ <em class="term">URLRequest</em>
891
+ </code>
892
+ </td>
893
+ <td>
894
+ <div class="definition">
895
+ <p class="para">The URL request.</p>
896
+ </div>
897
+ </td>
898
+ </tr>
899
+ <tr>
900
+ <td scope="row">
901
+ <code>
902
+ <em class="term">destination</em>
903
+ </code>
904
+ </td>
905
+ <td>
906
+ <div class="definition">
907
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
908
+ </div>
909
+ </td>
910
+ </tr>
911
+ </tbody>
912
+ </table>
913
+ </div>
914
+ <div class="result-description">
915
+ <h4>Return Value</h4>
916
+ <p class="para">The created download request.</p>
917
+ </div>
918
+ <div class="result-description view-on-github">
919
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1586">Show on GitHub</a>
920
+ </div>
921
+ </section>
922
+ </div>
923
+ </li>
924
+ <li class="item symbol">
925
+ <div class="task-group-term">
926
+ <code>
927
+ <a name="/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
928
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
929
+ </code>
930
+ </div>
931
+ <div class="height-container">
932
+ <div class="pointy-thing-container"></div>
933
+ <section class="section instance-method">
934
+ <div class="pointy-thing"></div>
935
+ <div class="abstract">
936
+ <p class="para">Creates a request using the shared manager instance for downloading from the resume data produced from a previous request cancellation.</p>
937
+ </div>
938
+ <div class="declaration">
939
+ <h4>Declaration</h4>
940
+
941
+ <div class="Swift">
942
+ <p class="aside-title">Swift</p>
943
+ <p class="para">
944
+ <code>public func download(resumeData data: NSData, destination: Request.DownloadFileDestination) -&gt; Request</code>
945
+ </p>
946
+ </div>
947
+ </div>
948
+ <div class="parameters">
949
+ <h4>Parameters</h4>
950
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
951
+ <tbody>
952
+ <tr>
953
+ <td scope="row">
954
+ <code>
955
+ <em class="term">resumeData</em>
956
+ </code>
957
+ </td>
958
+ <td>
959
+ <div class="definition">
960
+ <p class="para">The resume data. This is an opaque data blob produced by <code>NSURLSessionDownloadTask</code> when a task is cancelled. See <code>NSURLSession -downloadTaskWithResumeData:</code> for additional information.</p>
961
+ </div>
962
+ </td>
963
+ </tr>
964
+ <tr>
965
+ <td scope="row">
966
+ <code>
967
+ <em class="term">destination</em>
968
+ </code>
969
+ </td>
970
+ <td>
971
+ <div class="definition">
972
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
973
+ </div>
974
+ </td>
975
+ </tr>
976
+ </tbody>
977
+ </table>
978
+ </div>
979
+ <div class="result-description">
980
+ <h4>Return Value</h4>
981
+ <p class="para">The created download request.</p>
982
+ </div>
983
+ <div class="result-description view-on-github">
984
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1600">Show on GitHub</a>
985
+ </div>
986
+ </section>
987
+ </div>
988
+ </li>
989
+ </ul>
990
+ </div>
991
+ </section>
992
+ </section>
993
+ <section id="footer">
994
+ <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>
995
+ <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>
996
+ </section>
997
+ </article>
998
+ </div>
999
+ </body>
1000
+ </div>
1001
+ </html>