DownloadRequest.html 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605
  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. (86% 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/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>DownloadRequest</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span> <span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
  304. </div>
  305. </div>
  306. <p>Specific type of <code><a href="../Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDownloadTask</code>.</p>
  307. </div>
  308. </section>
  309. <section class="section">
  310. <div class="section-content">
  311. <div class="task-group">
  312. <div class="task-name-container">
  313. <a name="/Helper%20Types"></a>
  314. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  315. <a href="#/Helper%20Types">
  316. <h3 class="section-name">Helper Types</h3>
  317. </a>
  318. </div>
  319. <ul class="item-container">
  320. <li class="item">
  321. <div>
  322. <code>
  323. <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV"></a>
  324. <a name="//apple_ref/swift/Struct/DownloadOptions" class="dashAnchor"></a>
  325. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV">DownloadOptions</a>
  326. </code>
  327. </div>
  328. <div class="height-container">
  329. <div class="pointer-container"></div>
  330. <section class="section">
  331. <div class="pointer"></div>
  332. <div class="abstract">
  333. <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
  334. destination URL.</p>
  335. <a href="../Classes/DownloadRequest/DownloadOptions.html" class="slightly-smaller">See more</a>
  336. </div>
  337. <div class="declaration">
  338. <h4>Declaration</h4>
  339. <div class="language">
  340. <p class="aside-title">Swift</p>
  341. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadOptions</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>
  342. </div>
  343. </div>
  344. </section>
  345. </div>
  346. </li>
  347. <li class="item">
  348. <div>
  349. <code>
  350. <a name="/s:9Alamofire15DownloadRequestC0B15FileDestinationa"></a>
  351. <a name="//apple_ref/swift/Alias/DownloadFileDestination" class="dashAnchor"></a>
  352. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a>
  353. </code>
  354. </div>
  355. <div class="height-container">
  356. <div class="pointer-container"></div>
  357. <section class="section">
  358. <div class="pointer"></div>
  359. <div class="abstract">
  360. <p>A closure executed once a download request has successfully completed in order to determine where to move the
  361. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  362. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  363. the options defining how the file should be moved.</p>
  364. </div>
  365. <div class="declaration">
  366. <h4>Declaration</h4>
  367. <div class="language">
  368. <p class="aside-title">Swift</p>
  369. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">DownloadFileDestination</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/DownloadOptions.html">DownloadOptions</a></span><span class="p">)</span></code></pre>
  370. </div>
  371. </div>
  372. </section>
  373. </div>
  374. </li>
  375. </ul>
  376. </div>
  377. <div class="task-group">
  378. <div class="task-name-container">
  379. <a name="/Properties"></a>
  380. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  381. <a href="#/Properties">
  382. <h3 class="section-name">Properties</h3>
  383. </a>
  384. </div>
  385. <ul class="item-container">
  386. <li class="item">
  387. <div>
  388. <code>
  389. <a name="/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp"></a>
  390. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  391. <a class="token" href="#/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp">request</a>
  392. </code>
  393. </div>
  394. <div class="height-container">
  395. <div class="pointer-container"></div>
  396. <section class="section">
  397. <div class="pointer"></div>
  398. <div class="abstract">
  399. <p>The request sent or to be sent to the server.</p>
  400. </div>
  401. <div class="declaration">
  402. <h4>Declaration</h4>
  403. <div class="language">
  404. <p class="aside-title">Swift</p>
  405. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  406. </div>
  407. </div>
  408. </section>
  409. </div>
  410. </li>
  411. <li class="item">
  412. <div>
  413. <code>
  414. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  415. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  416. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  417. </code>
  418. </div>
  419. <div class="height-container">
  420. <div class="pointer-container"></div>
  421. <section class="section">
  422. <div class="pointer"></div>
  423. <div class="abstract">
  424. <p>The resume data of the underlying download task if available after a failure.</p>
  425. </div>
  426. <div class="declaration">
  427. <h4>Declaration</h4>
  428. <div class="language">
  429. <p class="aside-title">Swift</p>
  430. <pre class="highlight swift"><code><span class="kd">open</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>
  431. </div>
  432. </div>
  433. </section>
  434. </div>
  435. </li>
  436. <li class="item">
  437. <div>
  438. <code>
  439. <a name="/s:9Alamofire15DownloadRequestC8progressSo10NSProgressCvp"></a>
  440. <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
  441. <a class="token" href="#/s:9Alamofire15DownloadRequestC8progressSo10NSProgressCvp">progress</a>
  442. </code>
  443. </div>
  444. <div class="height-container">
  445. <div class="pointer-container"></div>
  446. <section class="section">
  447. <div class="pointer"></div>
  448. <div class="abstract">
  449. <p>The progress of downloading the response data from the server for the request.</p>
  450. </div>
  451. <div class="declaration">
  452. <h4>Declaration</h4>
  453. <div class="language">
  454. <p class="aside-title">Swift</p>
  455. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">Progress</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  456. </div>
  457. </div>
  458. </section>
  459. </div>
  460. </li>
  461. </ul>
  462. </div>
  463. <div class="task-group">
  464. <div class="task-name-container">
  465. <a name="/State"></a>
  466. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  467. <a href="#/State">
  468. <h3 class="section-name">State</h3>
  469. </a>
  470. </div>
  471. <ul class="item-container">
  472. <li class="item">
  473. <div>
  474. <code>
  475. <a name="/s:9Alamofire15DownloadRequestC6cancelyyF"></a>
  476. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  477. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelyyF">cancel()</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>Cancels the request.</p>
  486. </div>
  487. <div class="declaration">
  488. <h4>Declaration</h4>
  489. <div class="language">
  490. <p class="aside-title">Swift</p>
  491. <pre class="highlight swift"><code><span class="k">override</span> <span class="kd">open</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
  492. </div>
  493. </div>
  494. </section>
  495. </div>
  496. </li>
  497. <li class="item">
  498. <div>
  499. <code>
  500. <a name="/s:9Alamofire15DownloadRequestC6cancel16createResumeDataySb_tF"></a>
  501. <a name="//apple_ref/swift/Method/cancel(createResumeData:)" class="dashAnchor"></a>
  502. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel16createResumeDataySb_tF">cancel(createResumeData:)</a>
  503. </code>
  504. </div>
  505. <div class="height-container">
  506. <div class="pointer-container"></div>
  507. <section class="section">
  508. <div class="pointer"></div>
  509. <div class="abstract">
  510. <p>Cancels the request.</p>
  511. </div>
  512. <div class="declaration">
  513. <h4>Declaration</h4>
  514. <div class="language">
  515. <p class="aside-title">Swift</p>
  516. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="nv">createResumeData</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
  517. </div>
  518. </div>
  519. <div>
  520. <h4>Parameters</h4>
  521. <table class="graybox">
  522. <tbody>
  523. <tr>
  524. <td>
  525. <code>
  526. <em>createResumeData</em>
  527. </code>
  528. </td>
  529. <td>
  530. <div>
  531. <p>Determines whether resume data is created via the underlying download task or not.</p>
  532. </div>
  533. </td>
  534. </tr>
  535. </tbody>
  536. </table>
  537. </div>
  538. </section>
  539. </div>
  540. </li>
  541. </ul>
  542. </div>
  543. <div class="task-group">
  544. <div class="task-name-container">
  545. <a name="/Progress"></a>
  546. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  547. <a href="#/Progress">
  548. <h3 class="section-name">Progress</h3>
  549. </a>
  550. </div>
  551. <ul class="item-container">
  552. <li class="item">
  553. <div>
  554. <code>
  555. <a name="/s:9Alamofire15DownloadRequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_F0C_ySo10NSProgressCctF"></a>
  556. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  557. <a class="token" href="#/s:9Alamofire15DownloadRequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_F0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  558. </code>
  559. </div>
  560. <div class="height-container">
  561. <div class="pointer-container"></div>
  562. <section class="section">
  563. <div class="pointer"></div>
  564. <div class="abstract">
  565. <p>Sets a closure to be called periodically during the lifecycle of the <code><a href="../Classes/Request.html">Request</a></code> as data is read from the server.</p>
  566. </div>
  567. <div class="declaration">
  568. <h4>Declaration</h4>
  569. <div class="language">
  570. <p class="aside-title">Swift</p>
  571. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  572. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">downloadProgress</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="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">ProgressHandler</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  573. </div>
  574. </div>
  575. <div>
  576. <h4>Parameters</h4>
  577. <table class="graybox">
  578. <tbody>
  579. <tr>
  580. <td>
  581. <code>
  582. <em>queue</em>
  583. </code>
  584. </td>
  585. <td>
  586. <div>
  587. <p>The dispatch queue to execute the closure on.</p>
  588. </div>
  589. </td>
  590. </tr>
  591. <tr>
  592. <td>
  593. <code>
  594. <em>closure</em>
  595. </code>
  596. </td>
  597. <td>
  598. <div>
  599. <p>The code to be executed periodically as data is read from the server.</p>
  600. </div>
  601. </td>
  602. </tr>
  603. </tbody>
  604. </table>
  605. </div>
  606. <div>
  607. <h4>Return Value</h4>
  608. <p>The request.</p>
  609. </div>
  610. </section>
  611. </div>
  612. </li>
  613. </ul>
  614. </div>
  615. <div class="task-group">
  616. <div class="task-name-container">
  617. <a name="/Destination"></a>
  618. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  619. <a href="#/Destination">
  620. <h3 class="section-name">Destination</h3>
  621. </a>
  622. </div>
  623. <ul class="item-container">
  624. <li class="item">
  625. <div>
  626. <code>
  627. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in10Foundation3URLV011destinationI0_AC0B7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVtFZ"></a>
  628. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:)" class="dashAnchor"></a>
  629. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in10Foundation3URLV011destinationI0_AC0B7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVtFZ">suggestedDownloadDestination(for:in:)</a>
  630. </code>
  631. </div>
  632. <div class="height-container">
  633. <div class="pointer-container"></div>
  634. <section class="section">
  635. <div class="pointer"></div>
  636. <div class="abstract">
  637. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  638. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  639. </div>
  640. <div class="declaration">
  641. <h4>Declaration</h4>
  642. <div class="language">
  643. <p class="aside-title">Swift</p>
  644. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">suggestedDownloadDestination</span><span class="p">(</span>
  645. <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>
  646. <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>
  647. <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a></span></code></pre>
  648. </div>
  649. </div>
  650. <div>
  651. <h4>Parameters</h4>
  652. <table class="graybox">
  653. <tbody>
  654. <tr>
  655. <td>
  656. <code>
  657. <em>directory</em>
  658. </code>
  659. </td>
  660. <td>
  661. <div>
  662. <p>The search path directory. <code>.DocumentDirectory</code> by default.</p>
  663. </div>
  664. </td>
  665. </tr>
  666. <tr>
  667. <td>
  668. <code>
  669. <em>domain</em>
  670. </code>
  671. </td>
  672. <td>
  673. <div>
  674. <p>The search path domain mask. <code>.UserDomainMask</code> by default.</p>
  675. </div>
  676. </td>
  677. </tr>
  678. </tbody>
  679. </table>
  680. </div>
  681. <div>
  682. <h4>Return Value</h4>
  683. <p>A download file destination closure.</p>
  684. </div>
  685. </section>
  686. </div>
  687. </li>
  688. </ul>
  689. </div>
  690. <div class="task-group">
  691. <div class="task-name-container">
  692. <a name="/Default"></a>
  693. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  694. <a href="#/Default">
  695. <h3 class="section-name">Default</h3>
  696. </a>
  697. </div>
  698. <ul class="item-container">
  699. <li class="item">
  700. <div>
  701. <code>
  702. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA07DefaultB8ResponseVctF"></a>
  703. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  704. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA07DefaultB8ResponseVctF">response(queue:completionHandler:)</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>Adds a handler to be called once the request has finished.</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">@discardableResult</span>
  719. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
  720. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  721. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  722. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  723. </div>
  724. </div>
  725. <div>
  726. <h4>Parameters</h4>
  727. <table class="graybox">
  728. <tbody>
  729. <tr>
  730. <td>
  731. <code>
  732. <em>queue</em>
  733. </code>
  734. </td>
  735. <td>
  736. <div>
  737. <p>The queue on which the completion handler is dispatched.</p>
  738. </div>
  739. </td>
  740. </tr>
  741. <tr>
  742. <td>
  743. <code>
  744. <em>completionHandler</em>
  745. </code>
  746. </td>
  747. <td>
  748. <div>
  749. <p>The code to be executed once the request has finished.</p>
  750. </div>
  751. </td>
  752. </tr>
  753. </tbody>
  754. </table>
  755. </div>
  756. <div>
  757. <h4>Return Value</h4>
  758. <p>The request.</p>
  759. </div>
  760. </section>
  761. </div>
  762. </li>
  763. <li class="item">
  764. <div>
  765. <code>
  766. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF"></a>
  767. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  768. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  769. </code>
  770. </div>
  771. <div class="height-container">
  772. <div class="pointer-container"></div>
  773. <section class="section">
  774. <div class="pointer"></div>
  775. <div class="abstract">
  776. <p>Adds a handler to be called once the request has finished.</p>
  777. </div>
  778. <div class="declaration">
  779. <h4>Declaration</h4>
  780. <div class="language">
  781. <p class="aside-title">Swift</p>
  782. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  783. <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>
  784. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  785. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
  786. <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>
  787. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  788. </div>
  789. </div>
  790. <div>
  791. <h4>Parameters</h4>
  792. <table class="graybox">
  793. <tbody>
  794. <tr>
  795. <td>
  796. <code>
  797. <em>queue</em>
  798. </code>
  799. </td>
  800. <td>
  801. <div>
  802. <p>The queue on which the completion handler is dispatched.</p>
  803. </div>
  804. </td>
  805. </tr>
  806. <tr>
  807. <td>
  808. <code>
  809. <em>responseSerializer</em>
  810. </code>
  811. </td>
  812. <td>
  813. <div>
  814. <p>The response serializer responsible for serializing the request, response,
  815. and data contained in the destination url.</p>
  816. </div>
  817. </td>
  818. </tr>
  819. <tr>
  820. <td>
  821. <code>
  822. <em>completionHandler</em>
  823. </code>
  824. </td>
  825. <td>
  826. <div>
  827. <p>The code to be executed once the request has finished.</p>
  828. </div>
  829. </td>
  830. </tr>
  831. </tbody>
  832. </table>
  833. </div>
  834. <div>
  835. <h4>Return Value</h4>
  836. <p>The request.</p>
  837. </div>
  838. </section>
  839. </div>
  840. </li>
  841. </ul>
  842. </div>
  843. <div class="task-group">
  844. <div class="task-name-container">
  845. <a name="/Data"></a>
  846. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  847. <a href="#/Data">
  848. <h3 class="section-name">Data</h3>
  849. </a>
  850. </div>
  851. <ul class="item-container">
  852. <li class="item">
  853. <div>
  854. <code>
  855. <a name="/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ"></a>
  856. <a name="//apple_ref/swift/Method/dataResponseSerializer()" class="dashAnchor"></a>
  857. <a class="token" href="#/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ">dataResponseSerializer()</a>
  858. </code>
  859. </div>
  860. <div class="height-container">
  861. <div class="pointer-container"></div>
  862. <section class="section">
  863. <div class="pointer"></div>
  864. <div class="abstract">
  865. <p>Creates a response serializer that returns the associated data as-is.</p>
  866. </div>
  867. <div class="declaration">
  868. <h4>Declaration</h4>
  869. <div class="language">
  870. <p class="aside-title">Swift</p>
  871. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">dataResponseSerializer</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  872. </div>
  873. </div>
  874. <div>
  875. <h4>Return Value</h4>
  876. <p>A data response serializer.</p>
  877. </div>
  878. </section>
  879. </div>
  880. </li>
  881. <li class="item">
  882. <div>
  883. <code>
  884. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF"></a>
  885. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  886. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF">responseData(queue:completionHandler:)</a>
  887. </code>
  888. </div>
  889. <div class="height-container">
  890. <div class="pointer-container"></div>
  891. <section class="section">
  892. <div class="pointer"></div>
  893. <div class="abstract">
  894. <p>Adds a handler to be called once the request has finished.</p>
  895. </div>
  896. <div class="declaration">
  897. <h4>Declaration</h4>
  898. <div class="language">
  899. <p class="aside-title">Swift</p>
  900. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  901. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
  902. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  903. <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>
  904. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  905. </div>
  906. </div>
  907. <div>
  908. <h4>Parameters</h4>
  909. <table class="graybox">
  910. <tbody>
  911. <tr>
  912. <td>
  913. <code>
  914. <em>completionHandler</em>
  915. </code>
  916. </td>
  917. <td>
  918. <div>
  919. <p>The code to be executed once the request has finished.</p>
  920. </div>
  921. </td>
  922. </tr>
  923. </tbody>
  924. </table>
  925. </div>
  926. <div>
  927. <h4>Return Value</h4>
  928. <p>The request.</p>
  929. </div>
  930. </section>
  931. </div>
  932. </li>
  933. </ul>
  934. </div>
  935. <div class="task-group">
  936. <div class="task-name-container">
  937. <a name="/String"></a>
  938. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  939. <a href="#/String">
  940. <h3 class="section-name">String</h3>
  941. </a>
  942. </div>
  943. <ul class="item-container">
  944. <li class="item">
  945. <div>
  946. <code>
  947. <a name="/s:9Alamofire15DownloadRequestC24stringResponseSerializer8encodingAA0beF0VySSGSS10FoundationE8EncodingVSg_tFZ"></a>
  948. <a name="//apple_ref/swift/Method/stringResponseSerializer(encoding:)" class="dashAnchor"></a>
  949. <a class="token" href="#/s:9Alamofire15DownloadRequestC24stringResponseSerializer8encodingAA0beF0VySSGSS10FoundationE8EncodingVSg_tFZ">stringResponseSerializer(encoding:)</a>
  950. </code>
  951. </div>
  952. <div class="height-container">
  953. <div class="pointer-container"></div>
  954. <section class="section">
  955. <div class="pointer"></div>
  956. <div class="abstract">
  957. <p>Creates a response serializer that returns a result string type initialized from the response data with
  958. the specified string encoding.</p>
  959. </div>
  960. <div class="declaration">
  961. <h4>Declaration</h4>
  962. <div class="language">
  963. <p class="aside-title">Swift</p>
  964. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">stringResponseSerializer</span><span class="p">(</span><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> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  965. </div>
  966. </div>
  967. <div>
  968. <h4>Parameters</h4>
  969. <table class="graybox">
  970. <tbody>
  971. <tr>
  972. <td>
  973. <code>
  974. <em>encoding</em>
  975. </code>
  976. </td>
  977. <td>
  978. <div>
  979. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server
  980. response, falling back to the default HTTP default character set, ISO-8859-1.</p>
  981. </div>
  982. </td>
  983. </tr>
  984. </tbody>
  985. </table>
  986. </div>
  987. <div>
  988. <h4>Return Value</h4>
  989. <p>A string response serializer.</p>
  990. </div>
  991. </section>
  992. </div>
  993. </li>
  994. <li class="item">
  995. <div>
  996. <code>
  997. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF"></a>
  998. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  999. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF">responseString(queue:encoding:completionHandler:)</a>
  1000. </code>
  1001. </div>
  1002. <div class="height-container">
  1003. <div class="pointer-container"></div>
  1004. <section class="section">
  1005. <div class="pointer"></div>
  1006. <div class="abstract">
  1007. <p>Adds a handler to be called once the request has finished.</p>
  1008. </div>
  1009. <div class="declaration">
  1010. <h4>Declaration</h4>
  1011. <div class="language">
  1012. <p class="aside-title">Swift</p>
  1013. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1014. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
  1015. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1016. <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>
  1017. <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>
  1018. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1019. </div>
  1020. </div>
  1021. <div>
  1022. <h4>Parameters</h4>
  1023. <table class="graybox">
  1024. <tbody>
  1025. <tr>
  1026. <td>
  1027. <code>
  1028. <em>encoding</em>
  1029. </code>
  1030. </td>
  1031. <td>
  1032. <div>
  1033. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the
  1034. server response, falling back to the default HTTP default character set,
  1035. ISO-8859-1.</p>
  1036. </div>
  1037. </td>
  1038. </tr>
  1039. <tr>
  1040. <td>
  1041. <code>
  1042. <em>completionHandler</em>
  1043. </code>
  1044. </td>
  1045. <td>
  1046. <div>
  1047. <p>A closure to be executed once the request has finished.</p>
  1048. </div>
  1049. </td>
  1050. </tr>
  1051. </tbody>
  1052. </table>
  1053. </div>
  1054. <div>
  1055. <h4>Return Value</h4>
  1056. <p>The request.</p>
  1057. </div>
  1058. </section>
  1059. </div>
  1060. </li>
  1061. </ul>
  1062. </div>
  1063. <div class="task-group">
  1064. <div class="task-name-container">
  1065. <a name="/JSON"></a>
  1066. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1067. <a href="#/JSON">
  1068. <h3 class="section-name">JSON</h3>
  1069. </a>
  1070. </div>
  1071. <ul class="item-container">
  1072. <li class="item">
  1073. <div>
  1074. <code>
  1075. <a name="/s:9Alamofire15DownloadRequestC22jsonResponseSerializer7optionsAA0beF0VyypGSo20NSJSONReadingOptionsV_tFZ"></a>
  1076. <a name="//apple_ref/swift/Method/jsonResponseSerializer(options:)" class="dashAnchor"></a>
  1077. <a class="token" href="#/s:9Alamofire15DownloadRequestC22jsonResponseSerializer7optionsAA0beF0VyypGSo20NSJSONReadingOptionsV_tFZ">jsonResponseSerializer(options:)</a>
  1078. </code>
  1079. </div>
  1080. <div class="height-container">
  1081. <div class="pointer-container"></div>
  1082. <section class="section">
  1083. <div class="pointer"></div>
  1084. <div class="abstract">
  1085. <p>Creates a response serializer that returns a JSON object result type constructed from the response data using
  1086. <code>JSONSerialization</code> with the specified reading options.</p>
  1087. </div>
  1088. <div class="declaration">
  1089. <h4>Declaration</h4>
  1090. <div class="language">
  1091. <p class="aside-title">Swift</p>
  1092. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">jsonResponseSerializer</span><span class="p">(</span>
  1093. <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>
  1094. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1095. </div>
  1096. </div>
  1097. <div>
  1098. <h4>Parameters</h4>
  1099. <table class="graybox">
  1100. <tbody>
  1101. <tr>
  1102. <td>
  1103. <code>
  1104. <em>options</em>
  1105. </code>
  1106. </td>
  1107. <td>
  1108. <div>
  1109. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1110. </div>
  1111. </td>
  1112. </tr>
  1113. </tbody>
  1114. </table>
  1115. </div>
  1116. <div>
  1117. <h4>Return Value</h4>
  1118. <p>A JSON object response serializer.</p>
  1119. </div>
  1120. </section>
  1121. </div>
  1122. </li>
  1123. <li class="item">
  1124. <div>
  1125. <code>
  1126. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF"></a>
  1127. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1128. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF">responseJSON(queue:options:completionHandler:)</a>
  1129. </code>
  1130. </div>
  1131. <div class="height-container">
  1132. <div class="pointer-container"></div>
  1133. <section class="section">
  1134. <div class="pointer"></div>
  1135. <div class="abstract">
  1136. <p>Adds a handler to be called once the request has finished.</p>
  1137. </div>
  1138. <div class="declaration">
  1139. <h4>Declaration</h4>
  1140. <div class="language">
  1141. <p class="aside-title">Swift</p>
  1142. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1143. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
  1144. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1145. <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>
  1146. <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>
  1147. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1148. </div>
  1149. </div>
  1150. <div>
  1151. <h4>Parameters</h4>
  1152. <table class="graybox">
  1153. <tbody>
  1154. <tr>
  1155. <td>
  1156. <code>
  1157. <em>options</em>
  1158. </code>
  1159. </td>
  1160. <td>
  1161. <div>
  1162. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1163. </div>
  1164. </td>
  1165. </tr>
  1166. <tr>
  1167. <td>
  1168. <code>
  1169. <em>completionHandler</em>
  1170. </code>
  1171. </td>
  1172. <td>
  1173. <div>
  1174. <p>A closure to be executed once the request has finished.</p>
  1175. </div>
  1176. </td>
  1177. </tr>
  1178. </tbody>
  1179. </table>
  1180. </div>
  1181. <div>
  1182. <h4>Return Value</h4>
  1183. <p>The request.</p>
  1184. </div>
  1185. </section>
  1186. </div>
  1187. </li>
  1188. </ul>
  1189. </div>
  1190. <div class="task-group">
  1191. <div class="task-name-container">
  1192. <a name="/Property%20List"></a>
  1193. <a name="//apple_ref/swift/Section/Property List" class="dashAnchor"></a>
  1194. <a href="#/Property%20List">
  1195. <h3 class="section-name">Property List</h3>
  1196. </a>
  1197. </div>
  1198. <ul class="item-container">
  1199. <li class="item">
  1200. <div>
  1201. <code>
  1202. <a name="/s:9Alamofire15DownloadRequestC30propertyListResponseSerializer7optionsAA0bfG0VyypGSo010NSPropertyE17MutabilityOptionsV_tFZ"></a>
  1203. <a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
  1204. <a class="token" href="#/s:9Alamofire15DownloadRequestC30propertyListResponseSerializer7optionsAA0bfG0VyypGSo010NSPropertyE17MutabilityOptionsV_tFZ">propertyListResponseSerializer(options:)</a>
  1205. </code>
  1206. </div>
  1207. <div class="height-container">
  1208. <div class="pointer-container"></div>
  1209. <section class="section">
  1210. <div class="pointer"></div>
  1211. <div class="abstract">
  1212. <p>Creates a response serializer that returns an object constructed from the response data using
  1213. <code>PropertyListSerialization</code> with the specified reading options.</p>
  1214. </div>
  1215. <div class="declaration">
  1216. <h4>Declaration</h4>
  1217. <div class="language">
  1218. <p class="aside-title">Swift</p>
  1219. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">propertyListResponseSerializer</span><span class="p">(</span>
  1220. <span class="nv">options</span><span class="p">:</span> <span class="kt">PropertyListSerialization</span><span class="o">.</span><span class="kt">ReadOptions</span> <span class="o">=</span> <span class="p">[])</span>
  1221. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1222. </div>
  1223. </div>
  1224. <div>
  1225. <h4>Parameters</h4>
  1226. <table class="graybox">
  1227. <tbody>
  1228. <tr>
  1229. <td>
  1230. <code>
  1231. <em>options</em>
  1232. </code>
  1233. </td>
  1234. <td>
  1235. <div>
  1236. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1237. </div>
  1238. </td>
  1239. </tr>
  1240. </tbody>
  1241. </table>
  1242. </div>
  1243. <div>
  1244. <h4>Return Value</h4>
  1245. <p>A property list object response serializer.</p>
  1246. </div>
  1247. </section>
  1248. </div>
  1249. </li>
  1250. <li class="item">
  1251. <div>
  1252. <code>
  1253. <a name="/s:9Alamofire15DownloadRequestC20responsePropertyList5queue7options17completionHandlerACXDSo012OS_dispatch_G0CSg_So010NSPropertyF17MutabilityOptionsVyAA0B8ResponseVyypGctF"></a>
  1254. <a name="//apple_ref/swift/Method/responsePropertyList(queue:options:completionHandler:)" class="dashAnchor"></a>
  1255. <a class="token" href="#/s:9Alamofire15DownloadRequestC20responsePropertyList5queue7options17completionHandlerACXDSo012OS_dispatch_G0CSg_So010NSPropertyF17MutabilityOptionsVyAA0B8ResponseVyypGctF">responsePropertyList(queue:options:completionHandler:)</a>
  1256. </code>
  1257. </div>
  1258. <div class="height-container">
  1259. <div class="pointer-container"></div>
  1260. <section class="section">
  1261. <div class="pointer"></div>
  1262. <div class="abstract">
  1263. <p>Adds a handler to be called once the request has finished.</p>
  1264. </div>
  1265. <div class="declaration">
  1266. <h4>Declaration</h4>
  1267. <div class="language">
  1268. <p class="aside-title">Swift</p>
  1269. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1270. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span>
  1271. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1272. <span class="nv">options</span><span class="p">:</span> <span class="kt">PropertyListSerialization</span><span class="o">.</span><span class="kt">ReadOptions</span> <span class="o">=</span> <span class="p">[],</span>
  1273. <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>
  1274. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1275. </div>
  1276. </div>
  1277. <div>
  1278. <h4>Parameters</h4>
  1279. <table class="graybox">
  1280. <tbody>
  1281. <tr>
  1282. <td>
  1283. <code>
  1284. <em>options</em>
  1285. </code>
  1286. </td>
  1287. <td>
  1288. <div>
  1289. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1290. </div>
  1291. </td>
  1292. </tr>
  1293. <tr>
  1294. <td>
  1295. <code>
  1296. <em>completionHandler</em>
  1297. </code>
  1298. </td>
  1299. <td>
  1300. <div>
  1301. <p>A closure to be executed once the request has finished.</p>
  1302. </div>
  1303. </td>
  1304. </tr>
  1305. </tbody>
  1306. </table>
  1307. </div>
  1308. <div>
  1309. <h4>Return Value</h4>
  1310. <p>The request.</p>
  1311. </div>
  1312. </section>
  1313. </div>
  1314. </li>
  1315. </ul>
  1316. </div>
  1317. <div class="task-group">
  1318. <ul class="item-container">
  1319. <li class="item">
  1320. <div>
  1321. <code>
  1322. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1323. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1324. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1325. </code>
  1326. </div>
  1327. <div class="height-container">
  1328. <div class="pointer-container"></div>
  1329. <section class="section">
  1330. <div class="pointer"></div>
  1331. <div class="abstract">
  1332. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1333. destination URL, and returns whether the request was valid.</p>
  1334. </div>
  1335. <div class="declaration">
  1336. <h4>Declaration</h4>
  1337. <div class="language">
  1338. <p class="aside-title">Swift</p>
  1339. <pre class="highlight swift"><code><span class="kd">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">temporaryURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?,</span> <span class="n">_</span> <span class="nv">destinationURL</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>
  1340. </div>
  1341. </div>
  1342. </section>
  1343. </div>
  1344. </li>
  1345. <li class="item">
  1346. <div>
  1347. <code>
  1348. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgAQtcF"></a>
  1349. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1350. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgAQtcF">validate(_:)</a>
  1351. </code>
  1352. </div>
  1353. <div class="height-container">
  1354. <div class="pointer-container"></div>
  1355. <section class="section">
  1356. <div class="pointer"></div>
  1357. <div class="abstract">
  1358. <p>Validates the request, using the specified closure.</p>
  1359. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1360. </div>
  1361. <div class="declaration">
  1362. <h4>Declaration</h4>
  1363. <div class="language">
  1364. <p class="aside-title">Swift</p>
  1365. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1366. <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>
  1367. </div>
  1368. </div>
  1369. <div>
  1370. <h4>Parameters</h4>
  1371. <table class="graybox">
  1372. <tbody>
  1373. <tr>
  1374. <td>
  1375. <code>
  1376. <em>validation</em>
  1377. </code>
  1378. </td>
  1379. <td>
  1380. <div>
  1381. <p>A closure to validate the request.</p>
  1382. </div>
  1383. </td>
  1384. </tr>
  1385. </tbody>
  1386. </table>
  1387. </div>
  1388. <div>
  1389. <h4>Return Value</h4>
  1390. <p>The request.</p>
  1391. </div>
  1392. </section>
  1393. </div>
  1394. </li>
  1395. <li class="item">
  1396. <div>
  1397. <code>
  1398. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1399. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1400. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1401. </code>
  1402. </div>
  1403. <div class="height-container">
  1404. <div class="pointer-container"></div>
  1405. <section class="section">
  1406. <div class="pointer"></div>
  1407. <div class="abstract">
  1408. <p>Validates that the response has a status code in the specified sequence.</p>
  1409. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1410. </div>
  1411. <div class="declaration">
  1412. <h4>Declaration</h4>
  1413. <div class="language">
  1414. <p class="aside-title">Swift</p>
  1415. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1416. <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>
  1417. </div>
  1418. </div>
  1419. <div>
  1420. <h4>Parameters</h4>
  1421. <table class="graybox">
  1422. <tbody>
  1423. <tr>
  1424. <td>
  1425. <code>
  1426. <em>range</em>
  1427. </code>
  1428. </td>
  1429. <td>
  1430. <div>
  1431. <p>The range of acceptable status codes.</p>
  1432. </div>
  1433. </td>
  1434. </tr>
  1435. </tbody>
  1436. </table>
  1437. </div>
  1438. <div>
  1439. <h4>Return Value</h4>
  1440. <p>The request.</p>
  1441. </div>
  1442. </section>
  1443. </div>
  1444. </li>
  1445. <li class="item">
  1446. <div>
  1447. <code>
  1448. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDx_tSTRzSS7ElementRtzlF"></a>
  1449. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1450. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDx_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1451. </code>
  1452. </div>
  1453. <div class="height-container">
  1454. <div class="pointer-container"></div>
  1455. <section class="section">
  1456. <div class="pointer"></div>
  1457. <div class="abstract">
  1458. <p>Validates that the response has a content type in the specified sequence.</p>
  1459. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1460. </div>
  1461. <div class="declaration">
  1462. <h4>Declaration</h4>
  1463. <div class="language">
  1464. <p class="aside-title">Swift</p>
  1465. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1466. <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="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>
  1467. </div>
  1468. </div>
  1469. <div>
  1470. <h4>Parameters</h4>
  1471. <table class="graybox">
  1472. <tbody>
  1473. <tr>
  1474. <td>
  1475. <code>
  1476. <em>contentType</em>
  1477. </code>
  1478. </td>
  1479. <td>
  1480. <div>
  1481. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1482. </div>
  1483. </td>
  1484. </tr>
  1485. </tbody>
  1486. </table>
  1487. </div>
  1488. <div>
  1489. <h4>Return Value</h4>
  1490. <p>The request.</p>
  1491. </div>
  1492. </section>
  1493. </div>
  1494. </li>
  1495. <li class="item">
  1496. <div>
  1497. <code>
  1498. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1499. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1500. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1501. </code>
  1502. </div>
  1503. <div class="height-container">
  1504. <div class="pointer-container"></div>
  1505. <section class="section">
  1506. <div class="pointer"></div>
  1507. <div class="abstract">
  1508. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1509. type matches any specified in the Accept HTTP header field.</p>
  1510. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1511. </div>
  1512. <div class="declaration">
  1513. <h4>Declaration</h4>
  1514. <div class="language">
  1515. <p class="aside-title">Swift</p>
  1516. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1517. <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>
  1518. </div>
  1519. </div>
  1520. <div>
  1521. <h4>Return Value</h4>
  1522. <p>The request.</p>
  1523. </div>
  1524. </section>
  1525. </div>
  1526. </li>
  1527. </ul>
  1528. </div>
  1529. </div>
  1530. </section>
  1531. </article>
  1532. </div>
  1533. <section class="footer">
  1534. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-26)</p>
  1535. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1536. </section>
  1537. </body>
  1538. </div>
  1539. </html>