DownloadRequest.html 85 KB

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