DownloadRequest.html 151 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504
  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 5.2.1 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. DownloadRequest Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. </ul>
  463. </li>
  464. <li class="nav-group-name">
  465. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  466. <ul class="nav-group-tasks">
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  487. </li>
  488. </ul>
  489. </li>
  490. </ul>
  491. </nav>
  492. <article class="main-content">
  493. <section class="section">
  494. <div class="section-content top-matter">
  495. <h1>DownloadRequest</h1>
  496. <div class="declaration">
  497. <div class="language">
  498. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span> <span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
  499. </div>
  500. </div>
  501. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which downloads <code>Data</code> to a file on disk using <code>URLSessionDownloadTask</code>.</p>
  502. </div>
  503. </section>
  504. <section class="section">
  505. <div class="section-content">
  506. <div class="task-group">
  507. <ul class="item-container">
  508. <li class="item">
  509. <div>
  510. <code>
  511. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  512. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  513. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  514. </code>
  515. </div>
  516. <div class="height-container">
  517. <div class="pointer-container"></div>
  518. <section class="section">
  519. <div class="pointer"></div>
  520. <div class="abstract">
  521. <p>A set of options to be executed prior to moving a downloaded file from the temporary <code>URL</code> to the destination
  522. <code>URL</code>.</p>
  523. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  524. </div>
  525. <div class="declaration">
  526. <h4>Declaration</h4>
  527. <div class="language">
  528. <p class="aside-title">Swift</p>
  529. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Options</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>
  530. </div>
  531. </div>
  532. </section>
  533. </div>
  534. </li>
  535. </ul>
  536. </div>
  537. <div class="task-group">
  538. <div class="task-name-container">
  539. <a name="/Destination"></a>
  540. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  541. <div class="section-name-container">
  542. <a class="section-name-link" href="#/Destination"></a>
  543. <h3 class="section-name"><p>Destination</p>
  544. </h3>
  545. </div>
  546. </div>
  547. <ul class="item-container">
  548. <li class="item">
  549. <div>
  550. <code>
  551. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  552. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  553. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  554. </code>
  555. </div>
  556. <div class="height-container">
  557. <div class="pointer-container"></div>
  558. <section class="section">
  559. <div class="pointer"></div>
  560. <div class="abstract">
  561. <p>A closure executed once a <code>DownloadRequest</code> has successfully completed in order to determine where to move the
  562. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  563. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  564. the options defining how the file should be moved.</p>
  565. </div>
  566. <div class="declaration">
  567. <h4>Declaration</h4>
  568. <div class="language">
  569. <p class="aside-title">Swift</p>
  570. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Destination</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">temporaryURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
  571. <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">destinationURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Options.html">Options</a></span><span class="p">)</span></code></pre>
  572. </div>
  573. </div>
  574. </section>
  575. </div>
  576. </li>
  577. <li class="item">
  578. <div>
  579. <code>
  580. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  581. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  582. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:<wbr>in:<wbr>options:<wbr>)</a>
  583. </code>
  584. </div>
  585. <div class="height-container">
  586. <div class="pointer-container"></div>
  587. <section class="section">
  588. <div class="pointer"></div>
  589. <div class="abstract">
  590. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  591. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  592. </div>
  593. <div class="declaration">
  594. <h4>Declaration</h4>
  595. <div class="language">
  596. <p class="aside-title">Swift</p>
  597. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">suggestedDownloadDestination</span><span class="p">(</span><span class="k">for</span> <span class="nv">directory</span><span class="p">:</span> <span class="kt">FileManager</span><span class="o">.</span><span class="kt">SearchPathDirectory</span> <span class="o">=</span> <span class="o">.</span><span class="n">documentDirectory</span><span class="p">,</span>
  598. <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>
  599. <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Options.html">Options</a></span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></span></code></pre>
  600. </div>
  601. </div>
  602. <div>
  603. <h4>Parameters</h4>
  604. <table class="graybox">
  605. <tbody>
  606. <tr>
  607. <td>
  608. <code>
  609. <em>directory</em>
  610. </code>
  611. </td>
  612. <td>
  613. <div>
  614. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  615. </div>
  616. </td>
  617. </tr>
  618. <tr>
  619. <td>
  620. <code>
  621. <em>domain</em>
  622. </code>
  623. </td>
  624. <td>
  625. <div>
  626. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  627. </div>
  628. </td>
  629. </tr>
  630. <tr>
  631. <td>
  632. <code>
  633. <em>options</em>
  634. </code>
  635. </td>
  636. <td>
  637. <div>
  638. <p><code><a href="../Classes/DownloadRequest/Options.html">DownloadRequest.Options</a></code> used when moving the downloaded file to its destination. None by
  639. default.</p>
  640. </div>
  641. </td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. </div>
  646. <div>
  647. <h4>Return Value</h4>
  648. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></code> closure.</p>
  649. </div>
  650. </section>
  651. </div>
  652. </li>
  653. </ul>
  654. </div>
  655. <div class="task-group">
  656. <div class="task-name-container">
  657. <a name="/Downloadable"></a>
  658. <a name="//apple_ref/swift/Section/Downloadable" class="dashAnchor"></a>
  659. <div class="section-name-container">
  660. <a class="section-name-link" href="#/Downloadable"></a>
  661. <h3 class="section-name"><p>Downloadable</p>
  662. </h3>
  663. </div>
  664. </div>
  665. <ul class="item-container">
  666. <li class="item">
  667. <div>
  668. <code>
  669. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  670. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  671. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  672. </code>
  673. </div>
  674. <div class="height-container">
  675. <div class="pointer-container"></div>
  676. <section class="section">
  677. <div class="pointer"></div>
  678. <div class="abstract">
  679. <p>Type describing the source used to create the underlying <code>URLSessionDownloadTask</code>.</p>
  680. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  687. </div>
  688. </div>
  689. </section>
  690. </div>
  691. </li>
  692. </ul>
  693. </div>
  694. <div class="task-group">
  695. <div class="task-name-container">
  696. <a name="/Mutable%20State"></a>
  697. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  698. <div class="section-name-container">
  699. <a class="section-name-link" href="#/Mutable%20State"></a>
  700. <h3 class="section-name"><p>Mutable State</p>
  701. </h3>
  702. </div>
  703. </div>
  704. <ul class="item-container">
  705. <li class="item">
  706. <div>
  707. <code>
  708. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  709. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  710. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  711. </code>
  712. </div>
  713. <div class="height-container">
  714. <div class="pointer-container"></div>
  715. <section class="section">
  716. <div class="pointer"></div>
  717. <div class="abstract">
  718. <p>If the download is resumable and eventually cancelled, this value may be used to resume the download using the
  719. <code>download(resumingWith data:)</code> API.</p>
  720. <div class="aside aside-note">
  721. <p class="aside-title">Note</p>
  722. For more information about <code>resumeData</code>, see <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>.
  723. </div>
  724. </div>
  725. <div class="declaration">
  726. <h4>Declaration</h4>
  727. <div class="language">
  728. <p class="aside-title">Swift</p>
  729. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  730. </div>
  731. </div>
  732. </section>
  733. </div>
  734. </li>
  735. <li class="item">
  736. <div>
  737. <code>
  738. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  739. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  740. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  741. </code>
  742. </div>
  743. <div class="height-container">
  744. <div class="pointer-container"></div>
  745. <section class="section">
  746. <div class="pointer"></div>
  747. <div class="abstract">
  748. <p>If the download is successful, the <code>URL</code> where the file was downloaded.</p>
  749. </div>
  750. <div class="declaration">
  751. <h4>Declaration</h4>
  752. <div class="language">
  753. <p class="aside-title">Swift</p>
  754. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  755. </div>
  756. </div>
  757. </section>
  758. </div>
  759. </li>
  760. </ul>
  761. </div>
  762. <div class="task-group">
  763. <div class="task-name-container">
  764. <a name="/Initial%20State"></a>
  765. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  766. <div class="section-name-container">
  767. <a class="section-name-link" href="#/Initial%20State"></a>
  768. <h3 class="section-name"><p>Initial State</p>
  769. </h3>
  770. </div>
  771. </div>
  772. <ul class="item-container">
  773. <li class="item">
  774. <div>
  775. <code>
  776. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  777. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  778. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  779. </code>
  780. </div>
  781. <div class="height-container">
  782. <div class="pointer-container"></div>
  783. <section class="section">
  784. <div class="pointer"></div>
  785. <div class="abstract">
  786. <p><code><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></code> value used for this instance.</p>
  787. </div>
  788. <div class="declaration">
  789. <h4>Declaration</h4>
  790. <div class="language">
  791. <p class="aside-title">Swift</p>
  792. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">downloadable</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></span></code></pre>
  793. </div>
  794. </div>
  795. </section>
  796. </div>
  797. </li>
  798. <li class="item">
  799. <div>
  800. <code>
  801. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  802. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  803. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:<wbr>using:<wbr>)</a>
  804. </code>
  805. </div>
  806. <div class="height-container">
  807. <div class="pointer-container"></div>
  808. <section class="section">
  809. <div class="pointer"></div>
  810. <div class="abstract">
  811. <p>Creates a <code>URLSessionTask</code> from the provided resume data.</p>
  812. </div>
  813. <div class="declaration">
  814. <h4>Declaration</h4>
  815. <div class="language">
  816. <p class="aside-title">Swift</p>
  817. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">task</span><span class="p">(</span><span class="n">forResumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">using</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">URLSessionTask</span></code></pre>
  818. </div>
  819. </div>
  820. <div>
  821. <h4>Parameters</h4>
  822. <table class="graybox">
  823. <tbody>
  824. <tr>
  825. <td>
  826. <code>
  827. <em>data</em>
  828. </code>
  829. </td>
  830. <td>
  831. <div>
  832. <p><code>Data</code> used to resume the download.</p>
  833. </div>
  834. </td>
  835. </tr>
  836. <tr>
  837. <td>
  838. <code>
  839. <em>session</em>
  840. </code>
  841. </td>
  842. <td>
  843. <div>
  844. <p><code>URLSession</code> used to create the <code>URLSessionTask</code>.</p>
  845. </div>
  846. </td>
  847. </tr>
  848. </tbody>
  849. </table>
  850. </div>
  851. <div>
  852. <h4>Return Value</h4>
  853. <p>The <code>URLSessionTask</code> created.</p>
  854. </div>
  855. </section>
  856. </div>
  857. </li>
  858. <li class="item">
  859. <div>
  860. <code>
  861. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  862. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  863. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  864. </code>
  865. </div>
  866. <div class="height-container">
  867. <div class="pointer-container"></div>
  868. <section class="section">
  869. <div class="pointer"></div>
  870. <div class="abstract">
  871. <p>Cancels the instance. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed or suspended.</p>
  872. <div class="aside aside-note">
  873. <p class="aside-title">Note</p>
  874. <p>This method will NOT produce resume data. If you wish to cancel and produce resume data, use
  875. <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:)</a></code> or <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:)</a></code>.</p>
  876. </div>
  877. </div>
  878. <div class="declaration">
  879. <h4>Declaration</h4>
  880. <div class="language">
  881. <p class="aside-title">Swift</p>
  882. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  883. <span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  884. </div>
  885. </div>
  886. <div>
  887. <h4>Return Value</h4>
  888. <p>The instance.</p>
  889. </div>
  890. </section>
  891. </div>
  892. </li>
  893. <li class="item">
  894. <div>
  895. <code>
  896. <a name="/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF"></a>
  897. <a name="//apple_ref/swift/Method/cancel(producingResumeData:)" class="dashAnchor"></a>
  898. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:<wbr>)</a>
  899. </code>
  900. </div>
  901. <div class="height-container">
  902. <div class="pointer-container"></div>
  903. <section class="section">
  904. <div class="pointer"></div>
  905. <div class="abstract">
  906. <p>Cancels the instance, optionally producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be
  907. resumed or suspended.</p>
  908. <div class="aside aside-note">
  909. <p class="aside-title">Note</p>
  910. <p>If <code>producingResumeData</code> is <code>true</code>, the <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code> property will be populated with any resume data, if
  911. available.</p>
  912. </div>
  913. </div>
  914. <div class="declaration">
  915. <h4>Declaration</h4>
  916. <div class="language">
  917. <p class="aside-title">Swift</p>
  918. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  919. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">producingResumeData</span> <span class="nv">shouldProduceResumeData</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  920. </div>
  921. </div>
  922. <div>
  923. <h4>Return Value</h4>
  924. <p>The instance.</p>
  925. </div>
  926. </section>
  927. </div>
  928. </li>
  929. <li class="item">
  930. <div>
  931. <code>
  932. <a name="/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF"></a>
  933. <a name="//apple_ref/swift/Method/cancel(byProducingResumeData:)" class="dashAnchor"></a>
  934. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:<wbr>)</a>
  935. </code>
  936. </div>
  937. <div class="height-container">
  938. <div class="pointer-container"></div>
  939. <section class="section">
  940. <div class="pointer"></div>
  941. <div class="abstract">
  942. <p>Cancels the instance while producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed
  943. or suspended.</p>
  944. <div class="aside aside-note">
  945. <p class="aside-title">Note</p>
  946. <p>The resume data passed to the completion handler will also be available on the instance&rsquo;s <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code>
  947. property.</p>
  948. </div>
  949. </div>
  950. <div class="declaration">
  951. <h4>Declaration</h4>
  952. <div class="language">
  953. <p class="aside-title">Swift</p>
  954. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  955. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">byProducingResumeData</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  956. </div>
  957. </div>
  958. <div>
  959. <h4>Parameters</h4>
  960. <table class="graybox">
  961. <tbody>
  962. <tr>
  963. <td>
  964. <code>
  965. <em>completionHandler</em>
  966. </code>
  967. </td>
  968. <td>
  969. <div>
  970. <p>The completion handler that is called when the download has been successfully
  971. cancelled. It is not guaranteed to be called on a particular queue, so you may
  972. want use an appropriate queue to perform your work.</p>
  973. </div>
  974. </td>
  975. </tr>
  976. </tbody>
  977. </table>
  978. </div>
  979. <div>
  980. <h4>Return Value</h4>
  981. <p>The instance.</p>
  982. </div>
  983. </section>
  984. </div>
  985. </li>
  986. <li class="item">
  987. <div>
  988. <code>
  989. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  990. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  991. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:<wbr>)</a>
  992. </code>
  993. </div>
  994. <div class="height-container">
  995. <div class="pointer-container"></div>
  996. <section class="section">
  997. <div class="pointer"></div>
  998. <div class="abstract">
  999. <p>Validates the request, using the specified closure.</p>
  1000. <div class="aside aside-note">
  1001. <p class="aside-title">Note</p>
  1002. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1003. </div>
  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 swift"><code><span class="kd">@discardableResult</span>
  1010. <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>
  1011. </div>
  1012. </div>
  1013. <div>
  1014. <h4>Parameters</h4>
  1015. <table class="graybox">
  1016. <tbody>
  1017. <tr>
  1018. <td>
  1019. <code>
  1020. <em>validation</em>
  1021. </code>
  1022. </td>
  1023. <td>
  1024. <div>
  1025. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></code> closure to validate the response.</p>
  1026. </div>
  1027. </td>
  1028. </tr>
  1029. </tbody>
  1030. </table>
  1031. </div>
  1032. <div>
  1033. <h4>Return Value</h4>
  1034. <p>The instance.</p>
  1035. </div>
  1036. </section>
  1037. </div>
  1038. </li>
  1039. </ul>
  1040. </div>
  1041. <div class="task-group">
  1042. <div class="task-name-container">
  1043. <a name="/DataRequest%20/%20UploadRequest"></a>
  1044. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  1045. <div class="section-name-container">
  1046. <a class="section-name-link" href="#/DataRequest%20/%20UploadRequest"></a>
  1047. <h3 class="section-name"><p>DataRequest / UploadRequest</p>
  1048. </h3>
  1049. </div>
  1050. </div>
  1051. <ul class="item-container">
  1052. <li class="item">
  1053. <div>
  1054. <code>
  1055. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF"></a>
  1056. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1057. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1058. </code>
  1059. </div>
  1060. <div class="height-container">
  1061. <div class="pointer-container"></div>
  1062. <section class="section">
  1063. <div class="pointer"></div>
  1064. <div class="abstract">
  1065. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance using the given <code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> and <code>DispatchQueue</code>.</p>
  1066. </div>
  1067. <div class="declaration">
  1068. <h4>Declaration</h4>
  1069. <div class="language">
  1070. <p class="aside-title">Swift</p>
  1071. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1072. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishResponse</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></span><span class="p">,</span> <span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span>
  1073. <span class="k">where</span> <span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span> <span class="o">==</span> <span class="kt">T</span></code></pre>
  1074. </div>
  1075. </div>
  1076. <div>
  1077. <h4>Parameters</h4>
  1078. <table class="graybox">
  1079. <tbody>
  1080. <tr>
  1081. <td>
  1082. <code>
  1083. <em>serializer</em>
  1084. </code>
  1085. </td>
  1086. <td>
  1087. <div>
  1088. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> used to serialize the response <code>Data</code> from disk.</p>
  1089. </div>
  1090. </td>
  1091. </tr>
  1092. <tr>
  1093. <td>
  1094. <code>
  1095. <em>queue</em>
  1096. </code>
  1097. </td>
  1098. <td>
  1099. <div>
  1100. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published.<code>.main</code> by default.</p>
  1101. </div>
  1102. </td>
  1103. </tr>
  1104. </tbody>
  1105. </table>
  1106. </div>
  1107. <div>
  1108. <h4>Return Value</h4>
  1109. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1110. </div>
  1111. </section>
  1112. </div>
  1113. </li>
  1114. <li class="item">
  1115. <div>
  1116. <code>
  1117. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF"></a>
  1118. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1119. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1120. </code>
  1121. </div>
  1122. <div class="height-container">
  1123. <div class="pointer-container"></div>
  1124. <section class="section">
  1125. <div class="pointer"></div>
  1126. <div class="abstract">
  1127. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance using the given <code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code> and
  1128. <code>DispatchQueue</code>.</p>
  1129. </div>
  1130. <div class="declaration">
  1131. <h4>Declaration</h4>
  1132. <div class="language">
  1133. <p class="aside-title">Swift</p>
  1134. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1135. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishResponse</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="p">,</span> <span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span>
  1136. <span class="k">where</span> <span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span> <span class="o">==</span> <span class="kt">T</span></code></pre>
  1137. </div>
  1138. </div>
  1139. <div>
  1140. <h4>Parameters</h4>
  1141. <table class="graybox">
  1142. <tbody>
  1143. <tr>
  1144. <td>
  1145. <code>
  1146. <em>serializer</em>
  1147. </code>
  1148. </td>
  1149. <td>
  1150. <div>
  1151. <p><code>DownloadResponseSerializer</code> used to serialize the response <code>Data</code> from disk.</p>
  1152. </div>
  1153. </td>
  1154. </tr>
  1155. <tr>
  1156. <td>
  1157. <code>
  1158. <em>queue</em>
  1159. </code>
  1160. </td>
  1161. <td>
  1162. <div>
  1163. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published.<code>.main</code> by default.</p>
  1164. </div>
  1165. </td>
  1166. </tr>
  1167. </tbody>
  1168. </table>
  1169. </div>
  1170. <div>
  1171. <h4>Return Value</h4>
  1172. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1173. </div>
  1174. </section>
  1175. </div>
  1176. </li>
  1177. <li class="item">
  1178. <div>
  1179. <code>
  1180. <a name="/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF"></a>
  1181. <a name="//apple_ref/swift/Method/publishData(queue:preprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1182. <a class="token" href="#/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF">publishData(queue:<wbr>preprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1183. </code>
  1184. </div>
  1185. <div class="height-container">
  1186. <div class="pointer-container"></div>
  1187. <section class="section">
  1188. <div class="pointer"></div>
  1189. <div class="abstract">
  1190. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to serialize the
  1191. response.</p>
  1192. </div>
  1193. <div class="declaration">
  1194. <h4>Declaration</h4>
  1195. <div class="language">
  1196. <p class="aside-title">Swift</p>
  1197. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1198. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishData</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1199. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1200. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1201. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  1202. </div>
  1203. </div>
  1204. <div>
  1205. <h4>Parameters</h4>
  1206. <table class="graybox">
  1207. <tbody>
  1208. <tr>
  1209. <td>
  1210. <code>
  1211. <em>queue</em>
  1212. </code>
  1213. </td>
  1214. <td>
  1215. <div>
  1216. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DataResponse.html">DataResponse</a></code> will be published. <code>.main</code> by default.</p>
  1217. </div>
  1218. </td>
  1219. </tr>
  1220. <tr>
  1221. <td>
  1222. <code>
  1223. <em>preprocessor</em>
  1224. </code>
  1225. </td>
  1226. <td>
  1227. <div>
  1228. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1229. by default.</p>
  1230. </div>
  1231. </td>
  1232. </tr>
  1233. <tr>
  1234. <td>
  1235. <code>
  1236. <em>emptyResponseCodes</em>
  1237. </code>
  1238. </td>
  1239. <td>
  1240. <div>
  1241. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1242. default.</p>
  1243. </div>
  1244. </td>
  1245. </tr>
  1246. <tr>
  1247. <td>
  1248. <code>
  1249. <em>emptyRequestMethods</em>
  1250. </code>
  1251. </td>
  1252. <td>
  1253. <div>
  1254. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1255. status code. <code>[.head]</code> by default.</p>
  1256. </div>
  1257. </td>
  1258. </tr>
  1259. </tbody>
  1260. </table>
  1261. </div>
  1262. <div>
  1263. <h4>Return Value</h4>
  1264. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1265. </div>
  1266. </section>
  1267. </div>
  1268. </li>
  1269. <li class="item">
  1270. <div>
  1271. <code>
  1272. <a name="/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1273. <a name="//apple_ref/swift/Method/publishString(queue:preprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1274. <a class="token" href="#/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">publishString(queue:<wbr>preprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1275. </code>
  1276. </div>
  1277. <div class="height-container">
  1278. <div class="pointer-container"></div>
  1279. <section class="section">
  1280. <div class="pointer"></div>
  1281. <div class="abstract">
  1282. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to serialize the
  1283. response.</p>
  1284. </div>
  1285. <div class="declaration">
  1286. <h4>Declaration</h4>
  1287. <div class="language">
  1288. <p class="aside-title">Swift</p>
  1289. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1290. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishString</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1291. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1292. <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>
  1293. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1294. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  1295. </div>
  1296. </div>
  1297. <div>
  1298. <h4>Parameters</h4>
  1299. <table class="graybox">
  1300. <tbody>
  1301. <tr>
  1302. <td>
  1303. <code>
  1304. <em>queue</em>
  1305. </code>
  1306. </td>
  1307. <td>
  1308. <div>
  1309. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DataResponse.html">DataResponse</a></code> will be published. <code>.main</code> by default.</p>
  1310. </div>
  1311. </td>
  1312. </tr>
  1313. <tr>
  1314. <td>
  1315. <code>
  1316. <em>preprocessor</em>
  1317. </code>
  1318. </td>
  1319. <td>
  1320. <div>
  1321. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1322. by default.</p>
  1323. </div>
  1324. </td>
  1325. </tr>
  1326. <tr>
  1327. <td>
  1328. <code>
  1329. <em>encoding</em>
  1330. </code>
  1331. </td>
  1332. <td>
  1333. <div>
  1334. <p><code>String.Encoding</code> to parse the response. <code>nil</code> by default, in which case the encoding
  1335. will be determined by the server response, falling back to the default HTTP character
  1336. set, <code>ISO-8859-1</code>.</p>
  1337. </div>
  1338. </td>
  1339. </tr>
  1340. <tr>
  1341. <td>
  1342. <code>
  1343. <em>emptyResponseCodes</em>
  1344. </code>
  1345. </td>
  1346. <td>
  1347. <div>
  1348. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1349. default.</p>
  1350. </div>
  1351. </td>
  1352. </tr>
  1353. <tr>
  1354. <td>
  1355. <code>
  1356. <em>emptyRequestMethods</em>
  1357. </code>
  1358. </td>
  1359. <td>
  1360. <div>
  1361. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1362. status code. <code>[.head]</code> by default.</p>
  1363. </div>
  1364. </td>
  1365. </tr>
  1366. </tbody>
  1367. </table>
  1368. </div>
  1369. <div>
  1370. <h4>Return Value</h4>
  1371. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1372. </div>
  1373. </section>
  1374. </div>
  1375. </li>
  1376. <li class="item">
  1377. <div>
  1378. <code>
  1379. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1380. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyResponseMethods:)" class="dashAnchor"></a>
  1381. <a class="token" href="#/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">publishDecodable(type:<wbr>queue:<wbr>preprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyResponseMethods:<wbr>)</a>
  1382. </code>
  1383. </div>
  1384. <div class="height-container">
  1385. <div class="pointer-container"></div>
  1386. <section class="section">
  1387. <div class="pointer"></div>
  1388. <div class="abstract">
  1389. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to serialize the
  1390. response.</p>
  1391. </div>
  1392. <div class="declaration">
  1393. <h4>Declaration</h4>
  1394. <div class="language">
  1395. <p class="aside-title">Swift</p>
  1396. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1397. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1398. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1399. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1400. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  1401. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1402. <span class="nv">emptyResponseMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  1403. </div>
  1404. </div>
  1405. <div>
  1406. <h4>Parameters</h4>
  1407. <table class="graybox">
  1408. <tbody>
  1409. <tr>
  1410. <td>
  1411. <code>
  1412. <em>type</em>
  1413. </code>
  1414. </td>
  1415. <td>
  1416. <div>
  1417. <p><code>Decodable</code> type to which to decode response <code>Data</code>. Inferred from the context by default.</p>
  1418. </div>
  1419. </td>
  1420. </tr>
  1421. <tr>
  1422. <td>
  1423. <code>
  1424. <em>queue</em>
  1425. </code>
  1426. </td>
  1427. <td>
  1428. <div>
  1429. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DataResponse.html">DataResponse</a></code> will be published. <code>.main</code> by default.</p>
  1430. </div>
  1431. </td>
  1432. </tr>
  1433. <tr>
  1434. <td>
  1435. <code>
  1436. <em>preprocessor</em>
  1437. </code>
  1438. </td>
  1439. <td>
  1440. <div>
  1441. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1442. by default.</p>
  1443. </div>
  1444. </td>
  1445. </tr>
  1446. <tr>
  1447. <td>
  1448. <code>
  1449. <em>decoder</em>
  1450. </code>
  1451. </td>
  1452. <td>
  1453. <div>
  1454. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode response <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1455. </div>
  1456. </td>
  1457. </tr>
  1458. <tr>
  1459. <td>
  1460. <code>
  1461. <em>emptyResponseCodes</em>
  1462. </code>
  1463. </td>
  1464. <td>
  1465. <div>
  1466. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1467. default.</p>
  1468. </div>
  1469. </td>
  1470. </tr>
  1471. <tr>
  1472. <td>
  1473. <code>
  1474. <em>emptyRequestMethods</em>
  1475. </code>
  1476. </td>
  1477. <td>
  1478. <div>
  1479. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1480. status code. <code>[.head]</code> by default.</p>
  1481. </div>
  1482. </td>
  1483. </tr>
  1484. </tbody>
  1485. </table>
  1486. </div>
  1487. <div>
  1488. <h4>Return Value</h4>
  1489. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1490. </div>
  1491. </section>
  1492. </div>
  1493. </li>
  1494. <li class="item">
  1495. <div>
  1496. <code>
  1497. <a name="/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF"></a>
  1498. <a name="//apple_ref/swift/Method/publishUnserialized(on:)" class="dashAnchor"></a>
  1499. <a class="token" href="#/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF">publishUnserialized(on:<wbr>)</a>
  1500. </code>
  1501. </div>
  1502. <div class="height-container">
  1503. <div class="pointer-container"></div>
  1504. <section class="section">
  1505. <div class="pointer"></div>
  1506. <div class="abstract">
  1507. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance which does not serialize the response before publishing.</p>
  1508. </div>
  1509. <div class="declaration">
  1510. <h4>Declaration</h4>
  1511. <div class="language">
  1512. <p class="aside-title">Swift</p>
  1513. <pre class="highlight swift"><code><span class="kd">@available(OSX 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1514. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishUnserialized</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="p">?</span><span class="o">&gt;</span></code></pre>
  1515. </div>
  1516. </div>
  1517. <div>
  1518. <h4>Parameters</h4>
  1519. <table class="graybox">
  1520. <tbody>
  1521. <tr>
  1522. <td>
  1523. <code>
  1524. <em>queue</em>
  1525. </code>
  1526. </td>
  1527. <td>
  1528. <div>
  1529. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published. <code>.main</code> by default.</p>
  1530. </div>
  1531. </td>
  1532. </tr>
  1533. </tbody>
  1534. </table>
  1535. </div>
  1536. <div>
  1537. <h4>Return Value</h4>
  1538. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1539. </div>
  1540. </section>
  1541. </div>
  1542. </li>
  1543. </ul>
  1544. </div>
  1545. <div class="task-group">
  1546. <div class="task-name-container">
  1547. <a name="/Default"></a>
  1548. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  1549. <div class="section-name-container">
  1550. <a class="section-name-link" href="#/Default"></a>
  1551. <h3 class="section-name"><p>Default</p>
  1552. </h3>
  1553. </div>
  1554. </div>
  1555. <ul class="item-container">
  1556. <li class="item">
  1557. <div>
  1558. <code>
  1559. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF"></a>
  1560. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  1561. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF">response(queue:<wbr>completionHandler:<wbr>)</a>
  1562. </code>
  1563. </div>
  1564. <div class="height-container">
  1565. <div class="pointer-container"></div>
  1566. <section class="section">
  1567. <div class="pointer"></div>
  1568. <div class="abstract">
  1569. <p>Adds a handler to be called once the request has finished.</p>
  1570. </div>
  1571. <div class="declaration">
  1572. <h4>Declaration</h4>
  1573. <div class="language">
  1574. <p class="aside-title">Swift</p>
  1575. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1576. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1577. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="p">?</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1578. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1579. </div>
  1580. </div>
  1581. <div>
  1582. <h4>Parameters</h4>
  1583. <table class="graybox">
  1584. <tbody>
  1585. <tr>
  1586. <td>
  1587. <code>
  1588. <em>queue</em>
  1589. </code>
  1590. </td>
  1591. <td>
  1592. <div>
  1593. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1594. </div>
  1595. </td>
  1596. </tr>
  1597. <tr>
  1598. <td>
  1599. <code>
  1600. <em>completionHandler</em>
  1601. </code>
  1602. </td>
  1603. <td>
  1604. <div>
  1605. <p>The code to be executed once the request has finished.</p>
  1606. </div>
  1607. </td>
  1608. </tr>
  1609. </tbody>
  1610. </table>
  1611. </div>
  1612. <div>
  1613. <h4>Return Value</h4>
  1614. <p>The request.</p>
  1615. </div>
  1616. </section>
  1617. </div>
  1618. </li>
  1619. <li class="item">
  1620. <div>
  1621. <code>
  1622. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  1623. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  1624. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  1625. </code>
  1626. </div>
  1627. <div class="height-container">
  1628. <div class="pointer-container"></div>
  1629. <section class="section">
  1630. <div class="pointer"></div>
  1631. <div class="abstract">
  1632. <p>Adds a handler to be called once the request has finished.</p>
  1633. </div>
  1634. <div class="declaration">
  1635. <h4>Declaration</h4>
  1636. <div class="language">
  1637. <p class="aside-title">Swift</p>
  1638. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1639. <span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="o">&gt;</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1640. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  1641. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1642. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1643. </div>
  1644. </div>
  1645. <div>
  1646. <h4>Parameters</h4>
  1647. <table class="graybox">
  1648. <tbody>
  1649. <tr>
  1650. <td>
  1651. <code>
  1652. <em>queue</em>
  1653. </code>
  1654. </td>
  1655. <td>
  1656. <div>
  1657. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1658. </div>
  1659. </td>
  1660. </tr>
  1661. <tr>
  1662. <td>
  1663. <code>
  1664. <em>responseSerializer</em>
  1665. </code>
  1666. </td>
  1667. <td>
  1668. <div>
  1669. <p>The response serializer responsible for serializing the request, response, and data
  1670. contained in the destination <code>URL</code>.</p>
  1671. </div>
  1672. </td>
  1673. </tr>
  1674. <tr>
  1675. <td>
  1676. <code>
  1677. <em>completionHandler</em>
  1678. </code>
  1679. </td>
  1680. <td>
  1681. <div>
  1682. <p>The code to be executed once the request has finished.</p>
  1683. </div>
  1684. </td>
  1685. </tr>
  1686. </tbody>
  1687. </table>
  1688. </div>
  1689. <div>
  1690. <h4>Return Value</h4>
  1691. <p>The request.</p>
  1692. </div>
  1693. </section>
  1694. </div>
  1695. </li>
  1696. </ul>
  1697. </div>
  1698. <div class="task-group">
  1699. <div class="task-name-container">
  1700. <a name="/Data"></a>
  1701. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1702. <div class="section-name-container">
  1703. <a class="section-name-link" href="#/Data"></a>
  1704. <h3 class="section-name"><p>Data</p>
  1705. </h3>
  1706. </div>
  1707. </div>
  1708. <ul class="item-container">
  1709. <li class="item">
  1710. <div>
  1711. <code>
  1712. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF"></a>
  1713. <a name="//apple_ref/swift/Method/responseData(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1714. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF">responseData(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1715. </code>
  1716. </div>
  1717. <div class="height-container">
  1718. <div class="pointer-container"></div>
  1719. <section class="section">
  1720. <div class="pointer"></div>
  1721. <div class="abstract">
  1722. <p>Adds a handler using a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to be called once the request has finished.</p>
  1723. </div>
  1724. <div class="declaration">
  1725. <h4>Declaration</h4>
  1726. <div class="language">
  1727. <p class="aside-title">Swift</p>
  1728. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1729. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1730. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1731. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1732. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  1733. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1734. </div>
  1735. </div>
  1736. <div>
  1737. <h4>Parameters</h4>
  1738. <table class="graybox">
  1739. <tbody>
  1740. <tr>
  1741. <td>
  1742. <code>
  1743. <em>queue</em>
  1744. </code>
  1745. </td>
  1746. <td>
  1747. <div>
  1748. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  1749. </div>
  1750. </td>
  1751. </tr>
  1752. <tr>
  1753. <td>
  1754. <code>
  1755. <em>dataPreprocessor</em>
  1756. </code>
  1757. </td>
  1758. <td>
  1759. <div>
  1760. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1761. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1762. </div>
  1763. </td>
  1764. </tr>
  1765. <tr>
  1766. <td>
  1767. <code>
  1768. <em>emptyResponseCodes</em>
  1769. </code>
  1770. </td>
  1771. <td>
  1772. <div>
  1773. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1774. </div>
  1775. </td>
  1776. </tr>
  1777. <tr>
  1778. <td>
  1779. <code>
  1780. <em>emptyRequestMethods</em>
  1781. </code>
  1782. </td>
  1783. <td>
  1784. <div>
  1785. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1786. </div>
  1787. </td>
  1788. </tr>
  1789. <tr>
  1790. <td>
  1791. <code>
  1792. <em>completionHandler</em>
  1793. </code>
  1794. </td>
  1795. <td>
  1796. <div>
  1797. <p>A closure to be executed once the request has finished.</p>
  1798. </div>
  1799. </td>
  1800. </tr>
  1801. </tbody>
  1802. </table>
  1803. </div>
  1804. <div>
  1805. <h4>Return Value</h4>
  1806. <p>The request.</p>
  1807. </div>
  1808. </section>
  1809. </div>
  1810. </li>
  1811. </ul>
  1812. </div>
  1813. <div class="task-group">
  1814. <div class="task-name-container">
  1815. <a name="/String"></a>
  1816. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  1817. <div class="section-name-container">
  1818. <a class="section-name-link" href="#/String"></a>
  1819. <h3 class="section-name"><p>String</p>
  1820. </h3>
  1821. </div>
  1822. </div>
  1823. <ul class="item-container">
  1824. <li class="item">
  1825. <div>
  1826. <code>
  1827. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF"></a>
  1828. <a name="//apple_ref/swift/Method/responseString(queue:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1829. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF">responseString(queue:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1830. </code>
  1831. </div>
  1832. <div class="height-container">
  1833. <div class="pointer-container"></div>
  1834. <section class="section">
  1835. <div class="pointer"></div>
  1836. <div class="abstract">
  1837. <p>Adds a handler using a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to be called once the request has finished.</p>
  1838. </div>
  1839. <div class="declaration">
  1840. <h4>Declaration</h4>
  1841. <div class="language">
  1842. <p class="aside-title">Swift</p>
  1843. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1844. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1845. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1846. <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>
  1847. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1848. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  1849. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1850. </div>
  1851. </div>
  1852. <div>
  1853. <h4>Parameters</h4>
  1854. <table class="graybox">
  1855. <tbody>
  1856. <tr>
  1857. <td>
  1858. <code>
  1859. <em>queue</em>
  1860. </code>
  1861. </td>
  1862. <td>
  1863. <div>
  1864. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1865. </div>
  1866. </td>
  1867. </tr>
  1868. <tr>
  1869. <td>
  1870. <code>
  1871. <em>dataPreprocessor</em>
  1872. </code>
  1873. </td>
  1874. <td>
  1875. <div>
  1876. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1877. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1878. </div>
  1879. </td>
  1880. </tr>
  1881. <tr>
  1882. <td>
  1883. <code>
  1884. <em>encoding</em>
  1885. </code>
  1886. </td>
  1887. <td>
  1888. <div>
  1889. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  1890. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1891. </div>
  1892. </td>
  1893. </tr>
  1894. <tr>
  1895. <td>
  1896. <code>
  1897. <em>emptyResponseCodes</em>
  1898. </code>
  1899. </td>
  1900. <td>
  1901. <div>
  1902. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1903. </div>
  1904. </td>
  1905. </tr>
  1906. <tr>
  1907. <td>
  1908. <code>
  1909. <em>emptyRequestMethods</em>
  1910. </code>
  1911. </td>
  1912. <td>
  1913. <div>
  1914. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1915. </div>
  1916. </td>
  1917. </tr>
  1918. <tr>
  1919. <td>
  1920. <code>
  1921. <em>completionHandler</em>
  1922. </code>
  1923. </td>
  1924. <td>
  1925. <div>
  1926. <p>A closure to be executed once the request has finished.</p>
  1927. </div>
  1928. </td>
  1929. </tr>
  1930. </tbody>
  1931. </table>
  1932. </div>
  1933. <div>
  1934. <h4>Return Value</h4>
  1935. <p>The request.</p>
  1936. </div>
  1937. </section>
  1938. </div>
  1939. </li>
  1940. </ul>
  1941. </div>
  1942. <div class="task-group">
  1943. <div class="task-name-container">
  1944. <a name="/JSON"></a>
  1945. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1946. <div class="section-name-container">
  1947. <a class="section-name-link" href="#/JSON"></a>
  1948. <h3 class="section-name"><p>JSON</p>
  1949. </h3>
  1950. </div>
  1951. </div>
  1952. <ul class="item-container">
  1953. <li class="item">
  1954. <div>
  1955. <code>
  1956. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF"></a>
  1957. <a name="//apple_ref/swift/Method/responseJSON(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:options:completionHandler:)" class="dashAnchor"></a>
  1958. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF">responseJSON(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>options:<wbr>completionHandler:<wbr>)</a>
  1959. </code>
  1960. </div>
  1961. <div class="height-container">
  1962. <div class="pointer-container"></div>
  1963. <section class="section">
  1964. <div class="pointer"></div>
  1965. <div class="abstract">
  1966. <p>Adds a handler using a <code><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></code> to be called once the request has finished.</p>
  1967. </div>
  1968. <div class="declaration">
  1969. <h4>Declaration</h4>
  1970. <div class="language">
  1971. <p class="aside-title">Swift</p>
  1972. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1973. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1974. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1975. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1976. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  1977. <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>
  1978. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1979. </div>
  1980. </div>
  1981. <div>
  1982. <h4>Parameters</h4>
  1983. <table class="graybox">
  1984. <tbody>
  1985. <tr>
  1986. <td>
  1987. <code>
  1988. <em>queue</em>
  1989. </code>
  1990. </td>
  1991. <td>
  1992. <div>
  1993. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1994. </div>
  1995. </td>
  1996. </tr>
  1997. <tr>
  1998. <td>
  1999. <code>
  2000. <em>dataPreprocessor</em>
  2001. </code>
  2002. </td>
  2003. <td>
  2004. <div>
  2005. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2006. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2007. </div>
  2008. </td>
  2009. </tr>
  2010. <tr>
  2011. <td>
  2012. <code>
  2013. <em>encoding</em>
  2014. </code>
  2015. </td>
  2016. <td>
  2017. <div>
  2018. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2019. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2020. </div>
  2021. </td>
  2022. </tr>
  2023. <tr>
  2024. <td>
  2025. <code>
  2026. <em>emptyResponseCodes</em>
  2027. </code>
  2028. </td>
  2029. <td>
  2030. <div>
  2031. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2032. </div>
  2033. </td>
  2034. </tr>
  2035. <tr>
  2036. <td>
  2037. <code>
  2038. <em>emptyRequestMethods</em>
  2039. </code>
  2040. </td>
  2041. <td>
  2042. <div>
  2043. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2044. </div>
  2045. </td>
  2046. </tr>
  2047. <tr>
  2048. <td>
  2049. <code>
  2050. <em>options</em>
  2051. </code>
  2052. </td>
  2053. <td>
  2054. <div>
  2055. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2056. by default.</p>
  2057. </div>
  2058. </td>
  2059. </tr>
  2060. <tr>
  2061. <td>
  2062. <code>
  2063. <em>completionHandler</em>
  2064. </code>
  2065. </td>
  2066. <td>
  2067. <div>
  2068. <p>A closure to be executed once the request has finished.</p>
  2069. </div>
  2070. </td>
  2071. </tr>
  2072. </tbody>
  2073. </table>
  2074. </div>
  2075. <div>
  2076. <h4>Return Value</h4>
  2077. <p>The request.</p>
  2078. </div>
  2079. </section>
  2080. </div>
  2081. </li>
  2082. </ul>
  2083. </div>
  2084. <div class="task-group">
  2085. <div class="task-name-container">
  2086. <a name="/Decodable"></a>
  2087. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  2088. <div class="section-name-container">
  2089. <a class="section-name-link" href="#/Decodable"></a>
  2090. <h3 class="section-name"><p>Decodable</p>
  2091. </h3>
  2092. </div>
  2093. </div>
  2094. <ul class="item-container">
  2095. <li class="item">
  2096. <div>
  2097. <code>
  2098. <a name="/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF"></a>
  2099. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2100. <a class="token" href="#/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF">responseDecodable(of:<wbr>queue:<wbr>dataPreprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2101. </code>
  2102. </div>
  2103. <div class="height-container">
  2104. <div class="pointer-container"></div>
  2105. <section class="section">
  2106. <div class="pointer"></div>
  2107. <div class="abstract">
  2108. <p>Adds a handler using a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to be called once the request has finished.</p>
  2109. </div>
  2110. <div class="declaration">
  2111. <h4>Declaration</h4>
  2112. <div class="language">
  2113. <p class="aside-title">Swift</p>
  2114. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2115. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">of</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  2116. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  2117. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  2118. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  2119. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  2120. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  2121. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2122. </div>
  2123. </div>
  2124. <div>
  2125. <h4>Parameters</h4>
  2126. <table class="graybox">
  2127. <tbody>
  2128. <tr>
  2129. <td>
  2130. <code>
  2131. <em>type</em>
  2132. </code>
  2133. </td>
  2134. <td>
  2135. <div>
  2136. <p><code>Decodable</code> type to decode from response data.</p>
  2137. </div>
  2138. </td>
  2139. </tr>
  2140. <tr>
  2141. <td>
  2142. <code>
  2143. <em>queue</em>
  2144. </code>
  2145. </td>
  2146. <td>
  2147. <div>
  2148. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2149. </div>
  2150. </td>
  2151. </tr>
  2152. <tr>
  2153. <td>
  2154. <code>
  2155. <em>dataPreprocessor</em>
  2156. </code>
  2157. </td>
  2158. <td>
  2159. <div>
  2160. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2161. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2162. </div>
  2163. </td>
  2164. </tr>
  2165. <tr>
  2166. <td>
  2167. <code>
  2168. <em>decoder</em>
  2169. </code>
  2170. </td>
  2171. <td>
  2172. <div>
  2173. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  2174. </div>
  2175. </td>
  2176. </tr>
  2177. <tr>
  2178. <td>
  2179. <code>
  2180. <em>encoding</em>
  2181. </code>
  2182. </td>
  2183. <td>
  2184. <div>
  2185. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2186. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2187. </div>
  2188. </td>
  2189. </tr>
  2190. <tr>
  2191. <td>
  2192. <code>
  2193. <em>emptyResponseCodes</em>
  2194. </code>
  2195. </td>
  2196. <td>
  2197. <div>
  2198. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2199. </div>
  2200. </td>
  2201. </tr>
  2202. <tr>
  2203. <td>
  2204. <code>
  2205. <em>emptyRequestMethods</em>
  2206. </code>
  2207. </td>
  2208. <td>
  2209. <div>
  2210. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2211. </div>
  2212. </td>
  2213. </tr>
  2214. <tr>
  2215. <td>
  2216. <code>
  2217. <em>options</em>
  2218. </code>
  2219. </td>
  2220. <td>
  2221. <div>
  2222. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2223. by default.</p>
  2224. </div>
  2225. </td>
  2226. </tr>
  2227. <tr>
  2228. <td>
  2229. <code>
  2230. <em>completionHandler</em>
  2231. </code>
  2232. </td>
  2233. <td>
  2234. <div>
  2235. <p>A closure to be executed once the request has finished.</p>
  2236. </div>
  2237. </td>
  2238. </tr>
  2239. </tbody>
  2240. </table>
  2241. </div>
  2242. <div>
  2243. <h4>Return Value</h4>
  2244. <p>The request.</p>
  2245. </div>
  2246. </section>
  2247. </div>
  2248. </li>
  2249. </ul>
  2250. </div>
  2251. <div class="task-group">
  2252. <ul class="item-container">
  2253. <li class="item">
  2254. <div>
  2255. <code>
  2256. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  2257. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  2258. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  2259. </code>
  2260. </div>
  2261. <div class="height-container">
  2262. <div class="pointer-container"></div>
  2263. <section class="section">
  2264. <div class="pointer"></div>
  2265. <div class="abstract">
  2266. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  2267. destination URL, and returns whether the request was valid.</p>
  2268. </div>
  2269. <div class="declaration">
  2270. <h4>Declaration</h4>
  2271. <div class="language">
  2272. <p class="aside-title">Swift</p>
  2273. <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>
  2274. <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span>
  2275. <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span>
  2276. <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  2277. </div>
  2278. </div>
  2279. </section>
  2280. </div>
  2281. </li>
  2282. <li class="item">
  2283. <div>
  2284. <code>
  2285. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  2286. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  2287. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  2288. </code>
  2289. </div>
  2290. <div class="height-container">
  2291. <div class="pointer-container"></div>
  2292. <section class="section">
  2293. <div class="pointer"></div>
  2294. <div class="abstract">
  2295. <p>Validates that the response has a status code in the specified sequence.</p>
  2296. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2297. </div>
  2298. <div class="declaration">
  2299. <h4>Declaration</h4>
  2300. <div class="language">
  2301. <p class="aside-title">Swift</p>
  2302. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2303. <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>
  2304. </div>
  2305. </div>
  2306. <div>
  2307. <h4>Parameters</h4>
  2308. <table class="graybox">
  2309. <tbody>
  2310. <tr>
  2311. <td>
  2312. <code>
  2313. <em>statusCode</em>
  2314. </code>
  2315. </td>
  2316. <td>
  2317. <div>
  2318. <p><code>Sequence</code> of acceptable response status codes.</p>
  2319. </div>
  2320. </td>
  2321. </tr>
  2322. </tbody>
  2323. </table>
  2324. </div>
  2325. <div>
  2326. <h4>Return Value</h4>
  2327. <p>The instance.</p>
  2328. </div>
  2329. </section>
  2330. </div>
  2331. </li>
  2332. <li class="item">
  2333. <div>
  2334. <code>
  2335. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  2336. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  2337. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  2338. </code>
  2339. </div>
  2340. <div class="height-container">
  2341. <div class="pointer-container"></div>
  2342. <section class="section">
  2343. <div class="pointer"></div>
  2344. <div class="abstract">
  2345. <p>Validates that the response has a content type in the specified sequence.</p>
  2346. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2347. </div>
  2348. <div class="declaration">
  2349. <h4>Declaration</h4>
  2350. <div class="language">
  2351. <p class="aside-title">Swift</p>
  2352. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2353. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  2354. </div>
  2355. </div>
  2356. <div>
  2357. <h4>Parameters</h4>
  2358. <table class="graybox">
  2359. <tbody>
  2360. <tr>
  2361. <td>
  2362. <code>
  2363. <em>contentType</em>
  2364. </code>
  2365. </td>
  2366. <td>
  2367. <div>
  2368. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  2369. </div>
  2370. </td>
  2371. </tr>
  2372. </tbody>
  2373. </table>
  2374. </div>
  2375. <div>
  2376. <h4>Return Value</h4>
  2377. <p>The request.</p>
  2378. </div>
  2379. </section>
  2380. </div>
  2381. </li>
  2382. <li class="item">
  2383. <div>
  2384. <code>
  2385. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  2386. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  2387. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  2388. </code>
  2389. </div>
  2390. <div class="height-container">
  2391. <div class="pointer-container"></div>
  2392. <section class="section">
  2393. <div class="pointer"></div>
  2394. <div class="abstract">
  2395. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  2396. type matches any specified in the Accept HTTP header field.</p>
  2397. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2398. </div>
  2399. <div class="declaration">
  2400. <h4>Declaration</h4>
  2401. <div class="language">
  2402. <p class="aside-title">Swift</p>
  2403. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2404. <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>
  2405. </div>
  2406. </div>
  2407. <div>
  2408. <h4>Return Value</h4>
  2409. <p>The request.</p>
  2410. </div>
  2411. </section>
  2412. </div>
  2413. </li>
  2414. </ul>
  2415. </div>
  2416. </div>
  2417. </section>
  2418. </article>
  2419. </div>
  2420. <section class="footer">
  2421. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-05-25)</p>
  2422. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  2423. </section>
  2424. </body>
  2425. </div>
  2426. </html>