DownloadRequest.html 74 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DownloadRequest Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/DownloadRequest" class="dashAnchor"></a>
  16. <a title="DownloadRequest Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (77% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. DownloadRequest Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/MultipartUpload.html">MultipartUpload</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  166. </li>
  167. </ul>
  168. </li>
  169. <li class="nav-group-name">
  170. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  171. <ul class="nav-group-tasks">
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  201. </li>
  202. </ul>
  203. </li>
  204. <li class="nav-group-name">
  205. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  206. <ul class="nav-group-tasks">
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="../Extensions/Bundle.html">Bundle</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/SecTrust.html">SecTrust</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  242. </li>
  243. </ul>
  244. </li>
  245. <li class="nav-group-name">
  246. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  247. <ul class="nav-group-tasks">
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  250. </li>
  251. </ul>
  252. </li>
  253. <li class="nav-group-name">
  254. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  255. <ul class="nav-group-tasks">
  256. <li class="nav-group-task">
  257. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  258. </li>
  259. <li class="nav-group-task">
  260. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  261. </li>
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/SessionStateProvider.html">SessionStateProvider</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  303. </li>
  304. </ul>
  305. </li>
  306. <li class="nav-group-name">
  307. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  308. <ul class="nav-group-tasks">
  309. <li class="nav-group-task">
  310. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  311. </li>
  312. <li class="nav-group-task">
  313. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  314. </li>
  315. <li class="nav-group-task">
  316. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  317. </li>
  318. <li class="nav-group-task">
  319. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  320. </li>
  321. <li class="nav-group-task">
  322. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  323. </li>
  324. <li class="nav-group-task">
  325. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  326. </li>
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  332. </li>
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  338. </li>
  339. </ul>
  340. </li>
  341. <li class="nav-group-name">
  342. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  343. <ul class="nav-group-tasks">
  344. <li class="nav-group-task">
  345. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  346. </li>
  347. <li class="nav-group-task">
  348. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  349. </li>
  350. </ul>
  351. </li>
  352. </ul>
  353. </nav>
  354. <article class="main-content">
  355. <section class="section">
  356. <div class="section-content">
  357. <h1>DownloadRequest</h1>
  358. <div class="declaration">
  359. <div class="language">
  360. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span> <span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
  361. </div>
  362. </div>
  363. <p>Undocumented</p>
  364. </div>
  365. </section>
  366. <section class="section">
  367. <div class="section-content">
  368. <div class="task-group">
  369. <ul class="item-container">
  370. <li class="item">
  371. <div>
  372. <code>
  373. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  374. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  375. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  376. </code>
  377. </div>
  378. <div class="height-container">
  379. <div class="pointer-container"></div>
  380. <section class="section">
  381. <div class="pointer"></div>
  382. <div class="abstract">
  383. <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
  384. destination URL.</p>
  385. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  386. </div>
  387. <div class="declaration">
  388. <h4>Declaration</h4>
  389. <div class="language">
  390. <p class="aside-title">Swift</p>
  391. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Options</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>
  392. </div>
  393. </div>
  394. </section>
  395. </div>
  396. </li>
  397. <li class="item">
  398. <div>
  399. <code>
  400. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  401. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  402. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  403. </code>
  404. </div>
  405. <div class="height-container">
  406. <div class="pointer-container"></div>
  407. <section class="section">
  408. <div class="pointer"></div>
  409. <div class="abstract">
  410. <p>A closure executed once a download request has successfully completed in order to determine where to move the
  411. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  412. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  413. the options defining how the file should be moved.</p>
  414. </div>
  415. <div class="declaration">
  416. <h4>Declaration</h4>
  417. <div class="language">
  418. <p class="aside-title">Swift</p>
  419. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Destination</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">temporaryURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">destinationURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Options.html">Options</a></span><span class="p">)</span></code></pre>
  420. </div>
  421. </div>
  422. </section>
  423. </div>
  424. </li>
  425. </ul>
  426. </div>
  427. <div class="task-group">
  428. <div class="task-name-container">
  429. <a name="/Destination"></a>
  430. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  431. <a href="#/Destination">
  432. <h3 class="section-name">Destination</h3>
  433. </a>
  434. </div>
  435. <ul class="item-container">
  436. <li class="item">
  437. <div>
  438. <code>
  439. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  440. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  441. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:in:options:)</a>
  442. </code>
  443. </div>
  444. <div class="height-container">
  445. <div class="pointer-container"></div>
  446. <section class="section">
  447. <div class="pointer"></div>
  448. <div class="abstract">
  449. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  450. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  451. </div>
  452. <div class="declaration">
  453. <h4>Declaration</h4>
  454. <div class="language">
  455. <p class="aside-title">Swift</p>
  456. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">suggestedDownloadDestination</span><span class="p">(</span><span class="k">for</span> <span class="nv">directory</span><span class="p">:</span> <span class="kt">FileManager</span><span class="o">.</span><span class="kt">SearchPathDirectory</span> <span class="o">=</span> <span class="o">.</span><span class="n">documentDirectory</span><span class="p">,</span>
  457. <span class="k">in</span> <span class="nv">domain</span><span class="p">:</span> <span class="kt">FileManager</span><span class="o">.</span><span class="kt">SearchPathDomainMask</span> <span class="o">=</span> <span class="o">.</span><span class="n">userDomainMask</span><span class="p">,</span>
  458. <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Options.html">Options</a></span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></span></code></pre>
  459. </div>
  460. </div>
  461. <div>
  462. <h4>Parameters</h4>
  463. <table class="graybox">
  464. <tbody>
  465. <tr>
  466. <td>
  467. <code>
  468. <em>directory</em>
  469. </code>
  470. </td>
  471. <td>
  472. <div>
  473. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  474. </div>
  475. </td>
  476. </tr>
  477. <tr>
  478. <td>
  479. <code>
  480. <em>domain</em>
  481. </code>
  482. </td>
  483. <td>
  484. <div>
  485. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  486. </div>
  487. </td>
  488. </tr>
  489. </tbody>
  490. </table>
  491. </div>
  492. <div>
  493. <h4>Return Value</h4>
  494. <p>A download file destination closure.</p>
  495. </div>
  496. </section>
  497. </div>
  498. </li>
  499. <li class="item">
  500. <div>
  501. <code>
  502. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  503. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  504. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  505. </code>
  506. </div>
  507. <div class="height-container">
  508. <div class="pointer-container"></div>
  509. <section class="section">
  510. <div class="pointer"></div>
  511. <div class="abstract">
  512. <p>Undocumented</p>
  513. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  514. </div>
  515. <div class="declaration">
  516. <h4>Declaration</h4>
  517. <div class="language">
  518. <p class="aside-title">Swift</p>
  519. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  520. </div>
  521. </div>
  522. </section>
  523. </div>
  524. </li>
  525. </ul>
  526. </div>
  527. <div class="task-group">
  528. <div class="task-name-container">
  529. <a name="/Initial%20State"></a>
  530. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  531. <a href="#/Initial%20State">
  532. <h3 class="section-name">Initial State</h3>
  533. </a>
  534. </div>
  535. <ul class="item-container">
  536. <li class="item">
  537. <div>
  538. <code>
  539. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  540. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  541. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  542. </code>
  543. </div>
  544. <div class="height-container">
  545. <div class="pointer-container"></div>
  546. <section class="section">
  547. <div class="pointer"></div>
  548. <div class="abstract">
  549. <p>Undocumented</p>
  550. </div>
  551. <div class="declaration">
  552. <h4>Declaration</h4>
  553. <div class="language">
  554. <p class="aside-title">Swift</p>
  555. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">downloadable</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></span></code></pre>
  556. </div>
  557. </div>
  558. </section>
  559. </div>
  560. </li>
  561. </ul>
  562. </div>
  563. <div class="task-group">
  564. <div class="task-name-container">
  565. <a name="/Updated%20State"></a>
  566. <a name="//apple_ref/swift/Section/Updated State" class="dashAnchor"></a>
  567. <a href="#/Updated%20State">
  568. <h3 class="section-name">Updated State</h3>
  569. </a>
  570. </div>
  571. <ul class="item-container">
  572. <li class="item">
  573. <div>
  574. <code>
  575. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  576. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  577. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  578. </code>
  579. </div>
  580. <div class="height-container">
  581. <div class="pointer-container"></div>
  582. <section class="section">
  583. <div class="pointer"></div>
  584. <div class="abstract">
  585. <p>Undocumented</p>
  586. </div>
  587. <div class="declaration">
  588. <h4>Declaration</h4>
  589. <div class="language">
  590. <p class="aside-title">Swift</p>
  591. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  592. </div>
  593. </div>
  594. </section>
  595. </div>
  596. </li>
  597. <li class="item">
  598. <div>
  599. <code>
  600. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  601. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  602. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  603. </code>
  604. </div>
  605. <div class="height-container">
  606. <div class="pointer-container"></div>
  607. <section class="section">
  608. <div class="pointer"></div>
  609. <div class="abstract">
  610. <p>Undocumented</p>
  611. </div>
  612. <div class="declaration">
  613. <h4>Declaration</h4>
  614. <div class="language">
  615. <p class="aside-title">Swift</p>
  616. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  617. </div>
  618. </div>
  619. </section>
  620. </div>
  621. </li>
  622. </ul>
  623. </div>
  624. <div class="task-group">
  625. <div class="task-name-container">
  626. <a name="/Init"></a>
  627. <a name="//apple_ref/swift/Section/Init" class="dashAnchor"></a>
  628. <a href="#/Init">
  629. <h3 class="section-name">Init</h3>
  630. </a>
  631. </div>
  632. <ul class="item-container">
  633. <li class="item">
  634. <div>
  635. <code>
  636. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  637. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  638. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:using:)</a>
  639. </code>
  640. </div>
  641. <div class="height-container">
  642. <div class="pointer-container"></div>
  643. <section class="section">
  644. <div class="pointer"></div>
  645. <div class="abstract">
  646. <p>Undocumented</p>
  647. </div>
  648. <div class="declaration">
  649. <h4>Declaration</h4>
  650. <div class="language">
  651. <p class="aside-title">Swift</p>
  652. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">task</span><span class="p">(</span><span class="n">forResumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">using</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">URLSessionTask</span></code></pre>
  653. </div>
  654. </div>
  655. </section>
  656. </div>
  657. </li>
  658. <li class="item">
  659. <div>
  660. <code>
  661. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  662. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  663. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  664. </code>
  665. </div>
  666. <div class="height-container">
  667. <div class="pointer-container"></div>
  668. <section class="section">
  669. <div class="pointer"></div>
  670. <div class="abstract">
  671. </div>
  672. <div class="declaration">
  673. <h4>Declaration</h4>
  674. <div class="language">
  675. <p class="aside-title">Swift</p>
  676. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  677. <span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  678. </div>
  679. </div>
  680. </section>
  681. </div>
  682. </li>
  683. <li class="item">
  684. <div>
  685. <code>
  686. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDAA6ResultOyytG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAH3URLVSgtcF"></a>
  687. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  688. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDAA6ResultOyytG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAH3URLVSgtcF">validate(_:)</a>
  689. </code>
  690. </div>
  691. <div class="height-container">
  692. <div class="pointer-container"></div>
  693. <section class="section">
  694. <div class="pointer"></div>
  695. <div class="abstract">
  696. <p>Validates the request, using the specified closure.</p>
  697. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  698. </div>
  699. <div class="declaration">
  700. <h4>Declaration</h4>
  701. <div class="language">
  702. <p class="aside-title">Swift</p>
  703. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  704. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="n">_</span> <span class="nv">validation</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  705. </div>
  706. </div>
  707. <div>
  708. <h4>Parameters</h4>
  709. <table class="graybox">
  710. <tbody>
  711. <tr>
  712. <td>
  713. <code>
  714. <em>validation</em>
  715. </code>
  716. </td>
  717. <td>
  718. <div>
  719. <p>A closure to validate the request.</p>
  720. </div>
  721. </td>
  722. </tr>
  723. </tbody>
  724. </table>
  725. </div>
  726. <div>
  727. <h4>Return Value</h4>
  728. <p>The request.</p>
  729. </div>
  730. </section>
  731. </div>
  732. </li>
  733. </ul>
  734. </div>
  735. <div class="task-group">
  736. <div class="task-name-container">
  737. <a name="/Default"></a>
  738. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  739. <a href="#/Default">
  740. <h3 class="section-name">Default</h3>
  741. </a>
  742. </div>
  743. <ul class="item-container">
  744. <li class="item">
  745. <div>
  746. <code>
  747. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA0B8ResponseVy10Foundation3URLVSgGctF"></a>
  748. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  749. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA0B8ResponseVy10Foundation3URLVSgGctF">response(queue:completionHandler:)</a>
  750. </code>
  751. </div>
  752. <div class="height-container">
  753. <div class="pointer-container"></div>
  754. <section class="section">
  755. <div class="pointer"></div>
  756. <div class="abstract">
  757. <p>Adds a handler to be called once the request has finished.</p>
  758. </div>
  759. <div class="declaration">
  760. <h4>Declaration</h4>
  761. <div class="language">
  762. <p class="aside-title">Swift</p>
  763. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  764. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
  765. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  766. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="p">?</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  767. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  768. </div>
  769. </div>
  770. <div>
  771. <h4>Parameters</h4>
  772. <table class="graybox">
  773. <tbody>
  774. <tr>
  775. <td>
  776. <code>
  777. <em>queue</em>
  778. </code>
  779. </td>
  780. <td>
  781. <div>
  782. <p>The queue on which the completion handler is dispatched. Defaults to <code>nil</code>, which means
  783. the handler is called on <code>.main</code>.</p>
  784. </div>
  785. </td>
  786. </tr>
  787. <tr>
  788. <td>
  789. <code>
  790. <em>completionHandler</em>
  791. </code>
  792. </td>
  793. <td>
  794. <div>
  795. <p>The code to be executed once the request has finished.</p>
  796. </div>
  797. </td>
  798. </tr>
  799. </tbody>
  800. </table>
  801. </div>
  802. <div>
  803. <h4>Return Value</h4>
  804. <p>The request.</p>
  805. </div>
  806. </section>
  807. </div>
  808. </li>
  809. <li class="item">
  810. <div>
  811. <code>
  812. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF"></a>
  813. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  814. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  815. </code>
  816. </div>
  817. <div class="height-container">
  818. <div class="pointer-container"></div>
  819. <section class="section">
  820. <div class="pointer"></div>
  821. <div class="abstract">
  822. <p>Adds a handler to be called once the request has finished.</p>
  823. </div>
  824. <div class="declaration">
  825. <h4>Declaration</h4>
  826. <div class="language">
  827. <p class="aside-title">Swift</p>
  828. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  829. <span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="o">&gt;</span><span class="p">(</span>
  830. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  831. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
  832. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  833. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  834. </div>
  835. </div>
  836. <div>
  837. <h4>Parameters</h4>
  838. <table class="graybox">
  839. <tbody>
  840. <tr>
  841. <td>
  842. <code>
  843. <em>queue</em>
  844. </code>
  845. </td>
  846. <td>
  847. <div>
  848. <p>The queue on which the completion handler is dispatched. Defaults to <code>nil</code>, which means
  849. the handler is called on <code>.main</code>.</p>
  850. </div>
  851. </td>
  852. </tr>
  853. <tr>
  854. <td>
  855. <code>
  856. <em>responseSerializer</em>
  857. </code>
  858. </td>
  859. <td>
  860. <div>
  861. <p>The response serializer responsible for serializing the request, response, and data
  862. contained in the destination url.</p>
  863. </div>
  864. </td>
  865. </tr>
  866. <tr>
  867. <td>
  868. <code>
  869. <em>completionHandler</em>
  870. </code>
  871. </td>
  872. <td>
  873. <div>
  874. <p>The code to be executed once the request has finished.</p>
  875. </div>
  876. </td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. </div>
  881. <div>
  882. <h4>Return Value</h4>
  883. <p>The request.</p>
  884. </div>
  885. </section>
  886. </div>
  887. </li>
  888. </ul>
  889. </div>
  890. <div class="task-group">
  891. <div class="task-name-container">
  892. <a name="/Data"></a>
  893. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  894. <a href="#/Data">
  895. <h3 class="section-name">Data</h3>
  896. </a>
  897. </div>
  898. <ul class="item-container">
  899. <li class="item">
  900. <div>
  901. <code>
  902. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF"></a>
  903. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  904. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF">responseData(queue:completionHandler:)</a>
  905. </code>
  906. </div>
  907. <div class="height-container">
  908. <div class="pointer-container"></div>
  909. <section class="section">
  910. <div class="pointer"></div>
  911. <div class="abstract">
  912. <p>Adds a handler to be called once the request has finished.</p>
  913. </div>
  914. <div class="declaration">
  915. <h4>Declaration</h4>
  916. <div class="language">
  917. <p class="aside-title">Swift</p>
  918. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  919. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
  920. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  921. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  922. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  923. </div>
  924. </div>
  925. <div>
  926. <h4>Parameters</h4>
  927. <table class="graybox">
  928. <tbody>
  929. <tr>
  930. <td>
  931. <code>
  932. <em>queue</em>
  933. </code>
  934. </td>
  935. <td>
  936. <div>
  937. <p>The queue on which the completion handler is dispatched. Defaults to <code>nil</code>, which means
  938. the handler is called on <code>.main</code>.</p>
  939. </div>
  940. </td>
  941. </tr>
  942. <tr>
  943. <td>
  944. <code>
  945. <em>completionHandler</em>
  946. </code>
  947. </td>
  948. <td>
  949. <div>
  950. <p>The code to be executed once the request has finished.</p>
  951. </div>
  952. </td>
  953. </tr>
  954. </tbody>
  955. </table>
  956. </div>
  957. <div>
  958. <h4>Return Value</h4>
  959. <p>The request.</p>
  960. </div>
  961. </section>
  962. </div>
  963. </li>
  964. </ul>
  965. </div>
  966. <div class="task-group">
  967. <div class="task-name-container">
  968. <a name="/String"></a>
  969. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  970. <a href="#/String">
  971. <h3 class="section-name">String</h3>
  972. </a>
  973. </div>
  974. <ul class="item-container">
  975. <li class="item">
  976. <div>
  977. <code>
  978. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF"></a>
  979. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  980. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF">responseString(queue:encoding:completionHandler:)</a>
  981. </code>
  982. </div>
  983. <div class="height-container">
  984. <div class="pointer-container"></div>
  985. <section class="section">
  986. <div class="pointer"></div>
  987. <div class="abstract">
  988. <p>Adds a handler to be called once the request has finished.</p>
  989. </div>
  990. <div class="declaration">
  991. <h4>Declaration</h4>
  992. <div class="language">
  993. <p class="aside-title">Swift</p>
  994. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  995. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
  996. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  997. <span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  998. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  999. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1000. </div>
  1001. </div>
  1002. <div>
  1003. <h4>Parameters</h4>
  1004. <table class="graybox">
  1005. <tbody>
  1006. <tr>
  1007. <td>
  1008. <code>
  1009. <em>queue</em>
  1010. </code>
  1011. </td>
  1012. <td>
  1013. <div>
  1014. <p>The queue on which the completion handler is dispatched. Defaults to <code>nil</code>, which means
  1015. the handler is called on <code>.main</code>.</p>
  1016. </div>
  1017. </td>
  1018. </tr>
  1019. <tr>
  1020. <td>
  1021. <code>
  1022. <em>encoding</em>
  1023. </code>
  1024. </td>
  1025. <td>
  1026. <div>
  1027. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined from
  1028. the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1029. </div>
  1030. </td>
  1031. </tr>
  1032. <tr>
  1033. <td>
  1034. <code>
  1035. <em>completionHandler</em>
  1036. </code>
  1037. </td>
  1038. <td>
  1039. <div>
  1040. <p>A closure to be executed once the request has finished.</p>
  1041. </div>
  1042. </td>
  1043. </tr>
  1044. </tbody>
  1045. </table>
  1046. </div>
  1047. <div>
  1048. <h4>Return Value</h4>
  1049. <p>The request.</p>
  1050. </div>
  1051. </section>
  1052. </div>
  1053. </li>
  1054. </ul>
  1055. </div>
  1056. <div class="task-group">
  1057. <div class="task-name-container">
  1058. <a name="/JSON"></a>
  1059. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1060. <a href="#/JSON">
  1061. <h3 class="section-name">JSON</h3>
  1062. </a>
  1063. </div>
  1064. <ul class="item-container">
  1065. <li class="item">
  1066. <div>
  1067. <code>
  1068. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF"></a>
  1069. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1070. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF">responseJSON(queue:options:completionHandler:)</a>
  1071. </code>
  1072. </div>
  1073. <div class="height-container">
  1074. <div class="pointer-container"></div>
  1075. <section class="section">
  1076. <div class="pointer"></div>
  1077. <div class="abstract">
  1078. <p>Adds a handler to be called once the request has finished.</p>
  1079. </div>
  1080. <div class="declaration">
  1081. <h4>Declaration</h4>
  1082. <div class="language">
  1083. <p class="aside-title">Swift</p>
  1084. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1085. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
  1086. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1087. <span class="nv">options</span><span class="p">:</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="kt">ReadingOptions</span> <span class="o">=</span> <span class="o">.</span><span class="n">allowFragments</span><span class="p">,</span>
  1088. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1089. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1090. </div>
  1091. </div>
  1092. <div>
  1093. <h4>Parameters</h4>
  1094. <table class="graybox">
  1095. <tbody>
  1096. <tr>
  1097. <td>
  1098. <code>
  1099. <em>queue</em>
  1100. </code>
  1101. </td>
  1102. <td>
  1103. <div>
  1104. <p>The queue on which the completion handler is dispatched. Defaults to <code>nil</code>, which means
  1105. the handler is called on <code>.main</code>.</p>
  1106. </div>
  1107. </td>
  1108. </tr>
  1109. <tr>
  1110. <td>
  1111. <code>
  1112. <em>options</em>
  1113. </code>
  1114. </td>
  1115. <td>
  1116. <div>
  1117. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1118. </div>
  1119. </td>
  1120. </tr>
  1121. <tr>
  1122. <td>
  1123. <code>
  1124. <em>completionHandler</em>
  1125. </code>
  1126. </td>
  1127. <td>
  1128. <div>
  1129. <p>A closure to be executed once the request has finished.</p>
  1130. </div>
  1131. </td>
  1132. </tr>
  1133. </tbody>
  1134. </table>
  1135. </div>
  1136. <div>
  1137. <h4>Return Value</h4>
  1138. <p>The request.</p>
  1139. </div>
  1140. </section>
  1141. </div>
  1142. </li>
  1143. </ul>
  1144. </div>
  1145. <div class="task-group">
  1146. <ul class="item-container">
  1147. <li class="item">
  1148. <div>
  1149. <code>
  1150. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1151. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1152. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1153. </code>
  1154. </div>
  1155. <div class="height-container">
  1156. <div class="pointer-container"></div>
  1157. <section class="section">
  1158. <div class="pointer"></div>
  1159. <div class="abstract">
  1160. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1161. destination URL, and returns whether the request was valid.</p>
  1162. </div>
  1163. <div class="declaration">
  1164. <h4>Declaration</h4>
  1165. <div class="language">
  1166. <p class="aside-title">Swift</p>
  1167. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Validation</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span> <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span> <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  1168. </div>
  1169. </div>
  1170. </section>
  1171. </div>
  1172. </li>
  1173. <li class="item">
  1174. <div>
  1175. <code>
  1176. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1177. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1178. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1179. </code>
  1180. </div>
  1181. <div class="height-container">
  1182. <div class="pointer-container"></div>
  1183. <section class="section">
  1184. <div class="pointer"></div>
  1185. <div class="abstract">
  1186. <p>Validates that the response has a status code in the specified sequence.</p>
  1187. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1188. </div>
  1189. <div class="declaration">
  1190. <h4>Declaration</h4>
  1191. <div class="language">
  1192. <p class="aside-title">Swift</p>
  1193. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1194. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">statusCode</span> <span class="nv">acceptableStatusCodes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
  1195. </div>
  1196. </div>
  1197. <div>
  1198. <h4>Parameters</h4>
  1199. <table class="graybox">
  1200. <tbody>
  1201. <tr>
  1202. <td>
  1203. <code>
  1204. <em>range</em>
  1205. </code>
  1206. </td>
  1207. <td>
  1208. <div>
  1209. <p>The range of acceptable status codes.</p>
  1210. </div>
  1211. </td>
  1212. </tr>
  1213. </tbody>
  1214. </table>
  1215. </div>
  1216. <div>
  1217. <h4>Return Value</h4>
  1218. <p>The request.</p>
  1219. </div>
  1220. </section>
  1221. </div>
  1222. </li>
  1223. <li class="item">
  1224. <div>
  1225. <code>
  1226. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1227. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1228. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1229. </code>
  1230. </div>
  1231. <div class="height-container">
  1232. <div class="pointer-container"></div>
  1233. <section class="section">
  1234. <div class="pointer"></div>
  1235. <div class="abstract">
  1236. <p>Validates that the response has a content type in the specified sequence.</p>
  1237. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1238. </div>
  1239. <div class="declaration">
  1240. <h4>Declaration</h4>
  1241. <div class="language">
  1242. <p class="aside-title">Swift</p>
  1243. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1244. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">&gt;</span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  1245. </div>
  1246. </div>
  1247. <div>
  1248. <h4>Parameters</h4>
  1249. <table class="graybox">
  1250. <tbody>
  1251. <tr>
  1252. <td>
  1253. <code>
  1254. <em>contentType</em>
  1255. </code>
  1256. </td>
  1257. <td>
  1258. <div>
  1259. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1260. </div>
  1261. </td>
  1262. </tr>
  1263. </tbody>
  1264. </table>
  1265. </div>
  1266. <div>
  1267. <h4>Return Value</h4>
  1268. <p>The request.</p>
  1269. </div>
  1270. </section>
  1271. </div>
  1272. </li>
  1273. <li class="item">
  1274. <div>
  1275. <code>
  1276. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1277. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1278. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1279. </code>
  1280. </div>
  1281. <div class="height-container">
  1282. <div class="pointer-container"></div>
  1283. <section class="section">
  1284. <div class="pointer"></div>
  1285. <div class="abstract">
  1286. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1287. type matches any specified in the Accept HTTP header field.</p>
  1288. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1289. </div>
  1290. <div class="declaration">
  1291. <h4>Declaration</h4>
  1292. <div class="language">
  1293. <p class="aside-title">Swift</p>
  1294. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1295. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1296. </div>
  1297. </div>
  1298. <div>
  1299. <h4>Return Value</h4>
  1300. <p>The request.</p>
  1301. </div>
  1302. </section>
  1303. </div>
  1304. </li>
  1305. </ul>
  1306. </div>
  1307. </div>
  1308. </section>
  1309. </article>
  1310. </div>
  1311. <section class="footer">
  1312. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-12-05)</p>
  1313. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1314. </section>
  1315. </body>
  1316. </div>
  1317. </html>