DownloadRequest.html 96 KB

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