DownloadRequest.html 95 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730
  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. (97% 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/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  192. </li>
  193. </ul>
  194. </li>
  195. <li class="nav-group-name">
  196. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  197. <ul class="nav-group-tasks">
  198. <li class="nav-group-task">
  199. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  200. </li>
  201. <li class="nav-group-task">
  202. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  203. </li>
  204. <li class="nav-group-task">
  205. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  206. </li>
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  280. </li>
  281. </ul>
  282. </li>
  283. <li class="nav-group-name">
  284. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  285. <ul class="nav-group-tasks">
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  348. </li>
  349. </ul>
  350. </li>
  351. <li class="nav-group-name">
  352. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  353. <ul class="nav-group-tasks">
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  407. </li>
  408. </ul>
  409. </li>
  410. <li class="nav-group-name">
  411. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  412. <ul class="nav-group-tasks">
  413. <li class="nav-group-task">
  414. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  415. </li>
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  430. </li>
  431. </ul>
  432. </li>
  433. </ul>
  434. </nav>
  435. <article class="main-content">
  436. <section class="section">
  437. <div class="section-content top-matter">
  438. <h1>DownloadRequest</h1>
  439. <div class="declaration">
  440. <div class="language">
  441. <pre class="highlight swift"><code><span class="kd">public</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>
  442. </div>
  443. </div>
  444. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which downloads <code>Data</code> to a file on disk using <code>URLSessionDownloadTask</code>.</p>
  445. </div>
  446. </section>
  447. <section class="section">
  448. <div class="section-content">
  449. <div class="task-group">
  450. <ul class="item-container">
  451. <li class="item">
  452. <div>
  453. <code>
  454. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  455. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  456. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  457. </code>
  458. </div>
  459. <div class="height-container">
  460. <div class="pointer-container"></div>
  461. <section class="section">
  462. <div class="pointer"></div>
  463. <div class="abstract">
  464. <p>A set of options to be executed prior to moving a downloaded file from the temporary <code>URL</code> to the destination
  465. <code>URL</code>.</p>
  466. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  467. </div>
  468. <div class="declaration">
  469. <h4>Declaration</h4>
  470. <div class="language">
  471. <p class="aside-title">Swift</p>
  472. <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>
  473. </div>
  474. </div>
  475. </section>
  476. </div>
  477. </li>
  478. </ul>
  479. </div>
  480. <div class="task-group">
  481. <div class="task-name-container">
  482. <a name="/Destination"></a>
  483. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  484. <div class="section-name-container">
  485. <a class="section-name-link" href="#/Destination"></a>
  486. <h3 class="section-name"><p>Destination</p>
  487. </h3>
  488. </div>
  489. </div>
  490. <ul class="item-container">
  491. <li class="item">
  492. <div>
  493. <code>
  494. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  495. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  496. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  497. </code>
  498. </div>
  499. <div class="height-container">
  500. <div class="pointer-container"></div>
  501. <section class="section">
  502. <div class="pointer"></div>
  503. <div class="abstract">
  504. <p>A closure executed once a <code>DownloadRequest</code> has successfully completed in order to determine where to move the
  505. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  506. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  507. the options defining how the file should be moved.</p>
  508. </div>
  509. <div class="declaration">
  510. <h4>Declaration</h4>
  511. <div class="language">
  512. <p class="aside-title">Swift</p>
  513. <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>
  514. </div>
  515. </div>
  516. </section>
  517. </div>
  518. </li>
  519. <li class="item">
  520. <div>
  521. <code>
  522. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  523. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  524. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:in:options:)</a>
  525. </code>
  526. </div>
  527. <div class="height-container">
  528. <div class="pointer-container"></div>
  529. <section class="section">
  530. <div class="pointer"></div>
  531. <div class="abstract">
  532. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  533. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  534. </div>
  535. <div class="declaration">
  536. <h4>Declaration</h4>
  537. <div class="language">
  538. <p class="aside-title">Swift</p>
  539. <pre class="highlight swift"><code><span class="kd">public</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>
  540. <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>
  541. <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>
  542. </div>
  543. </div>
  544. <div>
  545. <h4>Parameters</h4>
  546. <table class="graybox">
  547. <tbody>
  548. <tr>
  549. <td>
  550. <code>
  551. <em>directory</em>
  552. </code>
  553. </td>
  554. <td>
  555. <div>
  556. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  557. </div>
  558. </td>
  559. </tr>
  560. <tr>
  561. <td>
  562. <code>
  563. <em>domain</em>
  564. </code>
  565. </td>
  566. <td>
  567. <div>
  568. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  569. </div>
  570. </td>
  571. </tr>
  572. <tr>
  573. <td>
  574. <code>
  575. <em>options</em>
  576. </code>
  577. </td>
  578. <td>
  579. <div>
  580. <p><code><a href="../Classes/DownloadRequest/Options.html">DownloadRequest.Options</a></code> used when moving the downloaded file to its destination. None by
  581. default.</p>
  582. </div>
  583. </td>
  584. </tr>
  585. </tbody>
  586. </table>
  587. </div>
  588. <div>
  589. <h4>Return Value</h4>
  590. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></code> closure.</p>
  591. </div>
  592. </section>
  593. </div>
  594. </li>
  595. </ul>
  596. </div>
  597. <div class="task-group">
  598. <div class="task-name-container">
  599. <a name="/Downloadable"></a>
  600. <a name="//apple_ref/swift/Section/Downloadable" class="dashAnchor"></a>
  601. <div class="section-name-container">
  602. <a class="section-name-link" href="#/Downloadable"></a>
  603. <h3 class="section-name"><p>Downloadable</p>
  604. </h3>
  605. </div>
  606. </div>
  607. <ul class="item-container">
  608. <li class="item">
  609. <div>
  610. <code>
  611. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  612. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  613. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  614. </code>
  615. </div>
  616. <div class="height-container">
  617. <div class="pointer-container"></div>
  618. <section class="section">
  619. <div class="pointer"></div>
  620. <div class="abstract">
  621. <p>Type describing the source used to create the underlying <code>URLSessionDownloadTask</code>.</p>
  622. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  623. </div>
  624. <div class="declaration">
  625. <h4>Declaration</h4>
  626. <div class="language">
  627. <p class="aside-title">Swift</p>
  628. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  629. </div>
  630. </div>
  631. </section>
  632. </div>
  633. </li>
  634. </ul>
  635. </div>
  636. <div class="task-group">
  637. <div class="task-name-container">
  638. <a name="/Mutable%20State"></a>
  639. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  640. <div class="section-name-container">
  641. <a class="section-name-link" href="#/Mutable%20State"></a>
  642. <h3 class="section-name"><p>Mutable State</p>
  643. </h3>
  644. </div>
  645. </div>
  646. <ul class="item-container">
  647. <li class="item">
  648. <div>
  649. <code>
  650. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  651. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  652. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  653. </code>
  654. </div>
  655. <div class="height-container">
  656. <div class="pointer-container"></div>
  657. <section class="section">
  658. <div class="pointer"></div>
  659. <div class="abstract">
  660. <p>If the download is resumable and eventually cancelled, this value may be used to resume the download using the
  661. <code>download(resumingWith data:)</code> API.</p>
  662. <div class="aside aside-note">
  663. <p class="aside-title">Note</p>
  664. For more information about <code>resumeData</code>, see <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>.
  665. </div>
  666. </div>
  667. <div class="declaration">
  668. <h4>Declaration</h4>
  669. <div class="language">
  670. <p class="aside-title">Swift</p>
  671. <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>
  672. </div>
  673. </div>
  674. </section>
  675. </div>
  676. </li>
  677. <li class="item">
  678. <div>
  679. <code>
  680. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  681. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  682. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  683. </code>
  684. </div>
  685. <div class="height-container">
  686. <div class="pointer-container"></div>
  687. <section class="section">
  688. <div class="pointer"></div>
  689. <div class="abstract">
  690. <p>If the download is successful, the <code>URL</code> where the file was downloaded.</p>
  691. </div>
  692. <div class="declaration">
  693. <h4>Declaration</h4>
  694. <div class="language">
  695. <p class="aside-title">Swift</p>
  696. <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>
  697. </div>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. </ul>
  703. </div>
  704. <div class="task-group">
  705. <div class="task-name-container">
  706. <a name="/Initial%20State"></a>
  707. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  708. <div class="section-name-container">
  709. <a class="section-name-link" href="#/Initial%20State"></a>
  710. <h3 class="section-name"><p>Initial State</p>
  711. </h3>
  712. </div>
  713. </div>
  714. <ul class="item-container">
  715. <li class="item">
  716. <div>
  717. <code>
  718. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  719. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  720. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  721. </code>
  722. </div>
  723. <div class="height-container">
  724. <div class="pointer-container"></div>
  725. <section class="section">
  726. <div class="pointer"></div>
  727. <div class="abstract">
  728. <p><code><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></code> value used for this instance.</p>
  729. </div>
  730. <div class="declaration">
  731. <h4>Declaration</h4>
  732. <div class="language">
  733. <p class="aside-title">Swift</p>
  734. <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>
  735. </div>
  736. </div>
  737. </section>
  738. </div>
  739. </li>
  740. <li class="item">
  741. <div>
  742. <code>
  743. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  744. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  745. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:using:)</a>
  746. </code>
  747. </div>
  748. <div class="height-container">
  749. <div class="pointer-container"></div>
  750. <section class="section">
  751. <div class="pointer"></div>
  752. <div class="abstract">
  753. <p>Creates a <code>URLSessionTask</code> from the provided resume data.</p>
  754. </div>
  755. <div class="declaration">
  756. <h4>Declaration</h4>
  757. <div class="language">
  758. <p class="aside-title">Swift</p>
  759. <pre class="highlight swift"><code><span class="kd">public</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>
  760. </div>
  761. </div>
  762. <div>
  763. <h4>Parameters</h4>
  764. <table class="graybox">
  765. <tbody>
  766. <tr>
  767. <td>
  768. <code>
  769. <em>data</em>
  770. </code>
  771. </td>
  772. <td>
  773. <div>
  774. <p><code>Data</code> used to resume the download.</p>
  775. </div>
  776. </td>
  777. </tr>
  778. <tr>
  779. <td>
  780. <code>
  781. <em>session</em>
  782. </code>
  783. </td>
  784. <td>
  785. <div>
  786. <p><code>URLSession</code> used to create the <code>URLSessionTask</code>.</p>
  787. </div>
  788. </td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. </div>
  793. <div>
  794. <h4>Return Value</h4>
  795. <p>The <code>URLSessionTask</code> created.</p>
  796. </div>
  797. </section>
  798. </div>
  799. </li>
  800. <li class="item">
  801. <div>
  802. <code>
  803. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  804. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  805. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  806. </code>
  807. </div>
  808. <div class="height-container">
  809. <div class="pointer-container"></div>
  810. <section class="section">
  811. <div class="pointer"></div>
  812. <div class="abstract">
  813. <p>Cancels the instance. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed or suspended.</p>
  814. <div class="aside aside-note">
  815. <p class="aside-title">Note</p>
  816. <p>This method will NOT produce resume data. If you wish to cancel and produce resume data, use
  817. <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:)</a></code> or <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:)</a></code>.</p>
  818. </div>
  819. </div>
  820. <div class="declaration">
  821. <h4>Declaration</h4>
  822. <div class="language">
  823. <p class="aside-title">Swift</p>
  824. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  825. <span class="kd">public</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>
  826. </div>
  827. </div>
  828. <div>
  829. <h4>Return Value</h4>
  830. <p>The instance.</p>
  831. </div>
  832. </section>
  833. </div>
  834. </li>
  835. <li class="item">
  836. <div>
  837. <code>
  838. <a name="/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF"></a>
  839. <a name="//apple_ref/swift/Method/cancel(producingResumeData:)" class="dashAnchor"></a>
  840. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:)</a>
  841. </code>
  842. </div>
  843. <div class="height-container">
  844. <div class="pointer-container"></div>
  845. <section class="section">
  846. <div class="pointer"></div>
  847. <div class="abstract">
  848. <p>Cancels the instance, optionally producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be
  849. resumed or suspended.</p>
  850. <div class="aside aside-note">
  851. <p class="aside-title">Note</p>
  852. <p>If <code>producingResumeData</code> is <code>true</code>, the <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code> property will be populated with any resume data, if
  853. available.</p>
  854. </div>
  855. </div>
  856. <div class="declaration">
  857. <h4>Declaration</h4>
  858. <div class="language">
  859. <p class="aside-title">Swift</p>
  860. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  861. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">producingResumeData</span> <span class="nv">shouldProduceResumeData</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  862. </div>
  863. </div>
  864. <div>
  865. <h4>Return Value</h4>
  866. <p>The instance.</p>
  867. </div>
  868. </section>
  869. </div>
  870. </li>
  871. <li class="item">
  872. <div>
  873. <code>
  874. <a name="/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF"></a>
  875. <a name="//apple_ref/swift/Method/cancel(byProducingResumeData:)" class="dashAnchor"></a>
  876. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:)</a>
  877. </code>
  878. </div>
  879. <div class="height-container">
  880. <div class="pointer-container"></div>
  881. <section class="section">
  882. <div class="pointer"></div>
  883. <div class="abstract">
  884. <p>Cancels the instance while producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed
  885. or suspended.</p>
  886. <div class="aside aside-note">
  887. <p class="aside-title">Note</p>
  888. <p>The resume data passed to the completion handler will also be available on the instance&rsquo;s <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code>
  889. property.</p>
  890. </div>
  891. </div>
  892. <div class="declaration">
  893. <h4>Declaration</h4>
  894. <div class="language">
  895. <p class="aside-title">Swift</p>
  896. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  897. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">byProducingResumeData</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  898. </div>
  899. </div>
  900. <div>
  901. <h4>Parameters</h4>
  902. <table class="graybox">
  903. <tbody>
  904. <tr>
  905. <td>
  906. <code>
  907. <em>completionHandler</em>
  908. </code>
  909. </td>
  910. <td>
  911. <div>
  912. <p>The completion handler that is called when the download has been successfully
  913. cancelled. It is not guaranteed to be called on a particular queue, so you may
  914. want use an appropriate queue to perform your work.</p>
  915. </div>
  916. </td>
  917. </tr>
  918. </tbody>
  919. </table>
  920. </div>
  921. <div>
  922. <h4>Return Value</h4>
  923. <p>The instance.</p>
  924. </div>
  925. </section>
  926. </div>
  927. </li>
  928. <li class="item">
  929. <div>
  930. <code>
  931. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  932. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  933. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:)</a>
  934. </code>
  935. </div>
  936. <div class="height-container">
  937. <div class="pointer-container"></div>
  938. <section class="section">
  939. <div class="pointer"></div>
  940. <div class="abstract">
  941. <p>Validates the request, using the specified closure.</p>
  942. <div class="aside aside-note">
  943. <p class="aside-title">Note</p>
  944. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  945. </div>
  946. </div>
  947. <div class="declaration">
  948. <h4>Declaration</h4>
  949. <div class="language">
  950. <p class="aside-title">Swift</p>
  951. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  952. <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>
  953. </div>
  954. </div>
  955. <div>
  956. <h4>Parameters</h4>
  957. <table class="graybox">
  958. <tbody>
  959. <tr>
  960. <td>
  961. <code>
  962. <em>validation</em>
  963. </code>
  964. </td>
  965. <td>
  966. <div>
  967. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></code> closure to validate the response.</p>
  968. </div>
  969. </td>
  970. </tr>
  971. </tbody>
  972. </table>
  973. </div>
  974. <div>
  975. <h4>Return Value</h4>
  976. <p>The instance.</p>
  977. </div>
  978. </section>
  979. </div>
  980. </li>
  981. </ul>
  982. </div>
  983. <div class="task-group">
  984. <div class="task-name-container">
  985. <a name="/Default"></a>
  986. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  987. <div class="section-name-container">
  988. <a class="section-name-link" href="#/Default"></a>
  989. <h3 class="section-name"><p>Default</p>
  990. </h3>
  991. </div>
  992. </div>
  993. <ul class="item-container">
  994. <li class="item">
  995. <div>
  996. <code>
  997. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF"></a>
  998. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  999. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF">response(queue:completionHandler:)</a>
  1000. </code>
  1001. </div>
  1002. <div class="height-container">
  1003. <div class="pointer-container"></div>
  1004. <section class="section">
  1005. <div class="pointer"></div>
  1006. <div class="abstract">
  1007. <p>Adds a handler to be called once the request has finished.</p>
  1008. </div>
  1009. <div class="declaration">
  1010. <h4>Declaration</h4>
  1011. <div class="language">
  1012. <p class="aside-title">Swift</p>
  1013. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1014. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1015. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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>
  1016. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1017. </div>
  1018. </div>
  1019. <div>
  1020. <h4>Parameters</h4>
  1021. <table class="graybox">
  1022. <tbody>
  1023. <tr>
  1024. <td>
  1025. <code>
  1026. <em>queue</em>
  1027. </code>
  1028. </td>
  1029. <td>
  1030. <div>
  1031. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1032. </div>
  1033. </td>
  1034. </tr>
  1035. <tr>
  1036. <td>
  1037. <code>
  1038. <em>completionHandler</em>
  1039. </code>
  1040. </td>
  1041. <td>
  1042. <div>
  1043. <p>The code to be executed once the request has finished.</p>
  1044. </div>
  1045. </td>
  1046. </tr>
  1047. </tbody>
  1048. </table>
  1049. </div>
  1050. <div>
  1051. <h4>Return Value</h4>
  1052. <p>The request.</p>
  1053. </div>
  1054. </section>
  1055. </div>
  1056. </li>
  1057. <li class="item">
  1058. <div>
  1059. <code>
  1060. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  1061. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  1062. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  1063. </code>
  1064. </div>
  1065. <div class="height-container">
  1066. <div class="pointer-container"></div>
  1067. <section class="section">
  1068. <div class="pointer"></div>
  1069. <div class="abstract">
  1070. <p>Adds a handler to be called once the request has finished.</p>
  1071. </div>
  1072. <div class="declaration">
  1073. <h4>Declaration</h4>
  1074. <div class="language">
  1075. <p class="aside-title">Swift</p>
  1076. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1077. <span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o">&lt;</span><span class="kt">Serializer</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><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1078. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  1079. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Serializer</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>
  1080. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1081. </div>
  1082. </div>
  1083. <div>
  1084. <h4>Parameters</h4>
  1085. <table class="graybox">
  1086. <tbody>
  1087. <tr>
  1088. <td>
  1089. <code>
  1090. <em>queue</em>
  1091. </code>
  1092. </td>
  1093. <td>
  1094. <div>
  1095. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1096. </div>
  1097. </td>
  1098. </tr>
  1099. <tr>
  1100. <td>
  1101. <code>
  1102. <em>responseSerializer</em>
  1103. </code>
  1104. </td>
  1105. <td>
  1106. <div>
  1107. <p>The response serializer responsible for serializing the request, response, and data
  1108. contained in the destination <code>URL</code>.</p>
  1109. </div>
  1110. </td>
  1111. </tr>
  1112. <tr>
  1113. <td>
  1114. <code>
  1115. <em>completionHandler</em>
  1116. </code>
  1117. </td>
  1118. <td>
  1119. <div>
  1120. <p>The code to be executed once the request has finished.</p>
  1121. </div>
  1122. </td>
  1123. </tr>
  1124. </tbody>
  1125. </table>
  1126. </div>
  1127. <div>
  1128. <h4>Return Value</h4>
  1129. <p>The request.</p>
  1130. </div>
  1131. </section>
  1132. </div>
  1133. </li>
  1134. </ul>
  1135. </div>
  1136. <div class="task-group">
  1137. <div class="task-name-container">
  1138. <a name="/Data"></a>
  1139. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1140. <div class="section-name-container">
  1141. <a class="section-name-link" href="#/Data"></a>
  1142. <h3 class="section-name"><p>Data</p>
  1143. </h3>
  1144. </div>
  1145. </div>
  1146. <ul class="item-container">
  1147. <li class="item">
  1148. <div>
  1149. <code>
  1150. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF"></a>
  1151. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  1152. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF">responseData(queue:completionHandler:)</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>Adds a handler to be called once the request has finished.</p>
  1161. </div>
  1162. <div class="declaration">
  1163. <h4>Declaration</h4>
  1164. <div class="language">
  1165. <p class="aside-title">Swift</p>
  1166. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1167. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1168. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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>
  1169. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1170. </div>
  1171. </div>
  1172. <div>
  1173. <h4>Parameters</h4>
  1174. <table class="graybox">
  1175. <tbody>
  1176. <tr>
  1177. <td>
  1178. <code>
  1179. <em>queue</em>
  1180. </code>
  1181. </td>
  1182. <td>
  1183. <div>
  1184. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1185. </div>
  1186. </td>
  1187. </tr>
  1188. <tr>
  1189. <td>
  1190. <code>
  1191. <em>completionHandler</em>
  1192. </code>
  1193. </td>
  1194. <td>
  1195. <div>
  1196. <p>The code to be executed once the request has finished.</p>
  1197. </div>
  1198. </td>
  1199. </tr>
  1200. </tbody>
  1201. </table>
  1202. </div>
  1203. <div>
  1204. <h4>Return Value</h4>
  1205. <p>The request.</p>
  1206. </div>
  1207. </section>
  1208. </div>
  1209. </li>
  1210. </ul>
  1211. </div>
  1212. <div class="task-group">
  1213. <div class="task-name-container">
  1214. <a name="/String"></a>
  1215. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  1216. <div class="section-name-container">
  1217. <a class="section-name-link" href="#/String"></a>
  1218. <h3 class="section-name"><p>String</p>
  1219. </h3>
  1220. </div>
  1221. </div>
  1222. <ul class="item-container">
  1223. <li class="item">
  1224. <div>
  1225. <code>
  1226. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSAA7AFErrorOGctF"></a>
  1227. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  1228. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSAA7AFErrorOGctF">responseString(queue:encoding:completionHandler:)</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>Adds a handler to be called once the request has finished.</p>
  1237. </div>
  1238. <div class="declaration">
  1239. <h4>Declaration</h4>
  1240. <div class="language">
  1241. <p class="aside-title">Swift</p>
  1242. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1243. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1244. <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>
  1245. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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>
  1246. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1247. </div>
  1248. </div>
  1249. <div>
  1250. <h4>Parameters</h4>
  1251. <table class="graybox">
  1252. <tbody>
  1253. <tr>
  1254. <td>
  1255. <code>
  1256. <em>queue</em>
  1257. </code>
  1258. </td>
  1259. <td>
  1260. <div>
  1261. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1262. </div>
  1263. </td>
  1264. </tr>
  1265. <tr>
  1266. <td>
  1267. <code>
  1268. <em>encoding</em>
  1269. </code>
  1270. </td>
  1271. <td>
  1272. <div>
  1273. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined from
  1274. the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1275. </div>
  1276. </td>
  1277. </tr>
  1278. <tr>
  1279. <td>
  1280. <code>
  1281. <em>completionHandler</em>
  1282. </code>
  1283. </td>
  1284. <td>
  1285. <div>
  1286. <p>A closure to be executed once the request has finished.</p>
  1287. </div>
  1288. </td>
  1289. </tr>
  1290. </tbody>
  1291. </table>
  1292. </div>
  1293. <div>
  1294. <h4>Return Value</h4>
  1295. <p>The request.</p>
  1296. </div>
  1297. </section>
  1298. </div>
  1299. </li>
  1300. </ul>
  1301. </div>
  1302. <div class="task-group">
  1303. <div class="task-name-container">
  1304. <a name="/JSON"></a>
  1305. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1306. <div class="section-name-container">
  1307. <a class="section-name-link" href="#/JSON"></a>
  1308. <h3 class="section-name"><p>JSON</p>
  1309. </h3>
  1310. </div>
  1311. </div>
  1312. <ul class="item-container">
  1313. <li class="item">
  1314. <div>
  1315. <code>
  1316. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypAA7AFErrorOGctF"></a>
  1317. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1318. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypAA7AFErrorOGctF">responseJSON(queue:options:completionHandler:)</a>
  1319. </code>
  1320. </div>
  1321. <div class="height-container">
  1322. <div class="pointer-container"></div>
  1323. <section class="section">
  1324. <div class="pointer"></div>
  1325. <div class="abstract">
  1326. <p>Adds a handler to be called once the request has finished.</p>
  1327. </div>
  1328. <div class="declaration">
  1329. <h4>Declaration</h4>
  1330. <div class="language">
  1331. <p class="aside-title">Swift</p>
  1332. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1333. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1334. <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>
  1335. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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>
  1336. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1337. </div>
  1338. </div>
  1339. <div>
  1340. <h4>Parameters</h4>
  1341. <table class="graybox">
  1342. <tbody>
  1343. <tr>
  1344. <td>
  1345. <code>
  1346. <em>queue</em>
  1347. </code>
  1348. </td>
  1349. <td>
  1350. <div>
  1351. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1352. </div>
  1353. </td>
  1354. </tr>
  1355. <tr>
  1356. <td>
  1357. <code>
  1358. <em>options</em>
  1359. </code>
  1360. </td>
  1361. <td>
  1362. <div>
  1363. <p>The JSON serialization reading options. <code>.allowFragments</code> by default.</p>
  1364. </div>
  1365. </td>
  1366. </tr>
  1367. <tr>
  1368. <td>
  1369. <code>
  1370. <em>completionHandler</em>
  1371. </code>
  1372. </td>
  1373. <td>
  1374. <div>
  1375. <p>A closure to be executed once the request has finished.</p>
  1376. </div>
  1377. </td>
  1378. </tr>
  1379. </tbody>
  1380. </table>
  1381. </div>
  1382. <div>
  1383. <h4>Return Value</h4>
  1384. <p>The request.</p>
  1385. </div>
  1386. </section>
  1387. </div>
  1388. </li>
  1389. </ul>
  1390. </div>
  1391. <div class="task-group">
  1392. <div class="task-name-container">
  1393. <a name="/Decodable"></a>
  1394. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  1395. <div class="section-name-container">
  1396. <a class="section-name-link" href="#/Decodable"></a>
  1397. <h3 class="section-name"><p>Decodable</p>
  1398. </h3>
  1399. </div>
  1400. </div>
  1401. <ul class="item-container">
  1402. <li class="item">
  1403. <div>
  1404. <code>
  1405. <a name="/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue7decoder17completionHandlerACXDxm_So012OS_dispatch_G0CAA11DataDecoder_pyAA0B8ResponseVyxAA7AFErrorOGctSeRzlF"></a>
  1406. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:decoder:completionHandler:)" class="dashAnchor"></a>
  1407. <a class="token" href="#/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue7decoder17completionHandlerACXDxm_So012OS_dispatch_G0CAA11DataDecoder_pyAA0B8ResponseVyxAA7AFErrorOGctSeRzlF">responseDecodable(of:queue:decoder:completionHandler:)</a>
  1408. </code>
  1409. </div>
  1410. <div class="height-container">
  1411. <div class="pointer-container"></div>
  1412. <section class="section">
  1413. <div class="pointer"></div>
  1414. <div class="abstract">
  1415. <p>Adds a handler to be called once the request has finished.</p>
  1416. </div>
  1417. <div class="declaration">
  1418. <h4>Declaration</h4>
  1419. <div class="language">
  1420. <p class="aside-title">Swift</p>
  1421. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1422. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">of</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1423. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1424. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  1425. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1426. </div>
  1427. </div>
  1428. <div>
  1429. <h4>Parameters</h4>
  1430. <table class="graybox">
  1431. <tbody>
  1432. <tr>
  1433. <td>
  1434. <code>
  1435. <em>type</em>
  1436. </code>
  1437. </td>
  1438. <td>
  1439. <div>
  1440. <p><code>Decodable</code> type to decode from response data.</p>
  1441. </div>
  1442. </td>
  1443. </tr>
  1444. <tr>
  1445. <td>
  1446. <code>
  1447. <em>queue</em>
  1448. </code>
  1449. </td>
  1450. <td>
  1451. <div>
  1452. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1453. </div>
  1454. </td>
  1455. </tr>
  1456. <tr>
  1457. <td>
  1458. <code>
  1459. <em>decoder</em>
  1460. </code>
  1461. </td>
  1462. <td>
  1463. <div>
  1464. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  1465. </div>
  1466. </td>
  1467. </tr>
  1468. <tr>
  1469. <td>
  1470. <code>
  1471. <em>completionHandler</em>
  1472. </code>
  1473. </td>
  1474. <td>
  1475. <div>
  1476. <p>A closure to be executed once the request has finished.</p>
  1477. </div>
  1478. </td>
  1479. </tr>
  1480. </tbody>
  1481. </table>
  1482. </div>
  1483. <div>
  1484. <h4>Return Value</h4>
  1485. <p>The request.</p>
  1486. </div>
  1487. </section>
  1488. </div>
  1489. </li>
  1490. </ul>
  1491. </div>
  1492. <div class="task-group">
  1493. <ul class="item-container">
  1494. <li class="item">
  1495. <div>
  1496. <code>
  1497. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1498. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1499. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1500. </code>
  1501. </div>
  1502. <div class="height-container">
  1503. <div class="pointer-container"></div>
  1504. <section class="section">
  1505. <div class="pointer"></div>
  1506. <div class="abstract">
  1507. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1508. destination URL, and returns whether the request was valid.</p>
  1509. </div>
  1510. <div class="declaration">
  1511. <h4>Declaration</h4>
  1512. <div class="language">
  1513. <p class="aside-title">Swift</p>
  1514. <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>
  1515. </div>
  1516. </div>
  1517. </section>
  1518. </div>
  1519. </li>
  1520. <li class="item">
  1521. <div>
  1522. <code>
  1523. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1524. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1525. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1526. </code>
  1527. </div>
  1528. <div class="height-container">
  1529. <div class="pointer-container"></div>
  1530. <section class="section">
  1531. <div class="pointer"></div>
  1532. <div class="abstract">
  1533. <p>Validates that the response has a status code in the specified sequence.</p>
  1534. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1535. </div>
  1536. <div class="declaration">
  1537. <h4>Declaration</h4>
  1538. <div class="language">
  1539. <p class="aside-title">Swift</p>
  1540. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1541. <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>
  1542. </div>
  1543. </div>
  1544. <div>
  1545. <h4>Parameters</h4>
  1546. <table class="graybox">
  1547. <tbody>
  1548. <tr>
  1549. <td>
  1550. <code>
  1551. <em>range</em>
  1552. </code>
  1553. </td>
  1554. <td>
  1555. <div>
  1556. <p>The range of acceptable status codes.</p>
  1557. </div>
  1558. </td>
  1559. </tr>
  1560. </tbody>
  1561. </table>
  1562. </div>
  1563. <div>
  1564. <h4>Return Value</h4>
  1565. <p>The request.</p>
  1566. </div>
  1567. </section>
  1568. </div>
  1569. </li>
  1570. <li class="item">
  1571. <div>
  1572. <code>
  1573. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1574. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1575. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1576. </code>
  1577. </div>
  1578. <div class="height-container">
  1579. <div class="pointer-container"></div>
  1580. <section class="section">
  1581. <div class="pointer"></div>
  1582. <div class="abstract">
  1583. <p>Validates that the response has a content type in the specified sequence.</p>
  1584. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1585. </div>
  1586. <div class="declaration">
  1587. <h4>Declaration</h4>
  1588. <div class="language">
  1589. <p class="aside-title">Swift</p>
  1590. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1591. <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">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="kd">@escaping</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="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">String</span></code></pre>
  1592. </div>
  1593. </div>
  1594. <div>
  1595. <h4>Parameters</h4>
  1596. <table class="graybox">
  1597. <tbody>
  1598. <tr>
  1599. <td>
  1600. <code>
  1601. <em>contentType</em>
  1602. </code>
  1603. </td>
  1604. <td>
  1605. <div>
  1606. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1607. </div>
  1608. </td>
  1609. </tr>
  1610. </tbody>
  1611. </table>
  1612. </div>
  1613. <div>
  1614. <h4>Return Value</h4>
  1615. <p>The request.</p>
  1616. </div>
  1617. </section>
  1618. </div>
  1619. </li>
  1620. <li class="item">
  1621. <div>
  1622. <code>
  1623. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1624. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1625. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1626. </code>
  1627. </div>
  1628. <div class="height-container">
  1629. <div class="pointer-container"></div>
  1630. <section class="section">
  1631. <div class="pointer"></div>
  1632. <div class="abstract">
  1633. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1634. type matches any specified in the Accept HTTP header field.</p>
  1635. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1636. </div>
  1637. <div class="declaration">
  1638. <h4>Declaration</h4>
  1639. <div class="language">
  1640. <p class="aside-title">Swift</p>
  1641. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1642. <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>
  1643. </div>
  1644. </div>
  1645. <div>
  1646. <h4>Return Value</h4>
  1647. <p>The request.</p>
  1648. </div>
  1649. </section>
  1650. </div>
  1651. </li>
  1652. </ul>
  1653. </div>
  1654. </div>
  1655. </section>
  1656. </article>
  1657. </div>
  1658. <section class="footer">
  1659. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-03-23)</p>
  1660. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1661. </section>
  1662. </body>
  1663. </div>
  1664. </html>