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/Functions.html ADDED
@@ -0,0 +1,1040 @@
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
+ <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 title="Functions Reference"></a>
24
+ <header>
25
+ <div class="content-wrapper">
26
+ <p class="header-text"><a href="index.html">Alamofire Docs</a> (40% documented)</p>
27
+ <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>
28
+ </div>
29
+ </header>
30
+ <section id="valence">
31
+ <div class="content-wrapper">
32
+ <p id="hierarchial_navigation">
33
+ <a href="index.html" id="design_resources_link">Alamofire Reference</a>
34
+ <img id="carat" src="img/carat.png" height="10px" width="6px" />
35
+ Functions Reference
36
+ </p>
37
+ </div>
38
+ </section>
39
+ <div class="content-wrapper">
40
+ <nav class="book-parts">
41
+ <ul class="nav-parts">
42
+ <li class="part-name tasks">
43
+ <a href="Classes.html">Classes</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="Classes/Manager.html">Manager</a>
47
+ </li>
48
+ <li class="nav-chapter">
49
+ <a href="Classes/Request.html">Request</a>
50
+ </li>
51
+ </ul>
52
+ </li>
53
+ <li class="part-name tasks">
54
+ <a href="Global Variables.html">Global Variables</a>
55
+ <ul class="nav-chapters">
56
+ <li class="nav-chapter">
57
+ <a href="Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="Enums.html">Enums</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="Enums.html#/s:O9Alamofire6Method">Method</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="Enums/ParameterEncoding.html">ParameterEncoding</a>
69
+ </li>
70
+ </ul>
71
+ </li>
72
+ <li class="part-name tasks">
73
+ <a href="Extensions.html">Extensions</a>
74
+ <ul class="nav-chapters">
75
+ <li class="nav-chapter">
76
+ <a href="Extensions.html#/s:SS">String</a>
77
+ </li>
78
+ <li class="nav-chapter">
79
+ <a href="Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
80
+ </li>
81
+ <li class="nav-chapter">
82
+ <a href="Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
83
+ </li>
84
+ <li class="nav-chapter">
85
+ <a href="Extensions/Request.html">Request</a>
86
+ </li>
87
+ <li class="nav-chapter">
88
+ <a href="Extensions/Manager.html">Manager</a>
89
+ </li>
90
+ <li class="nav-chapter">
91
+ <a href="Extensions.html#/s:C9Alamofire7Request">Request</a>
92
+ </li>
93
+ <li class="nav-chapter">
94
+ <a href="Extensions/Manager.html">Manager</a>
95
+ </li>
96
+ <li class="nav-chapter">
97
+ <a href="Extensions/Request.html">Request</a>
98
+ </li>
99
+ <li class="nav-chapter">
100
+ <a href="Extensions/Request.html">Request</a>
101
+ </li>
102
+ <li class="nav-chapter">
103
+ <a href="Extensions/Request.html">Request</a>
104
+ </li>
105
+ <li class="nav-chapter">
106
+ <a href="Extensions/Request.html">Request</a>
107
+ </li>
108
+ <li class="nav-chapter">
109
+ <a href="Extensions/Request.html">Request</a>
110
+ </li>
111
+ <li class="nav-chapter">
112
+ <a href="Extensions/Request.html">Request</a>
113
+ </li>
114
+ </ul>
115
+ </li>
116
+ <li class="part-name tasks">
117
+ <a href="Functions.html">Functions</a>
118
+ <ul class="nav-chapters">
119
+ <li class="nav-chapter">
120
+ <a href="Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
121
+ </li>
122
+ <li class="nav-chapter">
123
+ <a href="Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
124
+ </li>
125
+ <li class="nav-chapter">
126
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
127
+ </li>
128
+ <li class="nav-chapter">
129
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
130
+ </li>
131
+ <li class="nav-chapter">
132
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
133
+ </li>
134
+ <li class="nav-chapter">
135
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
136
+ </li>
137
+ <li class="nav-chapter">
138
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
139
+ </li>
140
+ <li class="nav-chapter">
141
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
142
+ </li>
143
+ <li class="nav-chapter">
144
+ <a href="Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
145
+ </li>
146
+ <li class="nav-chapter">
147
+ <a href="Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
148
+ </li>
149
+ <li class="nav-chapter">
150
+ <a href="Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
151
+ </li>
152
+ </ul>
153
+ </li>
154
+ <li class="part-name tasks">
155
+ <a href="Protocols.html">Protocols</a>
156
+ <ul class="nav-chapters">
157
+ <li class="nav-chapter">
158
+ <a href="Protocols/URLStringConvertible.html">URLStringConvertible</a>
159
+ </li>
160
+ <li class="nav-chapter">
161
+ <a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
162
+ </li>
163
+ </ul>
164
+ </li>
165
+ </ul>
166
+ </nav>
167
+ <div class="pixel-line"></div>
168
+ <div class="rubber-band-gap"></div>
169
+ <article class="chapter">
170
+ <a name="/"></a>
171
+ <h1 class="chapter-name">Functions</h1>
172
+ <section>
173
+ <section class="section">
174
+ <p class="para">The following functions are available globally.</p>
175
+ </section>
176
+ <section class="section task-group-section">
177
+ <div class="task-group">
178
+ <div class="task-name-container">
179
+ <hr/>
180
+ <a name="/Request"></a>
181
+ <a name="//apple_ref/swift/Section/Request" class="dashAnchor"></a>
182
+ <a href="#/Request">
183
+ <h3 class="section-name">Request</h3>
184
+ </a>
185
+
186
+ </div>
187
+ <ul class="task-group-list">
188
+ <li class="item symbol">
189
+ <div class="task-group-term">
190
+ <code>
191
+ <a name="/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">
192
+ <a name="//apple_ref/swift/Function/request(_:_:parameters:encoding:)" class="dashAnchor"></a>
193
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
194
+ </code>
195
+ </div>
196
+ <div class="height-container">
197
+ <div class="pointy-thing-container"></div>
198
+ <section class="section instance-method">
199
+ <div class="pointy-thing"></div>
200
+ <div class="abstract">
201
+ <p class="para">Creates a request using the shared manager instance for the specified method, URL string, parameters, and parameter encoding.</p>
202
+ </div>
203
+ <div class="declaration">
204
+ <h4>Declaration</h4>
205
+
206
+ <div class="Swift">
207
+ <p class="aside-title">Swift</p>
208
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
209
+
210
+ </div>
211
+ </div>
212
+ <div class="parameters">
213
+ <h4>Parameters</h4>
214
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
215
+ <tbody>
216
+ <tr>
217
+ <td scope="row">
218
+ <code>
219
+ <em class="term">method</em>
220
+ </code>
221
+ </td>
222
+ <td>
223
+ <div class="definition">
224
+ <p class="para">The HTTP method.</p>
225
+ </div>
226
+ </td>
227
+ </tr>
228
+ <tr>
229
+ <td scope="row">
230
+ <code>
231
+ <em class="term">URLString</em>
232
+ </code>
233
+ </td>
234
+ <td>
235
+ <div class="definition">
236
+ <p class="para">The URL string.</p>
237
+ </div>
238
+ </td>
239
+ </tr>
240
+ <tr>
241
+ <td scope="row">
242
+ <code>
243
+ <em class="term">parameters</em>
244
+ </code>
245
+ </td>
246
+ <td>
247
+ <div class="definition">
248
+ <p class="para">The parameters. <code>nil</code> by default.</p>
249
+ </div>
250
+ </td>
251
+ </tr>
252
+ <tr>
253
+ <td scope="row">
254
+ <code>
255
+ <em class="term">encoding</em>
256
+ </code>
257
+ </td>
258
+ <td>
259
+ <div class="definition">
260
+ <p class="para">The parameter encoding. <code>.URL</code> by default.</p>
261
+ </div>
262
+ </td>
263
+ </tr>
264
+ </tbody>
265
+ </table>
266
+ </div>
267
+ <div class="result-description">
268
+ <h4>Return Value</h4>
269
+ <p class="para">The created request.</p>
270
+ </div>
271
+ <div class="result-description view-on-github">
272
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1461">Show on GitHub</a>
273
+ </div>
274
+ </section>
275
+ </div>
276
+ </li>
277
+ <li class="item symbol">
278
+ <div class="task-group-term">
279
+ <code>
280
+ <a name="/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">
281
+ <a name="//apple_ref/swift/Function/request(_:)" class="dashAnchor"></a>
282
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
283
+ </code>
284
+ </div>
285
+ <div class="height-container">
286
+ <div class="pointy-thing-container"></div>
287
+ <section class="section instance-method">
288
+ <div class="pointy-thing"></div>
289
+ <div class="abstract">
290
+ <p class="para">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>
291
+ </div>
292
+ <div class="declaration">
293
+ <h4>Declaration</h4>
294
+
295
+ <div class="Swift">
296
+ <p class="aside-title">Swift</p>
297
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
298
+
299
+ </div>
300
+ </div>
301
+ <div class="parameters">
302
+ <h4>Parameters</h4>
303
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
304
+ <tbody>
305
+ <tr>
306
+ <td scope="row">
307
+ <code>
308
+ <em class="term">URLRequest</em>
309
+ </code>
310
+ </td>
311
+ <td>
312
+ <div class="definition">
313
+ <p class="para">The URL request</p>
314
+ </div>
315
+ </td>
316
+ </tr>
317
+ </tbody>
318
+ </table>
319
+ </div>
320
+ <div class="result-description">
321
+ <h4>Return Value</h4>
322
+ <p class="para">The created request.</p>
323
+ </div>
324
+ <div class="result-description view-on-github">
325
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1474">Show on GitHub</a>
326
+ </div>
327
+ </section>
328
+ </div>
329
+ </li>
330
+ </ul>
331
+ </div>
332
+ <div class="task-group">
333
+ <div class="task-name-container">
334
+
335
+ <a name="/File"></a>
336
+ <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
337
+ <a href="#/File">
338
+ <h3 class="section-name">File</h3>
339
+ </a>
340
+
341
+ </div>
342
+ <ul class="task-group-list">
343
+ <li class="item symbol">
344
+ <div class="task-group-term">
345
+ <code>
346
+ <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">
347
+ <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
348
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
349
+ </code>
350
+ </div>
351
+ <div class="height-container">
352
+ <div class="pointy-thing-container"></div>
353
+ <section class="section instance-method">
354
+ <div class="pointy-thing"></div>
355
+ <div class="abstract">
356
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and file.</p>
357
+ </div>
358
+ <div class="declaration">
359
+ <h4>Declaration</h4>
360
+
361
+ <div class="Swift">
362
+ <p class="aside-title">Swift</p>
363
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
364
+
365
+ </div>
366
+ </div>
367
+ <div class="parameters">
368
+ <h4>Parameters</h4>
369
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
370
+ <tbody>
371
+ <tr>
372
+ <td scope="row">
373
+ <code>
374
+ <em class="term">method</em>
375
+ </code>
376
+ </td>
377
+ <td>
378
+ <div class="definition">
379
+ <p class="para">The HTTP method.</p>
380
+ </div>
381
+ </td>
382
+ </tr>
383
+ <tr>
384
+ <td scope="row">
385
+ <code>
386
+ <em class="term">URLString</em>
387
+ </code>
388
+ </td>
389
+ <td>
390
+ <div class="definition">
391
+ <p class="para">The URL string.</p>
392
+ </div>
393
+ </td>
394
+ </tr>
395
+ <tr>
396
+ <td scope="row">
397
+ <code>
398
+ <em class="term">file</em>
399
+ </code>
400
+ </td>
401
+ <td>
402
+ <div class="definition">
403
+ <p class="para">The file to upload.</p>
404
+ </div>
405
+ </td>
406
+ </tr>
407
+ </tbody>
408
+ </table>
409
+ </div>
410
+ <div class="result-description">
411
+ <h4>Return Value</h4>
412
+ <p class="para">The created upload request.</p>
413
+ </div>
414
+ <div class="result-description view-on-github">
415
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1491">Show on GitHub</a>
416
+ </div>
417
+ </section>
418
+ </div>
419
+ </li>
420
+ <li class="item symbol">
421
+ <div class="task-group-term">
422
+ <code>
423
+ <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">
424
+ <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
425
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
426
+ </code>
427
+ </div>
428
+ <div class="height-container">
429
+ <div class="pointy-thing-container"></div>
430
+ <section class="section instance-method">
431
+ <div class="pointy-thing"></div>
432
+ <div class="abstract">
433
+ <p class="para">Creates an upload request using the shared manager instance for the specified URL request and file.</p>
434
+ </div>
435
+ <div class="declaration">
436
+ <h4>Declaration</h4>
437
+
438
+ <div class="Swift">
439
+ <p class="aside-title">Swift</p>
440
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
441
+
442
+ </div>
443
+ </div>
444
+ <div class="parameters">
445
+ <h4>Parameters</h4>
446
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
447
+ <tbody>
448
+ <tr>
449
+ <td scope="row">
450
+ <code>
451
+ <em class="term">URLRequest</em>
452
+ </code>
453
+ </td>
454
+ <td>
455
+ <div class="definition">
456
+ <p class="para">The URL request.</p>
457
+ </div>
458
+ </td>
459
+ </tr>
460
+ <tr>
461
+ <td scope="row">
462
+ <code>
463
+ <em class="term">file</em>
464
+ </code>
465
+ </td>
466
+ <td>
467
+ <div class="definition">
468
+ <p class="para">The file to upload.</p>
469
+ </div>
470
+ </td>
471
+ </tr>
472
+ </tbody>
473
+ </table>
474
+ </div>
475
+ <div class="result-description">
476
+ <h4>Return Value</h4>
477
+ <p class="para">The created upload request.</p>
478
+ </div>
479
+ <div class="result-description view-on-github">
480
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1503">Show on GitHub</a>
481
+ </div>
482
+ </section>
483
+ </div>
484
+ </li>
485
+ </ul>
486
+ </div>
487
+ <div class="task-group">
488
+ <div class="task-name-container">
489
+
490
+ <a name="/Data"></a>
491
+ <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
492
+ <a href="#/Data">
493
+ <h3 class="section-name">Data</h3>
494
+ </a>
495
+
496
+ </div>
497
+ <ul class="task-group-list">
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 name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
503
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
504
+ </code>
505
+ </div>
506
+ <div class="height-container">
507
+ <div class="pointy-thing-container"></div>
508
+ <section class="section instance-method">
509
+ <div class="pointy-thing"></div>
510
+ <div class="abstract">
511
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and data.</p>
512
+ </div>
513
+ <div class="declaration">
514
+ <h4>Declaration</h4>
515
+
516
+ <div class="Swift">
517
+ <p class="aside-title">Swift</p>
518
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
519
+
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 name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
580
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</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 an upload request using the shared manager instance for the specified URL request and data.</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">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
596
+
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
+ </ul>
641
+ </div>
642
+ <div class="task-group">
643
+ <div class="task-name-container">
644
+
645
+ <a name="/Stream"></a>
646
+ <a name="//apple_ref/swift/Section/Stream" class="dashAnchor"></a>
647
+ <a href="#/Stream">
648
+ <h3 class="section-name">Stream</h3>
649
+ </a>
650
+
651
+ </div>
652
+ <ul class="task-group-list">
653
+ <li class="item symbol">
654
+ <div class="task-group-term">
655
+ <code>
656
+ <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">
657
+ <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
658
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
659
+ </code>
660
+ </div>
661
+ <div class="height-container">
662
+ <div class="pointy-thing-container"></div>
663
+ <section class="section instance-method">
664
+ <div class="pointy-thing"></div>
665
+ <div class="abstract">
666
+ <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and stream.</p>
667
+ </div>
668
+ <div class="declaration">
669
+ <h4>Declaration</h4>
670
+
671
+ <div class="Swift">
672
+ <p class="aside-title">Swift</p>
673
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
674
+
675
+ </div>
676
+ </div>
677
+ <div class="parameters">
678
+ <h4>Parameters</h4>
679
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
680
+ <tbody>
681
+ <tr>
682
+ <td scope="row">
683
+ <code>
684
+ <em class="term">method</em>
685
+ </code>
686
+ </td>
687
+ <td>
688
+ <div class="definition">
689
+ <p class="para">The HTTP method.</p>
690
+ </div>
691
+ </td>
692
+ </tr>
693
+ <tr>
694
+ <td scope="row">
695
+ <code>
696
+ <em class="term">URLString</em>
697
+ </code>
698
+ </td>
699
+ <td>
700
+ <div class="definition">
701
+ <p class="para">The URL string.</p>
702
+ </div>
703
+ </td>
704
+ </tr>
705
+ <tr>
706
+ <td scope="row">
707
+ <code>
708
+ <em class="term">stream</em>
709
+ </code>
710
+ </td>
711
+ <td>
712
+ <div class="definition">
713
+ <p class="para">The stream to upload.</p>
714
+ </div>
715
+ </td>
716
+ </tr>
717
+ </tbody>
718
+ </table>
719
+ </div>
720
+ <div class="result-description">
721
+ <h4>Return Value</h4>
722
+ <p class="para">The created upload request.</p>
723
+ </div>
724
+ <div class="result-description view-on-github">
725
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1545">Show on GitHub</a>
726
+ </div>
727
+ </section>
728
+ </div>
729
+ </li>
730
+ <li class="item symbol">
731
+ <div class="task-group-term">
732
+ <code>
733
+ <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">
734
+ <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
735
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
736
+ </code>
737
+ </div>
738
+ <div class="height-container">
739
+ <div class="pointy-thing-container"></div>
740
+ <section class="section instance-method">
741
+ <div class="pointy-thing"></div>
742
+ <div class="abstract">
743
+ <p class="para">Creates an upload request using the shared manager instance for the specified URL request and stream.</p>
744
+ </div>
745
+ <div class="declaration">
746
+ <h4>Declaration</h4>
747
+
748
+ <div class="Swift">
749
+ <p class="aside-title">Swift</p>
750
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
751
+
752
+ </div>
753
+ </div>
754
+ <div class="parameters">
755
+ <h4>Parameters</h4>
756
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
757
+ <tbody>
758
+ <tr>
759
+ <td scope="row">
760
+ <code>
761
+ <em class="term">URLRequest</em>
762
+ </code>
763
+ </td>
764
+ <td>
765
+ <div class="definition">
766
+ <p class="para">The URL request.</p>
767
+ </div>
768
+ </td>
769
+ </tr>
770
+ <tr>
771
+ <td scope="row">
772
+ <code>
773
+ <em class="term">stream</em>
774
+ </code>
775
+ </td>
776
+ <td>
777
+ <div class="definition">
778
+ <p class="para">The stream to upload.</p>
779
+ </div>
780
+ </td>
781
+ </tr>
782
+ </tbody>
783
+ </table>
784
+ </div>
785
+ <div class="result-description">
786
+ <h4>Return Value</h4>
787
+ <p class="para">The created upload request.</p>
788
+ </div>
789
+ <div class="result-description view-on-github">
790
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1557">Show on GitHub</a>
791
+ </div>
792
+ </section>
793
+ </div>
794
+ </li>
795
+ </ul>
796
+ </div>
797
+ <div class="task-group">
798
+ <div class="task-name-container">
799
+
800
+ <a name="/URL%20Request"></a>
801
+ <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
802
+ <a href="#/URL%20Request">
803
+ <h3 class="section-name">URL Request</h3>
804
+ </a>
805
+
806
+ </div>
807
+ <ul class="task-group-list">
808
+ <li class="item symbol">
809
+ <div class="task-group-term">
810
+ <code>
811
+ <a name="/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
812
+ <a name="//apple_ref/swift/Function/download(_:_:_:)" class="dashAnchor"></a>
813
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
814
+ </code>
815
+ </div>
816
+ <div class="height-container">
817
+ <div class="pointy-thing-container"></div>
818
+ <section class="section instance-method">
819
+ <div class="pointy-thing"></div>
820
+ <div class="abstract">
821
+ <p class="para">Creates a download request using the shared manager instance for the specified method and URL string.</p>
822
+ </div>
823
+ <div class="declaration">
824
+ <h4>Declaration</h4>
825
+
826
+ <div class="Swift">
827
+ <p class="aside-title">Swift</p>
828
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
829
+
830
+ </div>
831
+ </div>
832
+ <div class="parameters">
833
+ <h4>Parameters</h4>
834
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
835
+ <tbody>
836
+ <tr>
837
+ <td scope="row">
838
+ <code>
839
+ <em class="term">method</em>
840
+ </code>
841
+ </td>
842
+ <td>
843
+ <div class="definition">
844
+ <p class="para">The HTTP method.</p>
845
+ </div>
846
+ </td>
847
+ </tr>
848
+ <tr>
849
+ <td scope="row">
850
+ <code>
851
+ <em class="term">URLString</em>
852
+ </code>
853
+ </td>
854
+ <td>
855
+ <div class="definition">
856
+ <p class="para">The URL string.</p>
857
+ </div>
858
+ </td>
859
+ </tr>
860
+ <tr>
861
+ <td scope="row">
862
+ <code>
863
+ <em class="term">destination</em>
864
+ </code>
865
+ </td>
866
+ <td>
867
+ <div class="definition">
868
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
869
+ </div>
870
+ </td>
871
+ </tr>
872
+ </tbody>
873
+ </table>
874
+ </div>
875
+ <div class="result-description">
876
+ <h4>Return Value</h4>
877
+ <p class="para">The created download request.</p>
878
+ </div>
879
+ <div class="result-description view-on-github">
880
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1574">Show on GitHub</a>
881
+ </div>
882
+ </section>
883
+ </div>
884
+ </li>
885
+ <li class="item symbol">
886
+ <div class="task-group-term">
887
+ <code>
888
+ <a name="/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
889
+ <a name="//apple_ref/swift/Function/download(_:_:)" class="dashAnchor"></a>
890
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
891
+ </code>
892
+ </div>
893
+ <div class="height-container">
894
+ <div class="pointy-thing-container"></div>
895
+ <section class="section instance-method">
896
+ <div class="pointy-thing"></div>
897
+ <div class="abstract">
898
+ <p class="para">Creates a download request using the shared manager instance for the specified URL request.</p>
899
+ </div>
900
+ <div class="declaration">
901
+ <h4>Declaration</h4>
902
+
903
+ <div class="Swift">
904
+ <p class="aside-title">Swift</p>
905
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
906
+
907
+ </div>
908
+ </div>
909
+ <div class="parameters">
910
+ <h4>Parameters</h4>
911
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
912
+ <tbody>
913
+ <tr>
914
+ <td scope="row">
915
+ <code>
916
+ <em class="term">URLRequest</em>
917
+ </code>
918
+ </td>
919
+ <td>
920
+ <div class="definition">
921
+ <p class="para">The URL request.</p>
922
+ </div>
923
+ </td>
924
+ </tr>
925
+ <tr>
926
+ <td scope="row">
927
+ <code>
928
+ <em class="term">destination</em>
929
+ </code>
930
+ </td>
931
+ <td>
932
+ <div class="definition">
933
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
934
+ </div>
935
+ </td>
936
+ </tr>
937
+ </tbody>
938
+ </table>
939
+ </div>
940
+ <div class="result-description">
941
+ <h4>Return Value</h4>
942
+ <p class="para">The created download request.</p>
943
+ </div>
944
+ <div class="result-description view-on-github">
945
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1586">Show on GitHub</a>
946
+ </div>
947
+ </section>
948
+ </div>
949
+ </li>
950
+ </ul>
951
+ </div>
952
+ <div class="task-group">
953
+ <div class="task-name-container">
954
+
955
+ <a name="/Resume%20Data"></a>
956
+ <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
957
+ <a href="#/Resume%20Data">
958
+ <h3 class="section-name">Resume Data</h3>
959
+ </a>
960
+
961
+ </div>
962
+ <ul class="task-group-list">
963
+ <li class="item symbol">
964
+ <div class="task-group-term">
965
+ <code>
966
+ <a name="/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
967
+ <a name="//apple_ref/swift/Function/download(resumeData:_:)" class="dashAnchor"></a>
968
+ <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
969
+ </code>
970
+ </div>
971
+ <div class="height-container">
972
+ <div class="pointy-thing-container"></div>
973
+ <section class="section instance-method">
974
+ <div class="pointy-thing"></div>
975
+ <div class="abstract">
976
+ <p class="para">Creates a request using the shared manager instance for downloading from the resume data produced from a previous request cancellation.</p>
977
+ </div>
978
+ <div class="declaration">
979
+ <h4>Declaration</h4>
980
+
981
+ <div class="Swift">
982
+ <p class="aside-title">Swift</p>
983
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
984
+
985
+ </div>
986
+ </div>
987
+ <div class="parameters">
988
+ <h4>Parameters</h4>
989
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
990
+ <tbody>
991
+ <tr>
992
+ <td scope="row">
993
+ <code>
994
+ <em class="term">resumeData</em>
995
+ </code>
996
+ </td>
997
+ <td>
998
+ <div class="definition">
999
+ <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>
1000
+ </div>
1001
+ </td>
1002
+ </tr>
1003
+ <tr>
1004
+ <td scope="row">
1005
+ <code>
1006
+ <em class="term">destination</em>
1007
+ </code>
1008
+ </td>
1009
+ <td>
1010
+ <div class="definition">
1011
+ <p class="para">The closure used to determine the destination of the downloaded file.</p>
1012
+ </div>
1013
+ </td>
1014
+ </tr>
1015
+ </tbody>
1016
+ </table>
1017
+ </div>
1018
+ <div class="result-description">
1019
+ <h4>Return Value</h4>
1020
+ <p class="para">The created download request.</p>
1021
+ </div>
1022
+ <div class="result-description view-on-github">
1023
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1600">Show on GitHub</a>
1024
+ </div>
1025
+ </section>
1026
+ </div>
1027
+ </li>
1028
+ </ul>
1029
+ </div>
1030
+ </section>
1031
+ </section>
1032
+ <section id="footer">
1033
+ <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>
1034
+ <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>
1035
+ </section>
1036
+ </article>
1037
+ </div>
1038
+ </body>
1039
+ </div>
1040
+ </html>