DownloadRequest.html 87 KB

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