DownloadRequest.html 76 KB

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