DownloadRequest.html 83 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507
  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. (87% 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:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">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:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">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:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">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:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">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. </ul>
  274. </li>
  275. <li class="nav-group-name">
  276. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  277. <ul class="nav-group-tasks">
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </nav>
  291. <article class="main-content">
  292. <section class="section">
  293. <div class="section-content">
  294. <h1>DownloadRequest</h1>
  295. <div class="declaration">
  296. <div class="language">
  297. <pre class="highlight"><code><span class="n">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>
  298. </div>
  299. </div>
  300. <p>Specific type of <code><a href="../Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDownloadTask</code>.</p>
  301. </div>
  302. </section>
  303. <section class="section">
  304. <div class="section-content">
  305. <div class="task-group">
  306. <div class="task-name-container">
  307. <a name="/Helper%20Types"></a>
  308. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  309. <a href="#/Helper%20Types">
  310. <h3 class="section-name">Helper Types</h3>
  311. </a>
  312. </div>
  313. <ul class="item-container">
  314. <li class="item">
  315. <div>
  316. <code>
  317. <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV"></a>
  318. <a name="//apple_ref/swift/Struct/DownloadOptions" class="dashAnchor"></a>
  319. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV">DownloadOptions</a>
  320. </code>
  321. </div>
  322. <div class="height-container">
  323. <div class="pointer-container"></div>
  324. <section class="section">
  325. <div class="pointer"></div>
  326. <div class="abstract">
  327. <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
  328. destination URL.</p>
  329. <a href="../Classes/DownloadRequest/DownloadOptions.html" class="slightly-smaller">See more</a>
  330. </div>
  331. <div class="declaration">
  332. <h4>Declaration</h4>
  333. <div class="language">
  334. <p class="aside-title">Swift</p>
  335. <pre class="highlight"><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>
  336. </div>
  337. </div>
  338. </section>
  339. </div>
  340. </li>
  341. <li class="item">
  342. <div>
  343. <code>
  344. <a name="/s:9Alamofire15DownloadRequestC0B15FileDestinationa"></a>
  345. <a name="//apple_ref/swift/Alias/DownloadFileDestination" class="dashAnchor"></a>
  346. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a>
  347. </code>
  348. </div>
  349. <div class="height-container">
  350. <div class="pointer-container"></div>
  351. <section class="section">
  352. <div class="pointer"></div>
  353. <div class="abstract">
  354. <p>A closure executed once a download request has successfully completed in order to determine where to move the
  355. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  356. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  357. the options defining how the file should be moved.</p>
  358. </div>
  359. <div class="declaration">
  360. <h4>Declaration</h4>
  361. <div class="language">
  362. <p class="aside-title">Swift</p>
  363. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">DownloadFileDestination</span> <span class="o">=</span> <span class="p">(</span></code></pre>
  364. </div>
  365. </div>
  366. </section>
  367. </div>
  368. </li>
  369. </ul>
  370. </div>
  371. <div class="task-group">
  372. <div class="task-name-container">
  373. <a name="/Properties"></a>
  374. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  375. <a href="#/Properties">
  376. <h3 class="section-name">Properties</h3>
  377. </a>
  378. </div>
  379. <ul class="item-container">
  380. <li class="item">
  381. <div>
  382. <code>
  383. <a name="/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgv"></a>
  384. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  385. <a class="token" href="#/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgv">request</a>
  386. </code>
  387. </div>
  388. <div class="height-container">
  389. <div class="pointer-container"></div>
  390. <section class="section">
  391. <div class="pointer"></div>
  392. <div class="abstract">
  393. <p>The request sent or to be sent to the server.</p>
  394. </div>
  395. <div class="declaration">
  396. <h4>Declaration</h4>
  397. <div class="language">
  398. <p class="aside-title">Swift</p>
  399. <pre class="highlight"><code><span class="n">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></code></pre>
  400. </div>
  401. </div>
  402. </section>
  403. </div>
  404. </li>
  405. <li class="item">
  406. <div>
  407. <code>
  408. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgv"></a>
  409. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  410. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgv">resumeData</a>
  411. </code>
  412. </div>
  413. <div class="height-container">
  414. <div class="pointer-container"></div>
  415. <section class="section">
  416. <div class="pointer"></div>
  417. <div class="abstract">
  418. <p>The resume data of the underlying download task if available after a failure.</p>
  419. </div>
  420. <div class="declaration">
  421. <h4>Declaration</h4>
  422. <div class="language">
  423. <p class="aside-title">Swift</p>
  424. <pre class="highlight"><code><span class="n">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></code></pre>
  425. </div>
  426. </div>
  427. </section>
  428. </div>
  429. </li>
  430. <li class="item">
  431. <div>
  432. <code>
  433. <a name="/s:9Alamofire15DownloadRequestC8progressSo8ProgressCv"></a>
  434. <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
  435. <a class="token" href="#/s:9Alamofire15DownloadRequestC8progressSo8ProgressCv">progress</a>
  436. </code>
  437. </div>
  438. <div class="height-container">
  439. <div class="pointer-container"></div>
  440. <section class="section">
  441. <div class="pointer"></div>
  442. <div class="abstract">
  443. <p>The progress of downloading the response data from the server for the request.</p>
  444. </div>
  445. <div class="declaration">
  446. <h4>Declaration</h4>
  447. <div class="language">
  448. <p class="aside-title">Swift</p>
  449. <pre class="highlight"><code><span class="n">open</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  450. </div>
  451. </div>
  452. </section>
  453. </div>
  454. </li>
  455. </ul>
  456. </div>
  457. <div class="task-group">
  458. <div class="task-name-container">
  459. <a name="/State"></a>
  460. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  461. <a href="#/State">
  462. <h3 class="section-name">State</h3>
  463. </a>
  464. </div>
  465. <ul class="item-container">
  466. <li class="item">
  467. <div>
  468. <code>
  469. <a name="/s:9Alamofire15DownloadRequestC6cancelyyF"></a>
  470. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  471. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelyyF">cancel()</a>
  472. </code>
  473. </div>
  474. <div class="height-container">
  475. <div class="pointer-container"></div>
  476. <section class="section">
  477. <div class="pointer"></div>
  478. <div class="abstract">
  479. <p>Cancels the request.</p>
  480. </div>
  481. <div class="declaration">
  482. <h4>Declaration</h4>
  483. <div class="language">
  484. <p class="aside-title">Swift</p>
  485. <pre class="highlight"><code><span class="n">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
  486. </div>
  487. </div>
  488. </section>
  489. </div>
  490. </li>
  491. </ul>
  492. </div>
  493. <div class="task-group">
  494. <div class="task-name-container">
  495. <a name="/Progress"></a>
  496. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  497. <a href="#/Progress">
  498. <h3 class="section-name">Progress</h3>
  499. </a>
  500. </div>
  501. <ul class="item-container">
  502. <li class="item">
  503. <div>
  504. <code>
  505. <a name="/s:9Alamofire15DownloadRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF"></a>
  506. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  507. <a class="token" href="#/s:9Alamofire15DownloadRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF">downloadProgress(queue:closure:)</a>
  508. </code>
  509. </div>
  510. <div class="height-container">
  511. <div class="pointer-container"></div>
  512. <section class="section">
  513. <div class="pointer"></div>
  514. <div class="abstract">
  515. <p>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>
  516. </div>
  517. <div class="declaration">
  518. <h4>Declaration</h4>
  519. <div class="language">
  520. <p class="aside-title">Swift</p>
  521. <pre class="highlight"><code><span class="n">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>
  522. </div>
  523. </div>
  524. <div>
  525. <h4>Parameters</h4>
  526. <table class="graybox">
  527. <tbody>
  528. <tr>
  529. <td>
  530. <code>
  531. <em>queue</em>
  532. </code>
  533. </td>
  534. <td>
  535. <div>
  536. <p>The dispatch queue to execute the closure on.</p>
  537. </div>
  538. </td>
  539. </tr>
  540. <tr>
  541. <td>
  542. <code>
  543. <em>closure</em>
  544. </code>
  545. </td>
  546. <td>
  547. <div>
  548. <p>The code to be executed periodically as data is read from the server.</p>
  549. </div>
  550. </td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. </div>
  555. <div>
  556. <h4>Return Value</h4>
  557. <p>The request.</p>
  558. </div>
  559. </section>
  560. </div>
  561. </li>
  562. </ul>
  563. </div>
  564. <div class="task-group">
  565. <div class="task-name-container">
  566. <a name="/Destination"></a>
  567. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  568. <a href="#/Destination">
  569. <h3 class="section-name">Destination</h3>
  570. </a>
  571. </div>
  572. <ul class="item-container">
  573. <li class="item">
  574. <div>
  575. <code>
  576. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination10Foundation3URLV011destinationG0_AC0B7OptionsV7optionstAG_So15HTTPURLResponseCtcSo11FileManagerC19SearchPathDirectoryO3for_AO0nO10DomainMaskV2intFZ"></a>
  577. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:)" class="dashAnchor"></a>
  578. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination10Foundation3URLV011destinationG0_AC0B7OptionsV7optionstAG_So15HTTPURLResponseCtcSo11FileManagerC19SearchPathDirectoryO3for_AO0nO10DomainMaskV2intFZ">suggestedDownloadDestination(for:in:)</a>
  579. </code>
  580. </div>
  581. <div class="height-container">
  582. <div class="pointer-container"></div>
  583. <section class="section">
  584. <div class="pointer"></div>
  585. <div class="abstract">
  586. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  587. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  588. </div>
  589. <div class="declaration">
  590. <h4>Declaration</h4>
  591. <div class="language">
  592. <p class="aside-title">Swift</p>
  593. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">suggestedDownloadDestination</span><span class="p">(</span>
  594. <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>
  595. <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>
  596. <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a></span></code></pre>
  597. </div>
  598. </div>
  599. <div>
  600. <h4>Parameters</h4>
  601. <table class="graybox">
  602. <tbody>
  603. <tr>
  604. <td>
  605. <code>
  606. <em>directory</em>
  607. </code>
  608. </td>
  609. <td>
  610. <div>
  611. <p>The search path directory. <code>.DocumentDirectory</code> by default.</p>
  612. </div>
  613. </td>
  614. </tr>
  615. <tr>
  616. <td>
  617. <code>
  618. <em>domain</em>
  619. </code>
  620. </td>
  621. <td>
  622. <div>
  623. <p>The search path domain mask. <code>.UserDomainMask</code> by default.</p>
  624. </div>
  625. </td>
  626. </tr>
  627. </tbody>
  628. </table>
  629. </div>
  630. <div>
  631. <h4>Return Value</h4>
  632. <p>A download file destination closure.</p>
  633. </div>
  634. </section>
  635. </div>
  636. </li>
  637. </ul>
  638. </div>
  639. <div class="task-group">
  640. <ul class="item-container">
  641. <li class="item">
  642. <div>
  643. <code>
  644. <a name="/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF"></a>
  645. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  646. <a class="token" href="#/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF">response(queue:completionHandler:)</a>
  647. </code>
  648. </div>
  649. <div class="height-container">
  650. <div class="pointer-container"></div>
  651. <section class="section">
  652. <div class="pointer"></div>
  653. <div class="abstract">
  654. <p>Adds a handler to be called once the request has finished.</p>
  655. </div>
  656. <div class="declaration">
  657. <h4>Declaration</h4>
  658. <div class="language">
  659. <p class="aside-title">Swift</p>
  660. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
  661. <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>
  662. <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>
  663. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  664. </div>
  665. </div>
  666. <div>
  667. <h4>Parameters</h4>
  668. <table class="graybox">
  669. <tbody>
  670. <tr>
  671. <td>
  672. <code>
  673. <em>queue</em>
  674. </code>
  675. </td>
  676. <td>
  677. <div>
  678. <p>The queue on which the completion handler is dispatched.</p>
  679. </div>
  680. </td>
  681. </tr>
  682. <tr>
  683. <td>
  684. <code>
  685. <em>completionHandler</em>
  686. </code>
  687. </td>
  688. <td>
  689. <div>
  690. <p>The code to be executed once the request has finished.</p>
  691. </div>
  692. </td>
  693. </tr>
  694. </tbody>
  695. </table>
  696. </div>
  697. <div>
  698. <h4>Return Value</h4>
  699. <p>The request.</p>
  700. </div>
  701. </section>
  702. </div>
  703. </li>
  704. <li class="item">
  705. <div>
  706. <code>
  707. <a name="/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF"></a>
  708. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  709. <a class="token" href="#/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  710. </code>
  711. </div>
  712. <div class="height-container">
  713. <div class="pointer-container"></div>
  714. <section class="section">
  715. <div class="pointer"></div>
  716. <div class="abstract">
  717. <p>Adds a handler to be called once the request has finished.</p>
  718. </div>
  719. <div class="declaration">
  720. <h4>Declaration</h4>
  721. <div class="language">
  722. <p class="aside-title">Swift</p>
  723. <pre class="highlight"><code><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>
  724. <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>
  725. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
  726. <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>
  727. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  728. </div>
  729. </div>
  730. <div>
  731. <h4>Parameters</h4>
  732. <table class="graybox">
  733. <tbody>
  734. <tr>
  735. <td>
  736. <code>
  737. <em>queue</em>
  738. </code>
  739. </td>
  740. <td>
  741. <div>
  742. <p>The queue on which the completion handler is dispatched.</p>
  743. </div>
  744. </td>
  745. </tr>
  746. <tr>
  747. <td>
  748. <code>
  749. <em>responseSerializer</em>
  750. </code>
  751. </td>
  752. <td>
  753. <div>
  754. <p>The response serializer responsible for serializing the request, response,
  755. and data contained in the destination url.</p>
  756. </div>
  757. </td>
  758. </tr>
  759. <tr>
  760. <td>
  761. <code>
  762. <em>completionHandler</em>
  763. </code>
  764. </td>
  765. <td>
  766. <div>
  767. <p>The code to be executed once the request has finished.</p>
  768. </div>
  769. </td>
  770. </tr>
  771. </tbody>
  772. </table>
  773. </div>
  774. <div>
  775. <h4>Return Value</h4>
  776. <p>The request.</p>
  777. </div>
  778. </section>
  779. </div>
  780. </li>
  781. </ul>
  782. </div>
  783. <div class="task-group">
  784. <ul class="item-container">
  785. <li class="item">
  786. <div>
  787. <code>
  788. <a name="/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ"></a>
  789. <a name="//apple_ref/swift/Method/dataResponseSerializer()" class="dashAnchor"></a>
  790. <a class="token" href="#/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ">dataResponseSerializer()</a>
  791. </code>
  792. </div>
  793. <div class="height-container">
  794. <div class="pointer-container"></div>
  795. <section class="section">
  796. <div class="pointer"></div>
  797. <div class="abstract">
  798. <p>Creates a response serializer that returns the associated data as-is.</p>
  799. </div>
  800. <div class="declaration">
  801. <h4>Declaration</h4>
  802. <div class="language">
  803. <p class="aside-title">Swift</p>
  804. <pre class="highlight"><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>
  805. </div>
  806. </div>
  807. <div>
  808. <h4>Return Value</h4>
  809. <p>A data response serializer.</p>
  810. </div>
  811. </section>
  812. </div>
  813. </li>
  814. <li class="item">
  815. <div>
  816. <code>
  817. <a name="/s:9Alamofire15DownloadRequestC12responseDataACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0E0VGc17completionHandlertF"></a>
  818. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  819. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseDataACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0E0VGc17completionHandlertF">responseData(queue:completionHandler:)</a>
  820. </code>
  821. </div>
  822. <div class="height-container">
  823. <div class="pointer-container"></div>
  824. <section class="section">
  825. <div class="pointer"></div>
  826. <div class="abstract">
  827. <p>Adds a handler to be called once the request has finished.</p>
  828. </div>
  829. <div class="declaration">
  830. <h4>Declaration</h4>
  831. <div class="language">
  832. <p class="aside-title">Swift</p>
  833. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
  834. <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>
  835. <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>
  836. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  837. </div>
  838. </div>
  839. <div>
  840. <h4>Parameters</h4>
  841. <table class="graybox">
  842. <tbody>
  843. <tr>
  844. <td>
  845. <code>
  846. <em>completionHandler</em>
  847. </code>
  848. </td>
  849. <td>
  850. <div>
  851. <p>The code to be executed once the request has finished.</p>
  852. </div>
  853. </td>
  854. </tr>
  855. </tbody>
  856. </table>
  857. </div>
  858. <div>
  859. <h4>Return Value</h4>
  860. <p>The request.</p>
  861. </div>
  862. </section>
  863. </div>
  864. </li>
  865. </ul>
  866. </div>
  867. <div class="task-group">
  868. <ul class="item-container">
  869. <li class="item">
  870. <div>
  871. <code>
  872. <a name="/s:9Alamofire15DownloadRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ"></a>
  873. <a name="//apple_ref/swift/Method/stringResponseSerializer(encoding:)" class="dashAnchor"></a>
  874. <a class="token" href="#/s:9Alamofire15DownloadRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ">stringResponseSerializer(encoding:)</a>
  875. </code>
  876. </div>
  877. <div class="height-container">
  878. <div class="pointer-container"></div>
  879. <section class="section">
  880. <div class="pointer"></div>
  881. <div class="abstract">
  882. <p>Creates a response serializer that returns a result string type initialized from the response data with
  883. the specified string encoding.</p>
  884. </div>
  885. <div class="declaration">
  886. <h4>Declaration</h4>
  887. <div class="language">
  888. <p class="aside-title">Swift</p>
  889. <pre class="highlight"><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>
  890. </div>
  891. </div>
  892. <div>
  893. <h4>Parameters</h4>
  894. <table class="graybox">
  895. <tbody>
  896. <tr>
  897. <td>
  898. <code>
  899. <em>encoding</em>
  900. </code>
  901. </td>
  902. <td>
  903. <div>
  904. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server
  905. response, falling back to the default HTTP default character set, ISO-8859-1.</p>
  906. </div>
  907. </td>
  908. </tr>
  909. </tbody>
  910. </table>
  911. </div>
  912. <div>
  913. <h4>Return Value</h4>
  914. <p>A string response serializer.</p>
  915. </div>
  916. </section>
  917. </div>
  918. </li>
  919. <li class="item">
  920. <div>
  921. <code>
  922. <a name="/s:9Alamofire15DownloadRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF"></a>
  923. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  924. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF">responseString(queue:encoding:completionHandler:)</a>
  925. </code>
  926. </div>
  927. <div class="height-container">
  928. <div class="pointer-container"></div>
  929. <section class="section">
  930. <div class="pointer"></div>
  931. <div class="abstract">
  932. <p>Adds a handler to be called once the request has finished.</p>
  933. </div>
  934. <div class="declaration">
  935. <h4>Declaration</h4>
  936. <div class="language">
  937. <p class="aside-title">Swift</p>
  938. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
  939. <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>
  940. <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>
  941. <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>
  942. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  943. </div>
  944. </div>
  945. <div>
  946. <h4>Parameters</h4>
  947. <table class="graybox">
  948. <tbody>
  949. <tr>
  950. <td>
  951. <code>
  952. <em>encoding</em>
  953. </code>
  954. </td>
  955. <td>
  956. <div>
  957. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the
  958. server response, falling back to the default HTTP default character set,
  959. ISO-8859-1.</p>
  960. </div>
  961. </td>
  962. </tr>
  963. <tr>
  964. <td>
  965. <code>
  966. <em>completionHandler</em>
  967. </code>
  968. </td>
  969. <td>
  970. <div>
  971. <p>A closure to be executed once the request has finished.</p>
  972. </div>
  973. </td>
  974. </tr>
  975. </tbody>
  976. </table>
  977. </div>
  978. <div>
  979. <h4>Return Value</h4>
  980. <p>The request.</p>
  981. </div>
  982. </section>
  983. </div>
  984. </li>
  985. </ul>
  986. </div>
  987. <div class="task-group">
  988. <ul class="item-container">
  989. <li class="item">
  990. <div>
  991. <code>
  992. <a name="/s:9Alamofire15DownloadRequestC22jsonResponseSerializerAA0beF0VyypGSo17JSONSerializationC14ReadingOptionsV7options_tFZ"></a>
  993. <a name="//apple_ref/swift/Method/jsonResponseSerializer(options:)" class="dashAnchor"></a>
  994. <a class="token" href="#/s:9Alamofire15DownloadRequestC22jsonResponseSerializerAA0beF0VyypGSo17JSONSerializationC14ReadingOptionsV7options_tFZ">jsonResponseSerializer(options:)</a>
  995. </code>
  996. </div>
  997. <div class="height-container">
  998. <div class="pointer-container"></div>
  999. <section class="section">
  1000. <div class="pointer"></div>
  1001. <div class="abstract">
  1002. <p>Creates a response serializer that returns a JSON object result type constructed from the response data using
  1003. <code>JSONSerialization</code> with the specified reading options.</p>
  1004. </div>
  1005. <div class="declaration">
  1006. <h4>Declaration</h4>
  1007. <div class="language">
  1008. <p class="aside-title">Swift</p>
  1009. <pre class="highlight"><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>
  1010. <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>
  1011. <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>
  1012. </div>
  1013. </div>
  1014. <div>
  1015. <h4>Parameters</h4>
  1016. <table class="graybox">
  1017. <tbody>
  1018. <tr>
  1019. <td>
  1020. <code>
  1021. <em>options</em>
  1022. </code>
  1023. </td>
  1024. <td>
  1025. <div>
  1026. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1027. </div>
  1028. </td>
  1029. </tr>
  1030. </tbody>
  1031. </table>
  1032. </div>
  1033. <div>
  1034. <h4>Return Value</h4>
  1035. <p>A JSON object response serializer.</p>
  1036. </div>
  1037. </section>
  1038. </div>
  1039. </li>
  1040. <li class="item">
  1041. <div>
  1042. <code>
  1043. <a name="/s:9Alamofire15DownloadRequestC12responseJSONACXDSo13DispatchQueueCSg5queue_So17JSONSerializationC14ReadingOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF"></a>
  1044. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1045. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSONACXDSo13DispatchQueueCSg5queue_So17JSONSerializationC14ReadingOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF">responseJSON(queue:options:completionHandler:)</a>
  1046. </code>
  1047. </div>
  1048. <div class="height-container">
  1049. <div class="pointer-container"></div>
  1050. <section class="section">
  1051. <div class="pointer"></div>
  1052. <div class="abstract">
  1053. <p>Adds a handler to be called once the request has finished.</p>
  1054. </div>
  1055. <div class="declaration">
  1056. <h4>Declaration</h4>
  1057. <div class="language">
  1058. <p class="aside-title">Swift</p>
  1059. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
  1060. <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>
  1061. <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>
  1062. <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>
  1063. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1064. </div>
  1065. </div>
  1066. <div>
  1067. <h4>Parameters</h4>
  1068. <table class="graybox">
  1069. <tbody>
  1070. <tr>
  1071. <td>
  1072. <code>
  1073. <em>options</em>
  1074. </code>
  1075. </td>
  1076. <td>
  1077. <div>
  1078. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1079. </div>
  1080. </td>
  1081. </tr>
  1082. <tr>
  1083. <td>
  1084. <code>
  1085. <em>completionHandler</em>
  1086. </code>
  1087. </td>
  1088. <td>
  1089. <div>
  1090. <p>A closure to be executed once the request has finished.</p>
  1091. </div>
  1092. </td>
  1093. </tr>
  1094. </tbody>
  1095. </table>
  1096. </div>
  1097. <div>
  1098. <h4>Return Value</h4>
  1099. <p>The request.</p>
  1100. </div>
  1101. </section>
  1102. </div>
  1103. </li>
  1104. </ul>
  1105. </div>
  1106. <div class="task-group">
  1107. <ul class="item-container">
  1108. <li class="item">
  1109. <div>
  1110. <code>
  1111. <a name="/s:9Alamofire15DownloadRequestC30propertyListResponseSerializerAA0bfG0VyypGSo08PropertyE13SerializationC17MutabilityOptionsV7options_tFZ"></a>
  1112. <a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
  1113. <a class="token" href="#/s:9Alamofire15DownloadRequestC30propertyListResponseSerializerAA0bfG0VyypGSo08PropertyE13SerializationC17MutabilityOptionsV7options_tFZ">propertyListResponseSerializer(options:)</a>
  1114. </code>
  1115. </div>
  1116. <div class="height-container">
  1117. <div class="pointer-container"></div>
  1118. <section class="section">
  1119. <div class="pointer"></div>
  1120. <div class="abstract">
  1121. <p>Creates a response serializer that returns an object constructed from the response data using
  1122. <code>PropertyListSerialization</code> with the specified reading options.</p>
  1123. </div>
  1124. <div class="declaration">
  1125. <h4>Declaration</h4>
  1126. <div class="language">
  1127. <p class="aside-title">Swift</p>
  1128. <pre class="highlight"><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>
  1129. <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>
  1130. <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>
  1131. </div>
  1132. </div>
  1133. <div>
  1134. <h4>Parameters</h4>
  1135. <table class="graybox">
  1136. <tbody>
  1137. <tr>
  1138. <td>
  1139. <code>
  1140. <em>options</em>
  1141. </code>
  1142. </td>
  1143. <td>
  1144. <div>
  1145. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1146. </div>
  1147. </td>
  1148. </tr>
  1149. </tbody>
  1150. </table>
  1151. </div>
  1152. <div>
  1153. <h4>Return Value</h4>
  1154. <p>A property list object response serializer.</p>
  1155. </div>
  1156. </section>
  1157. </div>
  1158. </li>
  1159. <li class="item">
  1160. <div>
  1161. <code>
  1162. <a name="/s:9Alamofire15DownloadRequestC20responsePropertyListACXDSo13DispatchQueueCSg5queue_So0eF13SerializationC17MutabilityOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF"></a>
  1163. <a name="//apple_ref/swift/Method/responsePropertyList(queue:options:completionHandler:)" class="dashAnchor"></a>
  1164. <a class="token" href="#/s:9Alamofire15DownloadRequestC20responsePropertyListACXDSo13DispatchQueueCSg5queue_So0eF13SerializationC17MutabilityOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF">responsePropertyList(queue:options:completionHandler:)</a>
  1165. </code>
  1166. </div>
  1167. <div class="height-container">
  1168. <div class="pointer-container"></div>
  1169. <section class="section">
  1170. <div class="pointer"></div>
  1171. <div class="abstract">
  1172. <p>Adds a handler to be called once the request has finished.</p>
  1173. </div>
  1174. <div class="declaration">
  1175. <h4>Declaration</h4>
  1176. <div class="language">
  1177. <p class="aside-title">Swift</p>
  1178. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span>
  1179. <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>
  1180. <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>
  1181. <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>
  1182. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1183. </div>
  1184. </div>
  1185. <div>
  1186. <h4>Parameters</h4>
  1187. <table class="graybox">
  1188. <tbody>
  1189. <tr>
  1190. <td>
  1191. <code>
  1192. <em>options</em>
  1193. </code>
  1194. </td>
  1195. <td>
  1196. <div>
  1197. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1198. </div>
  1199. </td>
  1200. </tr>
  1201. <tr>
  1202. <td>
  1203. <code>
  1204. <em>completionHandler</em>
  1205. </code>
  1206. </td>
  1207. <td>
  1208. <div>
  1209. <p>A closure to be executed once the request has finished.</p>
  1210. </div>
  1211. </td>
  1212. </tr>
  1213. </tbody>
  1214. </table>
  1215. </div>
  1216. <div>
  1217. <h4>Return Value</h4>
  1218. <p>The request.</p>
  1219. </div>
  1220. </section>
  1221. </div>
  1222. </li>
  1223. </ul>
  1224. </div>
  1225. <div class="task-group">
  1226. <ul class="item-container">
  1227. <li class="item">
  1228. <div>
  1229. <code>
  1230. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1231. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1232. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1233. </code>
  1234. </div>
  1235. <div class="height-container">
  1236. <div class="pointer-container"></div>
  1237. <section class="section">
  1238. <div class="pointer"></div>
  1239. <div class="abstract">
  1240. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1241. destination URL, and returns whether the request was valid.</p>
  1242. </div>
  1243. <div class="declaration">
  1244. <h4>Declaration</h4>
  1245. <div class="language">
  1246. <p class="aside-title">Swift</p>
  1247. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Validation</span> <span class="o">=</span> <span class="p">(</span></code></pre>
  1248. </div>
  1249. </div>
  1250. </section>
  1251. </div>
  1252. </li>
  1253. <li class="item">
  1254. <div>
  1255. <code>
  1256. <a name="/s:9Alamofire15DownloadRequestC8validateACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So15HTTPURLResponseCAI3URLVSgAQtcF"></a>
  1257. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1258. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So15HTTPURLResponseCAI3URLVSgAQtcF">validate(_:)</a>
  1259. </code>
  1260. </div>
  1261. <div class="height-container">
  1262. <div class="pointer-container"></div>
  1263. <section class="section">
  1264. <div class="pointer"></div>
  1265. <div class="abstract">
  1266. <p>Validates the request, using the specified closure.</p>
  1267. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1268. </div>
  1269. <div class="declaration">
  1270. <h4>Declaration</h4>
  1271. <div class="language">
  1272. <p class="aside-title">Swift</p>
  1273. <pre class="highlight"><code><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>
  1274. </div>
  1275. </div>
  1276. <div>
  1277. <h4>Parameters</h4>
  1278. <table class="graybox">
  1279. <tbody>
  1280. <tr>
  1281. <td>
  1282. <code>
  1283. <em>validation</em>
  1284. </code>
  1285. </td>
  1286. <td>
  1287. <div>
  1288. <p>A closure to validate the request.</p>
  1289. </div>
  1290. </td>
  1291. </tr>
  1292. </tbody>
  1293. </table>
  1294. </div>
  1295. <div>
  1296. <h4>Return Value</h4>
  1297. <p>The request.</p>
  1298. </div>
  1299. </section>
  1300. </div>
  1301. </li>
  1302. <li class="item">
  1303. <div>
  1304. <code>
  1305. <a name="/s:9Alamofire15DownloadRequestC8validateACXDx10statusCode_ts8SequenceRzSi7ElementRtzlF"></a>
  1306. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1307. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDx10statusCode_ts8SequenceRzSi7ElementRtzlF">validate(statusCode:)</a>
  1308. </code>
  1309. </div>
  1310. <div class="height-container">
  1311. <div class="pointer-container"></div>
  1312. <section class="section">
  1313. <div class="pointer"></div>
  1314. <div class="abstract">
  1315. <p>Validates that the response has a status code in the specified sequence.</p>
  1316. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1317. </div>
  1318. <div class="declaration">
  1319. <h4>Declaration</h4>
  1320. <div class="language">
  1321. <p class="aside-title">Swift</p>
  1322. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">&gt;</span><span class="p">(</span><span class="n">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="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
  1323. </div>
  1324. </div>
  1325. <div>
  1326. <h4>Parameters</h4>
  1327. <table class="graybox">
  1328. <tbody>
  1329. <tr>
  1330. <td>
  1331. <code>
  1332. <em>range</em>
  1333. </code>
  1334. </td>
  1335. <td>
  1336. <div>
  1337. <p>The range of acceptable status codes.</p>
  1338. </div>
  1339. </td>
  1340. </tr>
  1341. </tbody>
  1342. </table>
  1343. </div>
  1344. <div>
  1345. <h4>Return Value</h4>
  1346. <p>The request.</p>
  1347. </div>
  1348. </section>
  1349. </div>
  1350. </li>
  1351. <li class="item">
  1352. <div>
  1353. <code>
  1354. <a name="/s:9Alamofire15DownloadRequestC8validateACXDx11contentType_ts8SequenceRzSS7ElementRtzlF"></a>
  1355. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1356. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDx11contentType_ts8SequenceRzSS7ElementRtzlF">validate(contentType:)</a>
  1357. </code>
  1358. </div>
  1359. <div class="height-container">
  1360. <div class="pointer-container"></div>
  1361. <section class="section">
  1362. <div class="pointer"></div>
  1363. <div class="abstract">
  1364. <p>Validates that the response has a content type in the specified sequence.</p>
  1365. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1366. </div>
  1367. <div class="declaration">
  1368. <h4>Declaration</h4>
  1369. <div class="language">
  1370. <p class="aside-title">Swift</p>
  1371. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">&gt;</span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  1372. </div>
  1373. </div>
  1374. <div>
  1375. <h4>Parameters</h4>
  1376. <table class="graybox">
  1377. <tbody>
  1378. <tr>
  1379. <td>
  1380. <code>
  1381. <em>contentType</em>
  1382. </code>
  1383. </td>
  1384. <td>
  1385. <div>
  1386. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1387. </div>
  1388. </td>
  1389. </tr>
  1390. </tbody>
  1391. </table>
  1392. </div>
  1393. <div>
  1394. <h4>Return Value</h4>
  1395. <p>The request.</p>
  1396. </div>
  1397. </section>
  1398. </div>
  1399. </li>
  1400. <li class="item">
  1401. <div>
  1402. <code>
  1403. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1404. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1405. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1406. </code>
  1407. </div>
  1408. <div class="height-container">
  1409. <div class="pointer-container"></div>
  1410. <section class="section">
  1411. <div class="pointer"></div>
  1412. <div class="abstract">
  1413. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1414. type matches any specified in the Accept HTTP header field.</p>
  1415. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1416. </div>
  1417. <div class="declaration">
  1418. <h4>Declaration</h4>
  1419. <div class="language">
  1420. <p class="aside-title">Swift</p>
  1421. <pre class="highlight"><code><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>
  1422. </div>
  1423. </div>
  1424. <div>
  1425. <h4>Return Value</h4>
  1426. <p>The request.</p>
  1427. </div>
  1428. </section>
  1429. </div>
  1430. </li>
  1431. </ul>
  1432. </div>
  1433. </div>
  1434. </section>
  1435. </article>
  1436. </div>
  1437. <section class="footer">
  1438. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-12-03)</p>
  1439. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1440. </section>
  1441. </body>
  1442. </div>
  1443. </html>