DownloadRequest.html 203 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260
  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.6.4 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  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" alt=""/>
  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/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  310. </li>
  311. </ul>
  312. </li>
  313. <li class="nav-group-name">
  314. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  315. <ul class="nav-group-tasks">
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  387. </li>
  388. </ul>
  389. </li>
  390. <li class="nav-group-name">
  391. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  392. <ul class="nav-group-tasks">
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  488. </li>
  489. </ul>
  490. </li>
  491. <li class="nav-group-name">
  492. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  493. <ul class="nav-group-tasks">
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  514. </li>
  515. </ul>
  516. </li>
  517. </ul>
  518. </nav>
  519. <article class="main-content">
  520. <section class="section">
  521. <div class="section-content top-matter">
  522. <h1>DownloadRequest</h1>
  523. <div class="declaration">
  524. <div class="language">
  525. <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>
  526. </div>
  527. </div>
  528. <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>
  529. </div>
  530. </section>
  531. <section class="section">
  532. <div class="section-content">
  533. <div class="task-group">
  534. <ul class="item-container">
  535. <li class="item">
  536. <div>
  537. <code>
  538. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  539. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  540. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  541. </code>
  542. </div>
  543. <div class="height-container">
  544. <div class="pointer-container"></div>
  545. <section class="section">
  546. <div class="pointer"></div>
  547. <div class="abstract">
  548. <p>A set of options to be executed prior to moving a downloaded file from the temporary <code>URL</code> to the destination
  549. <code>URL</code>.</p>
  550. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  551. </div>
  552. <div class="declaration">
  553. <h4>Declaration</h4>
  554. <div class="language">
  555. <p class="aside-title">Swift</p>
  556. <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>
  557. </div>
  558. </div>
  559. </section>
  560. </div>
  561. </li>
  562. </ul>
  563. </div>
  564. <div class="task-group">
  565. <div class="task-name-container">
  566. <a name="/Destination"></a>
  567. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  568. <div class="section-name-container">
  569. <a class="section-name-link" href="#/Destination"></a>
  570. <h3 class="section-name"><span>Destination</span>
  571. </h3>
  572. </div>
  573. </div>
  574. <ul class="item-container">
  575. <li class="item">
  576. <div>
  577. <code>
  578. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  579. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  580. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  581. </code>
  582. </div>
  583. <div class="height-container">
  584. <div class="pointer-container"></div>
  585. <section class="section">
  586. <div class="pointer"></div>
  587. <div class="abstract">
  588. <p>A closure executed once a <code>DownloadRequest</code> has successfully completed in order to determine where to move the
  589. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  590. and the <code>HTTPURLResponse</code>, and returns two values: the file URL where the temporary file should be moved and
  591. the options defining how the file should be moved.</p>
  592. <div class="aside aside-note">
  593. <p class="aside-title">Note</p>
  594. Downloads from a local <code>file://</code> <code>URL</code>s do not use the <code>Destination</code> closure, as those downloads do not
  595. return an <code>HTTPURLResponse</code>. Instead the file is merely moved within the temporary directory.
  596. </div>
  597. </div>
  598. <div class="declaration">
  599. <h4>Declaration</h4>
  600. <div class="language">
  601. <p class="aside-title">Swift</p>
  602. <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>
  603. <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>
  604. </div>
  605. </div>
  606. </section>
  607. </div>
  608. </li>
  609. <li class="item">
  610. <div>
  611. <code>
  612. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  613. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  614. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:<wbr>in:<wbr>options:<wbr>)</a>
  615. </code>
  616. </div>
  617. <div class="height-container">
  618. <div class="pointer-container"></div>
  619. <section class="section">
  620. <div class="pointer"></div>
  621. <div class="abstract">
  622. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  623. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  624. </div>
  625. <div class="declaration">
  626. <h4>Declaration</h4>
  627. <div class="language">
  628. <p class="aside-title">Swift</p>
  629. <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>
  630. <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>
  631. <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>
  632. </div>
  633. </div>
  634. <div>
  635. <h4>Parameters</h4>
  636. <table class="graybox">
  637. <tbody>
  638. <tr>
  639. <td>
  640. <code>
  641. <em>directory</em>
  642. </code>
  643. </td>
  644. <td>
  645. <div>
  646. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  647. </div>
  648. </td>
  649. </tr>
  650. <tr>
  651. <td>
  652. <code>
  653. <em>domain</em>
  654. </code>
  655. </td>
  656. <td>
  657. <div>
  658. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  659. </div>
  660. </td>
  661. </tr>
  662. <tr>
  663. <td>
  664. <code>
  665. <em>options</em>
  666. </code>
  667. </td>
  668. <td>
  669. <div>
  670. <p><code><a href="../Classes/DownloadRequest/Options.html">DownloadRequest.Options</a></code> used when moving the downloaded file to its destination. None by
  671. default.</p>
  672. </div>
  673. </td>
  674. </tr>
  675. </tbody>
  676. </table>
  677. </div>
  678. <div>
  679. <h4>Return Value</h4>
  680. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></code> closure.</p>
  681. </div>
  682. </section>
  683. </div>
  684. </li>
  685. </ul>
  686. </div>
  687. <div class="task-group">
  688. <div class="task-name-container">
  689. <a name="/Downloadable"></a>
  690. <a name="//apple_ref/swift/Section/Downloadable" class="dashAnchor"></a>
  691. <div class="section-name-container">
  692. <a class="section-name-link" href="#/Downloadable"></a>
  693. <h3 class="section-name"><span>Downloadable</span>
  694. </h3>
  695. </div>
  696. </div>
  697. <ul class="item-container">
  698. <li class="item">
  699. <div>
  700. <code>
  701. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  702. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  703. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  704. </code>
  705. </div>
  706. <div class="height-container">
  707. <div class="pointer-container"></div>
  708. <section class="section">
  709. <div class="pointer"></div>
  710. <div class="abstract">
  711. <p>Type describing the source used to create the underlying <code>URLSessionDownloadTask</code>.</p>
  712. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  713. </div>
  714. <div class="declaration">
  715. <h4>Declaration</h4>
  716. <div class="language">
  717. <p class="aside-title">Swift</p>
  718. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  719. </div>
  720. </div>
  721. </section>
  722. </div>
  723. </li>
  724. </ul>
  725. </div>
  726. <div class="task-group">
  727. <div class="task-name-container">
  728. <a name="/Mutable%20State"></a>
  729. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  730. <div class="section-name-container">
  731. <a class="section-name-link" href="#/Mutable%20State"></a>
  732. <h3 class="section-name"><span>Mutable State</span>
  733. </h3>
  734. </div>
  735. </div>
  736. <ul class="item-container">
  737. <li class="item">
  738. <div>
  739. <code>
  740. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  741. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  742. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  743. </code>
  744. </div>
  745. <div class="height-container">
  746. <div class="pointer-container"></div>
  747. <section class="section">
  748. <div class="pointer"></div>
  749. <div class="abstract">
  750. <p>If the download is resumable and is eventually cancelled or fails, this value may be used to resume the download
  751. using the <code>download(resumingWith data:)</code> API.</p>
  752. <div class="aside aside-note">
  753. <p class="aside-title">Note</p>
  754. For more information about <code>resumeData</code>, see <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>.
  755. </div>
  756. </div>
  757. <div class="declaration">
  758. <h4>Declaration</h4>
  759. <div class="language">
  760. <p class="aside-title">Swift</p>
  761. <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>
  762. </div>
  763. </div>
  764. </section>
  765. </div>
  766. </li>
  767. <li class="item">
  768. <div>
  769. <code>
  770. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  771. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  772. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  773. </code>
  774. </div>
  775. <div class="height-container">
  776. <div class="pointer-container"></div>
  777. <section class="section">
  778. <div class="pointer"></div>
  779. <div class="abstract">
  780. <p>If the download is successful, the <code>URL</code> where the file was downloaded.</p>
  781. </div>
  782. <div class="declaration">
  783. <h4>Declaration</h4>
  784. <div class="language">
  785. <p class="aside-title">Swift</p>
  786. <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>
  787. </div>
  788. </div>
  789. </section>
  790. </div>
  791. </li>
  792. </ul>
  793. </div>
  794. <div class="task-group">
  795. <div class="task-name-container">
  796. <a name="/Initial%20State"></a>
  797. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  798. <div class="section-name-container">
  799. <a class="section-name-link" href="#/Initial%20State"></a>
  800. <h3 class="section-name"><span>Initial State</span>
  801. </h3>
  802. </div>
  803. </div>
  804. <ul class="item-container">
  805. <li class="item">
  806. <div>
  807. <code>
  808. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  809. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  810. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  811. </code>
  812. </div>
  813. <div class="height-container">
  814. <div class="pointer-container"></div>
  815. <section class="section">
  816. <div class="pointer"></div>
  817. <div class="abstract">
  818. <p><code><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></code> value used for this instance.</p>
  819. </div>
  820. <div class="declaration">
  821. <h4>Declaration</h4>
  822. <div class="language">
  823. <p class="aside-title">Swift</p>
  824. <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>
  825. </div>
  826. </div>
  827. </section>
  828. </div>
  829. </li>
  830. <li class="item">
  831. <div>
  832. <code>
  833. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  834. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  835. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:<wbr>using:<wbr>)</a>
  836. </code>
  837. </div>
  838. <div class="height-container">
  839. <div class="pointer-container"></div>
  840. <section class="section">
  841. <div class="pointer"></div>
  842. <div class="abstract">
  843. <p>Creates a <code>URLSessionTask</code> from the provided resume data.</p>
  844. </div>
  845. <div class="declaration">
  846. <h4>Declaration</h4>
  847. <div class="language">
  848. <p class="aside-title">Swift</p>
  849. <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>
  850. </div>
  851. </div>
  852. <div>
  853. <h4>Parameters</h4>
  854. <table class="graybox">
  855. <tbody>
  856. <tr>
  857. <td>
  858. <code>
  859. <em>data</em>
  860. </code>
  861. </td>
  862. <td>
  863. <div>
  864. <p><code>Data</code> used to resume the download.</p>
  865. </div>
  866. </td>
  867. </tr>
  868. <tr>
  869. <td>
  870. <code>
  871. <em>session</em>
  872. </code>
  873. </td>
  874. <td>
  875. <div>
  876. <p><code>URLSession</code> used to create the <code>URLSessionTask</code>.</p>
  877. </div>
  878. </td>
  879. </tr>
  880. </tbody>
  881. </table>
  882. </div>
  883. <div>
  884. <h4>Return Value</h4>
  885. <p>The <code>URLSessionTask</code> created.</p>
  886. </div>
  887. </section>
  888. </div>
  889. </li>
  890. <li class="item">
  891. <div>
  892. <code>
  893. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  894. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  895. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  896. </code>
  897. </div>
  898. <div class="height-container">
  899. <div class="pointer-container"></div>
  900. <section class="section">
  901. <div class="pointer"></div>
  902. <div class="abstract">
  903. <p>Cancels the instance. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed or suspended.</p>
  904. <div class="aside aside-note">
  905. <p class="aside-title">Note</p>
  906. <p>This method will NOT produce resume data. If you wish to cancel and produce resume data, use
  907. <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>
  908. </div>
  909. </div>
  910. <div class="declaration">
  911. <h4>Declaration</h4>
  912. <div class="language">
  913. <p class="aside-title">Swift</p>
  914. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  915. <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>
  916. </div>
  917. </div>
  918. <div>
  919. <h4>Return Value</h4>
  920. <p>The instance.</p>
  921. </div>
  922. </section>
  923. </div>
  924. </li>
  925. <li class="item">
  926. <div>
  927. <code>
  928. <a name="/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF"></a>
  929. <a name="//apple_ref/swift/Method/cancel(producingResumeData:)" class="dashAnchor"></a>
  930. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:<wbr>)</a>
  931. </code>
  932. </div>
  933. <div class="height-container">
  934. <div class="pointer-container"></div>
  935. <section class="section">
  936. <div class="pointer"></div>
  937. <div class="abstract">
  938. <p>Cancels the instance, optionally producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be
  939. resumed or suspended.</p>
  940. <div class="aside aside-note">
  941. <p class="aside-title">Note</p>
  942. <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
  943. available.</p>
  944. </div>
  945. </div>
  946. <div class="declaration">
  947. <h4>Declaration</h4>
  948. <div class="language">
  949. <p class="aside-title">Swift</p>
  950. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  951. <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>
  952. </div>
  953. </div>
  954. <div>
  955. <h4>Return Value</h4>
  956. <p>The instance.</p>
  957. </div>
  958. </section>
  959. </div>
  960. </li>
  961. <li class="item">
  962. <div>
  963. <code>
  964. <a name="/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF"></a>
  965. <a name="//apple_ref/swift/Method/cancel(byProducingResumeData:)" class="dashAnchor"></a>
  966. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:<wbr>)</a>
  967. </code>
  968. </div>
  969. <div class="height-container">
  970. <div class="pointer-container"></div>
  971. <section class="section">
  972. <div class="pointer"></div>
  973. <div class="abstract">
  974. <p>Cancels the instance while producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed
  975. or suspended.</p>
  976. <div class="aside aside-note">
  977. <p class="aside-title">Note</p>
  978. <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>
  979. property.</p>
  980. </div>
  981. </div>
  982. <div class="declaration">
  983. <h4>Declaration</h4>
  984. <div class="language">
  985. <p class="aside-title">Swift</p>
  986. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  987. <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>
  988. </div>
  989. </div>
  990. <div>
  991. <h4>Parameters</h4>
  992. <table class="graybox">
  993. <tbody>
  994. <tr>
  995. <td>
  996. <code>
  997. <em>completionHandler</em>
  998. </code>
  999. </td>
  1000. <td>
  1001. <div>
  1002. <p>The completion handler that is called when the download has been successfully
  1003. cancelled. It is not guaranteed to be called on a particular queue, so you may
  1004. want use an appropriate queue to perform your work.</p>
  1005. </div>
  1006. </td>
  1007. </tr>
  1008. </tbody>
  1009. </table>
  1010. </div>
  1011. <div>
  1012. <h4>Return Value</h4>
  1013. <p>The instance.</p>
  1014. </div>
  1015. </section>
  1016. </div>
  1017. </li>
  1018. <li class="item">
  1019. <div>
  1020. <code>
  1021. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  1022. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1023. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:<wbr>)</a>
  1024. </code>
  1025. </div>
  1026. <div class="height-container">
  1027. <div class="pointer-container"></div>
  1028. <section class="section">
  1029. <div class="pointer"></div>
  1030. <div class="abstract">
  1031. <p>Validates the request, using the specified closure.</p>
  1032. <div class="aside aside-note">
  1033. <p class="aside-title">Note</p>
  1034. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1035. </div>
  1036. </div>
  1037. <div class="declaration">
  1038. <h4>Declaration</h4>
  1039. <div class="language">
  1040. <p class="aside-title">Swift</p>
  1041. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1042. <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>
  1043. </div>
  1044. </div>
  1045. <div>
  1046. <h4>Parameters</h4>
  1047. <table class="graybox">
  1048. <tbody>
  1049. <tr>
  1050. <td>
  1051. <code>
  1052. <em>validation</em>
  1053. </code>
  1054. </td>
  1055. <td>
  1056. <div>
  1057. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></code> closure to validate the response.</p>
  1058. </div>
  1059. </td>
  1060. </tr>
  1061. </tbody>
  1062. </table>
  1063. </div>
  1064. <div>
  1065. <h4>Return Value</h4>
  1066. <p>The instance.</p>
  1067. </div>
  1068. </section>
  1069. </div>
  1070. </li>
  1071. </ul>
  1072. </div>
  1073. <div class="task-group">
  1074. <div class="task-name-container">
  1075. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  1076. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  1077. <div class="section-name-container">
  1078. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  1079. <h3 class="section-name"><span>DataRequest / UploadRequest</span>
  1080. </h3>
  1081. </div>
  1082. </div>
  1083. <ul class="item-container">
  1084. <li class="item">
  1085. <div>
  1086. <code>
  1087. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF"></a>
  1088. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1089. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1090. </code>
  1091. </div>
  1092. <div class="height-container">
  1093. <div class="pointer-container"></div>
  1094. <section class="section">
  1095. <div class="pointer"></div>
  1096. <div class="abstract">
  1097. <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>
  1098. </div>
  1099. <div class="declaration">
  1100. <h4>Declaration</h4>
  1101. <div class="language">
  1102. <p class="aside-title">Swift</p>
  1103. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1104. <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>
  1105. <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>
  1106. </div>
  1107. </div>
  1108. <div>
  1109. <h4>Parameters</h4>
  1110. <table class="graybox">
  1111. <tbody>
  1112. <tr>
  1113. <td>
  1114. <code>
  1115. <em>serializer</em>
  1116. </code>
  1117. </td>
  1118. <td>
  1119. <div>
  1120. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> used to serialize the response <code>Data</code> from disk.</p>
  1121. </div>
  1122. </td>
  1123. </tr>
  1124. <tr>
  1125. <td>
  1126. <code>
  1127. <em>queue</em>
  1128. </code>
  1129. </td>
  1130. <td>
  1131. <div>
  1132. <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>
  1133. </div>
  1134. </td>
  1135. </tr>
  1136. </tbody>
  1137. </table>
  1138. </div>
  1139. <div>
  1140. <h4>Return Value</h4>
  1141. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1142. </div>
  1143. </section>
  1144. </div>
  1145. </li>
  1146. <li class="item">
  1147. <div>
  1148. <code>
  1149. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF"></a>
  1150. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1151. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1152. </code>
  1153. </div>
  1154. <div class="height-container">
  1155. <div class="pointer-container"></div>
  1156. <section class="section">
  1157. <div class="pointer"></div>
  1158. <div class="abstract">
  1159. <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
  1160. <code>DispatchQueue</code>.</p>
  1161. </div>
  1162. <div class="declaration">
  1163. <h4>Declaration</h4>
  1164. <div class="language">
  1165. <p class="aside-title">Swift</p>
  1166. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1167. <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>
  1168. <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>
  1169. </div>
  1170. </div>
  1171. <div>
  1172. <h4>Parameters</h4>
  1173. <table class="graybox">
  1174. <tbody>
  1175. <tr>
  1176. <td>
  1177. <code>
  1178. <em>serializer</em>
  1179. </code>
  1180. </td>
  1181. <td>
  1182. <div>
  1183. <p><code>DownloadResponseSerializer</code> used to serialize the response <code>Data</code> from disk.</p>
  1184. </div>
  1185. </td>
  1186. </tr>
  1187. <tr>
  1188. <td>
  1189. <code>
  1190. <em>queue</em>
  1191. </code>
  1192. </td>
  1193. <td>
  1194. <div>
  1195. <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>
  1196. </div>
  1197. </td>
  1198. </tr>
  1199. </tbody>
  1200. </table>
  1201. </div>
  1202. <div>
  1203. <h4>Return Value</h4>
  1204. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1205. </div>
  1206. </section>
  1207. </div>
  1208. </li>
  1209. <li class="item">
  1210. <div>
  1211. <code>
  1212. <a name="/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF"></a>
  1213. <a name="//apple_ref/swift/Method/publishURL(queue:)" class="dashAnchor"></a>
  1214. <a class="token" href="#/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF">publishURL(queue:<wbr>)</a>
  1215. </code>
  1216. </div>
  1217. <div class="height-container">
  1218. <div class="pointer-container"></div>
  1219. <section class="section">
  1220. <div class="pointer"></div>
  1221. <div class="abstract">
  1222. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a></code> to serialize the
  1223. response.</p>
  1224. </div>
  1225. <div class="declaration">
  1226. <h4>Declaration</h4>
  1227. <div class="language">
  1228. <p class="aside-title">Swift</p>
  1229. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1230. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishURL</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> <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="o">&gt;</span></code></pre>
  1231. </div>
  1232. </div>
  1233. <div>
  1234. <h4>Parameters</h4>
  1235. <table class="graybox">
  1236. <tbody>
  1237. <tr>
  1238. <td>
  1239. <code>
  1240. <em>queue</em>
  1241. </code>
  1242. </td>
  1243. <td>
  1244. <div>
  1245. <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>
  1246. </div>
  1247. </td>
  1248. </tr>
  1249. </tbody>
  1250. </table>
  1251. </div>
  1252. <div>
  1253. <h4>Return Value</h4>
  1254. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1255. </div>
  1256. </section>
  1257. </div>
  1258. </li>
  1259. <li class="item">
  1260. <div>
  1261. <code>
  1262. <a name="/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF"></a>
  1263. <a name="//apple_ref/swift/Method/publishData(queue:preprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1264. <a class="token" href="#/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF">publishData(queue:<wbr>preprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1265. </code>
  1266. </div>
  1267. <div class="height-container">
  1268. <div class="pointer-container"></div>
  1269. <section class="section">
  1270. <div class="pointer"></div>
  1271. <div class="abstract">
  1272. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to serialize the
  1273. response.</p>
  1274. </div>
  1275. <div class="declaration">
  1276. <h4>Declaration</h4>
  1277. <div class="language">
  1278. <p class="aside-title">Swift</p>
  1279. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1280. <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>
  1281. <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>
  1282. <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>
  1283. <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>
  1284. </div>
  1285. </div>
  1286. <div>
  1287. <h4>Parameters</h4>
  1288. <table class="graybox">
  1289. <tbody>
  1290. <tr>
  1291. <td>
  1292. <code>
  1293. <em>queue</em>
  1294. </code>
  1295. </td>
  1296. <td>
  1297. <div>
  1298. <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>
  1299. </div>
  1300. </td>
  1301. </tr>
  1302. <tr>
  1303. <td>
  1304. <code>
  1305. <em>preprocessor</em>
  1306. </code>
  1307. </td>
  1308. <td>
  1309. <div>
  1310. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1311. by default.</p>
  1312. </div>
  1313. </td>
  1314. </tr>
  1315. <tr>
  1316. <td>
  1317. <code>
  1318. <em>emptyResponseCodes</em>
  1319. </code>
  1320. </td>
  1321. <td>
  1322. <div>
  1323. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1324. default.</p>
  1325. </div>
  1326. </td>
  1327. </tr>
  1328. <tr>
  1329. <td>
  1330. <code>
  1331. <em>emptyRequestMethods</em>
  1332. </code>
  1333. </td>
  1334. <td>
  1335. <div>
  1336. <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
  1337. status code. <code>[.head]</code> by default.</p>
  1338. </div>
  1339. </td>
  1340. </tr>
  1341. </tbody>
  1342. </table>
  1343. </div>
  1344. <div>
  1345. <h4>Return Value</h4>
  1346. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1347. </div>
  1348. </section>
  1349. </div>
  1350. </li>
  1351. <li class="item">
  1352. <div>
  1353. <code>
  1354. <a name="/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1355. <a name="//apple_ref/swift/Method/publishString(queue:preprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1356. <a class="token" href="#/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">publishString(queue:<wbr>preprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1357. </code>
  1358. </div>
  1359. <div class="height-container">
  1360. <div class="pointer-container"></div>
  1361. <section class="section">
  1362. <div class="pointer"></div>
  1363. <div class="abstract">
  1364. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to serialize the
  1365. response.</p>
  1366. </div>
  1367. <div class="declaration">
  1368. <h4>Declaration</h4>
  1369. <div class="language">
  1370. <p class="aside-title">Swift</p>
  1371. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1372. <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>
  1373. <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>
  1374. <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>
  1375. <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>
  1376. <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>
  1377. </div>
  1378. </div>
  1379. <div>
  1380. <h4>Parameters</h4>
  1381. <table class="graybox">
  1382. <tbody>
  1383. <tr>
  1384. <td>
  1385. <code>
  1386. <em>queue</em>
  1387. </code>
  1388. </td>
  1389. <td>
  1390. <div>
  1391. <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>
  1392. </div>
  1393. </td>
  1394. </tr>
  1395. <tr>
  1396. <td>
  1397. <code>
  1398. <em>preprocessor</em>
  1399. </code>
  1400. </td>
  1401. <td>
  1402. <div>
  1403. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1404. by default.</p>
  1405. </div>
  1406. </td>
  1407. </tr>
  1408. <tr>
  1409. <td>
  1410. <code>
  1411. <em>encoding</em>
  1412. </code>
  1413. </td>
  1414. <td>
  1415. <div>
  1416. <p><code>String.Encoding</code> to parse the response. <code>nil</code> by default, in which case the encoding
  1417. will be determined by the server response, falling back to the default HTTP character
  1418. set, <code>ISO-8859-1</code>.</p>
  1419. </div>
  1420. </td>
  1421. </tr>
  1422. <tr>
  1423. <td>
  1424. <code>
  1425. <em>emptyResponseCodes</em>
  1426. </code>
  1427. </td>
  1428. <td>
  1429. <div>
  1430. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1431. default.</p>
  1432. </div>
  1433. </td>
  1434. </tr>
  1435. <tr>
  1436. <td>
  1437. <code>
  1438. <em>emptyRequestMethods</em>
  1439. </code>
  1440. </td>
  1441. <td>
  1442. <div>
  1443. <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
  1444. status code. <code>[.head]</code> by default.</p>
  1445. </div>
  1446. </td>
  1447. </tr>
  1448. </tbody>
  1449. </table>
  1450. </div>
  1451. <div>
  1452. <h4>Return Value</h4>
  1453. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1454. </div>
  1455. </section>
  1456. </div>
  1457. </li>
  1458. <li class="item">
  1459. <div>
  1460. <code>
  1461. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1462. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyResponseMethods:)" class="dashAnchor"></a>
  1463. <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>
  1464. </code>
  1465. </div>
  1466. <div class="height-container">
  1467. <div class="pointer-container"></div>
  1468. <section class="section">
  1469. <div class="pointer"></div>
  1470. <div class="abstract">
  1471. <p>Undocumented</p>
  1472. </div>
  1473. <div class="declaration">
  1474. <h4>Declaration</h4>
  1475. <div class="language">
  1476. <p class="aside-title">Swift</p>
  1477. <pre class="highlight swift"><code><span class="kd">@_disfavoredOverload</span>
  1478. <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>
  1479. <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>
  1480. <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>
  1481. <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>
  1482. <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>
  1483. <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>
  1484. </div>
  1485. </div>
  1486. </section>
  1487. </div>
  1488. </li>
  1489. <li class="item">
  1490. <div>
  1491. <code>
  1492. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jC7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1493. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1494. <a class="token" href="#/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jC7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">publishDecodable(type:<wbr>queue:<wbr>preprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1495. </code>
  1496. </div>
  1497. <div class="height-container">
  1498. <div class="pointer-container"></div>
  1499. <section class="section">
  1500. <div class="pointer"></div>
  1501. <div class="abstract">
  1502. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to serialize
  1503. the response.</p>
  1504. </div>
  1505. <div class="declaration">
  1506. <h4>Declaration</h4>
  1507. <div class="language">
  1508. <p class="aside-title">Swift</p>
  1509. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1510. <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>
  1511. <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>
  1512. <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>
  1513. <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>
  1514. <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>
  1515. <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> <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>
  1516. </div>
  1517. </div>
  1518. <div>
  1519. <h4>Parameters</h4>
  1520. <table class="graybox">
  1521. <tbody>
  1522. <tr>
  1523. <td>
  1524. <code>
  1525. <em>type</em>
  1526. </code>
  1527. </td>
  1528. <td>
  1529. <div>
  1530. <p><code>Decodable</code> type to which to decode response <code>Data</code>. Inferred from the context by default.</p>
  1531. </div>
  1532. </td>
  1533. </tr>
  1534. <tr>
  1535. <td>
  1536. <code>
  1537. <em>queue</em>
  1538. </code>
  1539. </td>
  1540. <td>
  1541. <div>
  1542. <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>
  1543. </div>
  1544. </td>
  1545. </tr>
  1546. <tr>
  1547. <td>
  1548. <code>
  1549. <em>preprocessor</em>
  1550. </code>
  1551. </td>
  1552. <td>
  1553. <div>
  1554. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization.
  1555. <code>PassthroughPreprocessor()</code> by default.</p>
  1556. </div>
  1557. </td>
  1558. </tr>
  1559. <tr>
  1560. <td>
  1561. <code>
  1562. <em>decoder</em>
  1563. </code>
  1564. </td>
  1565. <td>
  1566. <div>
  1567. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode response <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1568. </div>
  1569. </td>
  1570. </tr>
  1571. <tr>
  1572. <td>
  1573. <code>
  1574. <em>emptyResponseCodes</em>
  1575. </code>
  1576. </td>
  1577. <td>
  1578. <div>
  1579. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1580. default.</p>
  1581. </div>
  1582. </td>
  1583. </tr>
  1584. <tr>
  1585. <td>
  1586. <code>
  1587. <em>emptyRequestMethods</em>
  1588. </code>
  1589. </td>
  1590. <td>
  1591. <div>
  1592. <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
  1593. of status code. <code>[.head]</code> by default.</p>
  1594. </div>
  1595. </td>
  1596. </tr>
  1597. </tbody>
  1598. </table>
  1599. </div>
  1600. <div>
  1601. <h4>Return Value</h4>
  1602. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1603. </div>
  1604. </section>
  1605. </div>
  1606. </li>
  1607. <li class="item">
  1608. <div>
  1609. <code>
  1610. <a name="/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF"></a>
  1611. <a name="//apple_ref/swift/Method/publishUnserialized(on:)" class="dashAnchor"></a>
  1612. <a class="token" href="#/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF">publishUnserialized(on:<wbr>)</a>
  1613. </code>
  1614. </div>
  1615. <div class="height-container">
  1616. <div class="pointer-container"></div>
  1617. <section class="section">
  1618. <div class="pointer"></div>
  1619. <div class="abstract">
  1620. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance which does not serialize the response before publishing.</p>
  1621. </div>
  1622. <div class="declaration">
  1623. <h4>Declaration</h4>
  1624. <div class="language">
  1625. <p class="aside-title">Swift</p>
  1626. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1627. <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>
  1628. </div>
  1629. </div>
  1630. <div>
  1631. <h4>Parameters</h4>
  1632. <table class="graybox">
  1633. <tbody>
  1634. <tr>
  1635. <td>
  1636. <code>
  1637. <em>queue</em>
  1638. </code>
  1639. </td>
  1640. <td>
  1641. <div>
  1642. <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>
  1643. </div>
  1644. </td>
  1645. </tr>
  1646. </tbody>
  1647. </table>
  1648. </div>
  1649. <div>
  1650. <h4>Return Value</h4>
  1651. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1652. </div>
  1653. </section>
  1654. </div>
  1655. </li>
  1656. </ul>
  1657. </div>
  1658. <div class="task-group">
  1659. <div class="task-name-container">
  1660. <a name="/DownloadTask"></a>
  1661. <a name="//apple_ref/swift/Section/DownloadTask" class="dashAnchor"></a>
  1662. <div class="section-name-container">
  1663. <a class="section-name-link" href="#/DownloadTask"></a>
  1664. <h3 class="section-name"><span>DownloadTask</span>
  1665. </h3>
  1666. </div>
  1667. </div>
  1668. <ul class="item-container">
  1669. <li class="item">
  1670. <div>
  1671. <code>
  1672. <a name="/s:9Alamofire15DownloadRequestC15serializingData23automaticallyCancelling16dataPreprocessor18emptyResponseCodes0jC7MethodsAA0B4TaskVy10Foundation0E0VGSb_AA0eI0_pShySiGShyAA10HTTPMethodVGtF"></a>
  1673. <a name="//apple_ref/swift/Method/serializingData(automaticallyCancelling:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1674. <a class="token" href="#/s:9Alamofire15DownloadRequestC15serializingData23automaticallyCancelling16dataPreprocessor18emptyResponseCodes0jC7MethodsAA0B4TaskVy10Foundation0E0VGSb_AA0eI0_pShySiGShyAA10HTTPMethodVGtF">serializingData(automaticallyCancelling:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1675. </code>
  1676. </div>
  1677. <div class="height-container">
  1678. <div class="pointer-container"></div>
  1679. <section class="section">
  1680. <div class="pointer"></div>
  1681. <div class="abstract">
  1682. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> a <code>Data</code> value.</p>
  1683. </div>
  1684. <div class="declaration">
  1685. <h4>Declaration</h4>
  1686. <div class="language">
  1687. <p class="aside-title">Swift</p>
  1688. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingData</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1689. <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>
  1690. <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>
  1691. <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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  1692. </div>
  1693. </div>
  1694. <div>
  1695. <h4>Parameters</h4>
  1696. <table class="graybox">
  1697. <tbody>
  1698. <tr>
  1699. <td>
  1700. <code>
  1701. <em>shouldAutomaticallyCancel</em>
  1702. </code>
  1703. </td>
  1704. <td>
  1705. <div>
  1706. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1707. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1708. properties. <code>false</code> by default.</p>
  1709. </div>
  1710. </td>
  1711. </tr>
  1712. <tr>
  1713. <td>
  1714. <code>
  1715. <em>dataPreprocessor</em>
  1716. </code>
  1717. </td>
  1718. <td>
  1719. <div>
  1720. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before completion.</p>
  1721. </div>
  1722. </td>
  1723. </tr>
  1724. <tr>
  1725. <td>
  1726. <code>
  1727. <em>emptyResponseCodes</em>
  1728. </code>
  1729. </td>
  1730. <td>
  1731. <div>
  1732. <p>HTTP response codes for which empty responses are allowed. <code>[204, 205]</code> by default.</p>
  1733. </div>
  1734. </td>
  1735. </tr>
  1736. <tr>
  1737. <td>
  1738. <code>
  1739. <em>emptyRequestMethods</em>
  1740. </code>
  1741. </td>
  1742. <td>
  1743. <div>
  1744. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1745. </div>
  1746. </td>
  1747. </tr>
  1748. </tbody>
  1749. </table>
  1750. </div>
  1751. <div>
  1752. <h4>Return Value</h4>
  1753. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1754. </div>
  1755. </section>
  1756. </div>
  1757. </li>
  1758. <li class="item">
  1759. <div>
  1760. <code>
  1761. <a name="/s:9Alamofire15DownloadRequestC20serializingDecodable_23automaticallyCancelling16dataPreprocessor7decoder18emptyResponseCodes0kC7MethodsAA0B4TaskVyxGxm_SbAA04DataI0_pAA0P7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1762. <a name="//apple_ref/swift/Method/serializingDecodable(_:automaticallyCancelling:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1763. <a class="token" href="#/s:9Alamofire15DownloadRequestC20serializingDecodable_23automaticallyCancelling16dataPreprocessor7decoder18emptyResponseCodes0kC7MethodsAA0B4TaskVyxGxm_SbAA04DataI0_pAA0P7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">serializingDecodable(_:<wbr>automaticallyCancelling:<wbr>dataPreprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1764. </code>
  1765. </div>
  1766. <div class="height-container">
  1767. <div class="pointer-container"></div>
  1768. <section class="section">
  1769. <div class="pointer"></div>
  1770. <div class="abstract">
  1771. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of a <code>Decodable</code> value.</p>
  1772. <div class="aside aside-note">
  1773. <p class="aside-title">Note</p>
  1774. <p>This serializer reads the entire response into memory before parsing.</p>
  1775. </div>
  1776. </div>
  1777. <div class="declaration">
  1778. <h4>Declaration</h4>
  1779. <div class="language">
  1780. <p class="aside-title">Swift</p>
  1781. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDecodable</span><span class="o">&lt;</span><span class="kt">Value</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">Value</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">Value</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1782. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1783. <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">Value</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1784. <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>
  1785. <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">Value</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1786. <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">Value</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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  1787. </div>
  1788. </div>
  1789. <div>
  1790. <h4>Parameters</h4>
  1791. <table class="graybox">
  1792. <tbody>
  1793. <tr>
  1794. <td>
  1795. <code>
  1796. <em>type</em>
  1797. </code>
  1798. </td>
  1799. <td>
  1800. <div>
  1801. <p><code>Decodable</code> type to decode from response data.</p>
  1802. </div>
  1803. </td>
  1804. </tr>
  1805. <tr>
  1806. <td>
  1807. <code>
  1808. <em>shouldAutomaticallyCancel</em>
  1809. </code>
  1810. </td>
  1811. <td>
  1812. <div>
  1813. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1814. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1815. properties. <code>false</code> by default.</p>
  1816. </div>
  1817. </td>
  1818. </tr>
  1819. <tr>
  1820. <td>
  1821. <code>
  1822. <em>dataPreprocessor</em>
  1823. </code>
  1824. </td>
  1825. <td>
  1826. <div>
  1827. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the serializer.
  1828. <code>PassthroughPreprocessor()</code> by default.</p>
  1829. </div>
  1830. </td>
  1831. </tr>
  1832. <tr>
  1833. <td>
  1834. <code>
  1835. <em>decoder</em>
  1836. </code>
  1837. </td>
  1838. <td>
  1839. <div>
  1840. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  1841. </div>
  1842. </td>
  1843. </tr>
  1844. <tr>
  1845. <td>
  1846. <code>
  1847. <em>emptyResponseCodes</em>
  1848. </code>
  1849. </td>
  1850. <td>
  1851. <div>
  1852. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1853. </div>
  1854. </td>
  1855. </tr>
  1856. <tr>
  1857. <td>
  1858. <code>
  1859. <em>emptyRequestMethods</em>
  1860. </code>
  1861. </td>
  1862. <td>
  1863. <div>
  1864. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1865. </div>
  1866. </td>
  1867. </tr>
  1868. </tbody>
  1869. </table>
  1870. </div>
  1871. <div>
  1872. <h4>Return Value</h4>
  1873. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1874. </div>
  1875. </section>
  1876. </div>
  1877. </li>
  1878. <li class="item">
  1879. <div>
  1880. <code>
  1881. <a name="/s:9Alamofire15DownloadRequestC28serializingDownloadedFileURL23automaticallyCancellingAA0B4TaskVy10Foundation0G0VGSb_tF"></a>
  1882. <a name="//apple_ref/swift/Method/serializingDownloadedFileURL(automaticallyCancelling:)" class="dashAnchor"></a>
  1883. <a class="token" href="#/s:9Alamofire15DownloadRequestC28serializingDownloadedFileURL23automaticallyCancellingAA0B4TaskVy10Foundation0G0VGSb_tF">serializingDownloadedFileURL(automaticallyCancelling:<wbr>)</a>
  1884. </code>
  1885. </div>
  1886. <div class="height-container">
  1887. <div class="pointer-container"></div>
  1888. <section class="section">
  1889. <div class="pointer"></div>
  1890. <div class="abstract">
  1891. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of the downloaded file&rsquo;s <code>URL</code> on disk.</p>
  1892. </div>
  1893. <div class="declaration">
  1894. <h4>Declaration</h4>
  1895. <div class="language">
  1896. <p class="aside-title">Swift</p>
  1897. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingDownloadedFileURL</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="o">&gt;</span></code></pre>
  1898. </div>
  1899. </div>
  1900. <div>
  1901. <h4>Parameters</h4>
  1902. <table class="graybox">
  1903. <tbody>
  1904. <tr>
  1905. <td>
  1906. <code>
  1907. <em>shouldAutomaticallyCancel</em>
  1908. </code>
  1909. </td>
  1910. <td>
  1911. <div>
  1912. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1913. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1914. properties. <code>false</code> by default.</p>
  1915. </div>
  1916. </td>
  1917. </tr>
  1918. </tbody>
  1919. </table>
  1920. </div>
  1921. <div>
  1922. <h4>Return Value</h4>
  1923. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1924. </div>
  1925. </section>
  1926. </div>
  1927. </li>
  1928. <li class="item">
  1929. <div>
  1930. <code>
  1931. <a name="/s:9Alamofire15DownloadRequestC17serializingString23automaticallyCancelling16dataPreprocessor8encoding18emptyResponseCodes0kC7MethodsAA0B4TaskVySSGSb_AA04DataI0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1932. <a name="//apple_ref/swift/Method/serializingString(automaticallyCancelling:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1933. <a class="token" href="#/s:9Alamofire15DownloadRequestC17serializingString23automaticallyCancelling16dataPreprocessor8encoding18emptyResponseCodes0kC7MethodsAA0B4TaskVySSGSb_AA04DataI0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">serializingString(automaticallyCancelling:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1934. </code>
  1935. </div>
  1936. <div class="height-container">
  1937. <div class="pointer-container"></div>
  1938. <section class="section">
  1939. <div class="pointer"></div>
  1940. <div class="abstract">
  1941. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of a <code>String</code> value.</p>
  1942. </div>
  1943. <div class="declaration">
  1944. <h4>Declaration</h4>
  1945. <div class="language">
  1946. <p class="aside-title">Swift</p>
  1947. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingString</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1948. <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>
  1949. <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>
  1950. <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>
  1951. <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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  1952. </div>
  1953. </div>
  1954. <div>
  1955. <h4>Parameters</h4>
  1956. <table class="graybox">
  1957. <tbody>
  1958. <tr>
  1959. <td>
  1960. <code>
  1961. <em>shouldAutomaticallyCancel</em>
  1962. </code>
  1963. </td>
  1964. <td>
  1965. <div>
  1966. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1967. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1968. properties. <code>false</code> by default.</p>
  1969. </div>
  1970. </td>
  1971. </tr>
  1972. <tr>
  1973. <td>
  1974. <code>
  1975. <em>dataPreprocessor</em>
  1976. </code>
  1977. </td>
  1978. <td>
  1979. <div>
  1980. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1981. serializer. <code>PassthroughPreprocessor()</code> by default.</p>
  1982. </div>
  1983. </td>
  1984. </tr>
  1985. <tr>
  1986. <td>
  1987. <code>
  1988. <em>encoding</em>
  1989. </code>
  1990. </td>
  1991. <td>
  1992. <div>
  1993. <p><code>String.Encoding</code> to use during serialization. Defaults to <code>nil</code>, in which case
  1994. the encoding will be determined from the server response, falling back to the
  1995. default HTTP character set, <code>ISO-8859-1</code>.</p>
  1996. </div>
  1997. </td>
  1998. </tr>
  1999. <tr>
  2000. <td>
  2001. <code>
  2002. <em>emptyResponseCodes</em>
  2003. </code>
  2004. </td>
  2005. <td>
  2006. <div>
  2007. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2008. </div>
  2009. </td>
  2010. </tr>
  2011. <tr>
  2012. <td>
  2013. <code>
  2014. <em>emptyRequestMethods</em>
  2015. </code>
  2016. </td>
  2017. <td>
  2018. <div>
  2019. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2020. </div>
  2021. </td>
  2022. </tr>
  2023. </tbody>
  2024. </table>
  2025. </div>
  2026. <div>
  2027. <h4>Return Value</h4>
  2028. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2029. </div>
  2030. </section>
  2031. </div>
  2032. </li>
  2033. <li class="item">
  2034. <div>
  2035. <code>
  2036. <a name="/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA18ResponseSerializerRzlF"></a>
  2037. <a name="//apple_ref/swift/Method/serializingDownload(using:automaticallyCancelling:)" class="dashAnchor"></a>
  2038. <a class="token" href="#/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA18ResponseSerializerRzlF">serializingDownload(using:<wbr>automaticallyCancelling:<wbr>)</a>
  2039. </code>
  2040. </div>
  2041. <div class="height-container">
  2042. <div class="pointer-container"></div>
  2043. <section class="section">
  2044. <div class="pointer"></div>
  2045. <div class="abstract">
  2046. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization using the provided <code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> instance.</p>
  2047. </div>
  2048. <div class="declaration">
  2049. <h4>Declaration</h4>
  2050. <div class="language">
  2051. <p class="aside-title">Swift</p>
  2052. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDownload</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="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>
  2053. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span>
  2054. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</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></code></pre>
  2055. </div>
  2056. </div>
  2057. <div>
  2058. <h4>Parameters</h4>
  2059. <table class="graybox">
  2060. <tbody>
  2061. <tr>
  2062. <td>
  2063. <code>
  2064. <em>serializer</em>
  2065. </code>
  2066. </td>
  2067. <td>
  2068. <div>
  2069. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> responsible for serializing the request, response, and data.</p>
  2070. </div>
  2071. </td>
  2072. </tr>
  2073. <tr>
  2074. <td>
  2075. <code>
  2076. <em>shouldAutomaticallyCancel</em>
  2077. </code>
  2078. </td>
  2079. <td>
  2080. <div>
  2081. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  2082. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  2083. properties. <code>false</code> by default.</p>
  2084. </div>
  2085. </td>
  2086. </tr>
  2087. </tbody>
  2088. </table>
  2089. </div>
  2090. <div>
  2091. <h4>Return Value</h4>
  2092. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2093. </div>
  2094. </section>
  2095. </div>
  2096. </li>
  2097. <li class="item">
  2098. <div>
  2099. <code>
  2100. <a name="/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA0B26ResponseSerializerProtocolRzlF"></a>
  2101. <a name="//apple_ref/swift/Method/serializingDownload(using:automaticallyCancelling:)" class="dashAnchor"></a>
  2102. <a class="token" href="#/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA0B26ResponseSerializerProtocolRzlF">serializingDownload(using:<wbr>automaticallyCancelling:<wbr>)</a>
  2103. </code>
  2104. </div>
  2105. <div class="height-container">
  2106. <div class="pointer-container"></div>
  2107. <section class="section">
  2108. <div class="pointer"></div>
  2109. <div class="abstract">
  2110. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization using the provided <code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code>
  2111. instance.</p>
  2112. </div>
  2113. <div class="declaration">
  2114. <h4>Declaration</h4>
  2115. <div class="language">
  2116. <p class="aside-title">Swift</p>
  2117. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDownload</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="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2118. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span>
  2119. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</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></code></pre>
  2120. </div>
  2121. </div>
  2122. <div>
  2123. <h4>Parameters</h4>
  2124. <table class="graybox">
  2125. <tbody>
  2126. <tr>
  2127. <td>
  2128. <code>
  2129. <em>serializer</em>
  2130. </code>
  2131. </td>
  2132. <td>
  2133. <div>
  2134. <p><code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code> responsible for serializing the request,
  2135. response, and data.</p>
  2136. </div>
  2137. </td>
  2138. </tr>
  2139. <tr>
  2140. <td>
  2141. <code>
  2142. <em>shouldAutomaticallyCancel</em>
  2143. </code>
  2144. </td>
  2145. <td>
  2146. <div>
  2147. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  2148. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  2149. properties. <code>false</code> by default.</p>
  2150. </div>
  2151. </td>
  2152. </tr>
  2153. </tbody>
  2154. </table>
  2155. </div>
  2156. <div>
  2157. <h4>Return Value</h4>
  2158. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2159. </div>
  2160. </section>
  2161. </div>
  2162. </li>
  2163. </ul>
  2164. </div>
  2165. <div class="task-group">
  2166. <div class="task-name-container">
  2167. <a name="/Default"></a>
  2168. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  2169. <div class="section-name-container">
  2170. <a class="section-name-link" href="#/Default"></a>
  2171. <h3 class="section-name"><span>Default</span>
  2172. </h3>
  2173. </div>
  2174. </div>
  2175. <ul class="item-container">
  2176. <li class="item">
  2177. <div>
  2178. <code>
  2179. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF"></a>
  2180. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  2181. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF">response(queue:<wbr>completionHandler:<wbr>)</a>
  2182. </code>
  2183. </div>
  2184. <div class="height-container">
  2185. <div class="pointer-container"></div>
  2186. <section class="section">
  2187. <div class="pointer"></div>
  2188. <div class="abstract">
  2189. <p>Adds a handler to be called once the request has finished.</p>
  2190. </div>
  2191. <div class="declaration">
  2192. <h4>Declaration</h4>
  2193. <div class="language">
  2194. <p class="aside-title">Swift</p>
  2195. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2196. <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>
  2197. <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>
  2198. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2199. </div>
  2200. </div>
  2201. <div>
  2202. <h4>Parameters</h4>
  2203. <table class="graybox">
  2204. <tbody>
  2205. <tr>
  2206. <td>
  2207. <code>
  2208. <em>queue</em>
  2209. </code>
  2210. </td>
  2211. <td>
  2212. <div>
  2213. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2214. </div>
  2215. </td>
  2216. </tr>
  2217. <tr>
  2218. <td>
  2219. <code>
  2220. <em>completionHandler</em>
  2221. </code>
  2222. </td>
  2223. <td>
  2224. <div>
  2225. <p>The code to be executed once the request has finished.</p>
  2226. </div>
  2227. </td>
  2228. </tr>
  2229. </tbody>
  2230. </table>
  2231. </div>
  2232. <div>
  2233. <h4>Return Value</h4>
  2234. <p>The request.</p>
  2235. </div>
  2236. </section>
  2237. </div>
  2238. </li>
  2239. <li class="item">
  2240. <div>
  2241. <code>
  2242. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  2243. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  2244. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  2245. </code>
  2246. </div>
  2247. <div class="height-container">
  2248. <div class="pointer-container"></div>
  2249. <section class="section">
  2250. <div class="pointer"></div>
  2251. <div class="abstract">
  2252. <p>Adds a handler to be called once the request has finished.</p>
  2253. </div>
  2254. <div class="declaration">
  2255. <h4>Declaration</h4>
  2256. <div class="language">
  2257. <p class="aside-title">Swift</p>
  2258. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2259. <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>
  2260. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2261. <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>
  2262. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2263. </div>
  2264. </div>
  2265. <div>
  2266. <h4>Parameters</h4>
  2267. <table class="graybox">
  2268. <tbody>
  2269. <tr>
  2270. <td>
  2271. <code>
  2272. <em>queue</em>
  2273. </code>
  2274. </td>
  2275. <td>
  2276. <div>
  2277. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2278. </div>
  2279. </td>
  2280. </tr>
  2281. <tr>
  2282. <td>
  2283. <code>
  2284. <em>responseSerializer</em>
  2285. </code>
  2286. </td>
  2287. <td>
  2288. <div>
  2289. <p>The response serializer responsible for serializing the request, response, and data
  2290. contained in the destination <code>URL</code>.</p>
  2291. </div>
  2292. </td>
  2293. </tr>
  2294. <tr>
  2295. <td>
  2296. <code>
  2297. <em>completionHandler</em>
  2298. </code>
  2299. </td>
  2300. <td>
  2301. <div>
  2302. <p>The code to be executed once the request has finished.</p>
  2303. </div>
  2304. </td>
  2305. </tr>
  2306. </tbody>
  2307. </table>
  2308. </div>
  2309. <div>
  2310. <h4>Return Value</h4>
  2311. <p>The request.</p>
  2312. </div>
  2313. </section>
  2314. </div>
  2315. </li>
  2316. <li class="item">
  2317. <div>
  2318. <code>
  2319. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0kF0RzlF"></a>
  2320. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  2321. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0kF0RzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  2322. </code>
  2323. </div>
  2324. <div class="height-container">
  2325. <div class="pointer-container"></div>
  2326. <section class="section">
  2327. <div class="pointer"></div>
  2328. <div class="abstract">
  2329. <p>Adds a handler to be called once the request has finished.</p>
  2330. </div>
  2331. <div class="declaration">
  2332. <h4>Declaration</h4>
  2333. <div class="language">
  2334. <p class="aside-title">Swift</p>
  2335. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2336. <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/ResponseSerializer.html">ResponseSerializer</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>
  2337. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2338. <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>
  2339. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2340. </div>
  2341. </div>
  2342. <div>
  2343. <h4>Parameters</h4>
  2344. <table class="graybox">
  2345. <tbody>
  2346. <tr>
  2347. <td>
  2348. <code>
  2349. <em>queue</em>
  2350. </code>
  2351. </td>
  2352. <td>
  2353. <div>
  2354. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2355. </div>
  2356. </td>
  2357. </tr>
  2358. <tr>
  2359. <td>
  2360. <code>
  2361. <em>responseSerializer</em>
  2362. </code>
  2363. </td>
  2364. <td>
  2365. <div>
  2366. <p>The response serializer responsible for serializing the request, response, and data
  2367. contained in the destination <code>URL</code>.</p>
  2368. </div>
  2369. </td>
  2370. </tr>
  2371. <tr>
  2372. <td>
  2373. <code>
  2374. <em>completionHandler</em>
  2375. </code>
  2376. </td>
  2377. <td>
  2378. <div>
  2379. <p>The code to be executed once the request has finished.</p>
  2380. </div>
  2381. </td>
  2382. </tr>
  2383. </tbody>
  2384. </table>
  2385. </div>
  2386. <div>
  2387. <h4>Return Value</h4>
  2388. <p>The request.</p>
  2389. </div>
  2390. </section>
  2391. </div>
  2392. </li>
  2393. </ul>
  2394. </div>
  2395. <div class="task-group">
  2396. <div class="task-name-container">
  2397. <a name="/URL"></a>
  2398. <a name="//apple_ref/swift/Section/URL" class="dashAnchor"></a>
  2399. <div class="section-name-container">
  2400. <a class="section-name-link" href="#/URL"></a>
  2401. <h3 class="section-name"><span>URL</span>
  2402. </h3>
  2403. </div>
  2404. </div>
  2405. <ul class="item-container">
  2406. <li class="item">
  2407. <div>
  2408. <code>
  2409. <a name="/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF"></a>
  2410. <a name="//apple_ref/swift/Method/responseURL(queue:completionHandler:)" class="dashAnchor"></a>
  2411. <a class="token" href="#/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF">responseURL(queue:<wbr>completionHandler:<wbr>)</a>
  2412. </code>
  2413. </div>
  2414. <div class="height-container">
  2415. <div class="pointer-container"></div>
  2416. <section class="section">
  2417. <div class="pointer"></div>
  2418. <div class="abstract">
  2419. <p>Adds a handler using a <code><a href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a></code> to be called once the request is finished.</p>
  2420. </div>
  2421. <div class="declaration">
  2422. <h4>Declaration</h4>
  2423. <div class="language">
  2424. <p class="aside-title">Swift</p>
  2425. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2426. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseURL</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>
  2427. <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="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>
  2428. </div>
  2429. </div>
  2430. <div>
  2431. <h4>Parameters</h4>
  2432. <table class="graybox">
  2433. <tbody>
  2434. <tr>
  2435. <td>
  2436. <code>
  2437. <em>queue</em>
  2438. </code>
  2439. </td>
  2440. <td>
  2441. <div>
  2442. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  2443. </div>
  2444. </td>
  2445. </tr>
  2446. <tr>
  2447. <td>
  2448. <code>
  2449. <em>completionHandler</em>
  2450. </code>
  2451. </td>
  2452. <td>
  2453. <div>
  2454. <p>A closure to be executed once the request has finished.</p>
  2455. </div>
  2456. </td>
  2457. </tr>
  2458. </tbody>
  2459. </table>
  2460. </div>
  2461. <div>
  2462. <h4>Return Value</h4>
  2463. <p>The request.</p>
  2464. </div>
  2465. </section>
  2466. </div>
  2467. </li>
  2468. </ul>
  2469. </div>
  2470. <div class="task-group">
  2471. <div class="task-name-container">
  2472. <a name="/Data"></a>
  2473. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  2474. <div class="section-name-container">
  2475. <a class="section-name-link" href="#/Data"></a>
  2476. <h3 class="section-name"><span>Data</span>
  2477. </h3>
  2478. </div>
  2479. </div>
  2480. <ul class="item-container">
  2481. <li class="item">
  2482. <div>
  2483. <code>
  2484. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF"></a>
  2485. <a name="//apple_ref/swift/Method/responseData(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2486. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF">responseData(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2487. </code>
  2488. </div>
  2489. <div class="height-container">
  2490. <div class="pointer-container"></div>
  2491. <section class="section">
  2492. <div class="pointer"></div>
  2493. <div class="abstract">
  2494. <p>Adds a handler using a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to be called once the request has finished.</p>
  2495. </div>
  2496. <div class="declaration">
  2497. <h4>Declaration</h4>
  2498. <div class="language">
  2499. <p class="aside-title">Swift</p>
  2500. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2501. <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>
  2502. <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>
  2503. <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>
  2504. <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>
  2505. <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>
  2506. </div>
  2507. </div>
  2508. <div>
  2509. <h4>Parameters</h4>
  2510. <table class="graybox">
  2511. <tbody>
  2512. <tr>
  2513. <td>
  2514. <code>
  2515. <em>queue</em>
  2516. </code>
  2517. </td>
  2518. <td>
  2519. <div>
  2520. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  2521. </div>
  2522. </td>
  2523. </tr>
  2524. <tr>
  2525. <td>
  2526. <code>
  2527. <em>dataPreprocessor</em>
  2528. </code>
  2529. </td>
  2530. <td>
  2531. <div>
  2532. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2533. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2534. </div>
  2535. </td>
  2536. </tr>
  2537. <tr>
  2538. <td>
  2539. <code>
  2540. <em>emptyResponseCodes</em>
  2541. </code>
  2542. </td>
  2543. <td>
  2544. <div>
  2545. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2546. </div>
  2547. </td>
  2548. </tr>
  2549. <tr>
  2550. <td>
  2551. <code>
  2552. <em>emptyRequestMethods</em>
  2553. </code>
  2554. </td>
  2555. <td>
  2556. <div>
  2557. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2558. </div>
  2559. </td>
  2560. </tr>
  2561. <tr>
  2562. <td>
  2563. <code>
  2564. <em>completionHandler</em>
  2565. </code>
  2566. </td>
  2567. <td>
  2568. <div>
  2569. <p>A closure to be executed once the request has finished.</p>
  2570. </div>
  2571. </td>
  2572. </tr>
  2573. </tbody>
  2574. </table>
  2575. </div>
  2576. <div>
  2577. <h4>Return Value</h4>
  2578. <p>The request.</p>
  2579. </div>
  2580. </section>
  2581. </div>
  2582. </li>
  2583. </ul>
  2584. </div>
  2585. <div class="task-group">
  2586. <div class="task-name-container">
  2587. <a name="/String"></a>
  2588. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  2589. <div class="section-name-container">
  2590. <a class="section-name-link" href="#/String"></a>
  2591. <h3 class="section-name"><span>String</span>
  2592. </h3>
  2593. </div>
  2594. </div>
  2595. <ul class="item-container">
  2596. <li class="item">
  2597. <div>
  2598. <code>
  2599. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF"></a>
  2600. <a name="//apple_ref/swift/Method/responseString(queue:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2601. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF">responseString(queue:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2602. </code>
  2603. </div>
  2604. <div class="height-container">
  2605. <div class="pointer-container"></div>
  2606. <section class="section">
  2607. <div class="pointer"></div>
  2608. <div class="abstract">
  2609. <p>Adds a handler using a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to be called once the request has finished.</p>
  2610. </div>
  2611. <div class="declaration">
  2612. <h4>Declaration</h4>
  2613. <div class="language">
  2614. <p class="aside-title">Swift</p>
  2615. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2616. <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>
  2617. <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>
  2618. <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>
  2619. <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>
  2620. <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>
  2621. <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>
  2622. </div>
  2623. </div>
  2624. <div>
  2625. <h4>Parameters</h4>
  2626. <table class="graybox">
  2627. <tbody>
  2628. <tr>
  2629. <td>
  2630. <code>
  2631. <em>queue</em>
  2632. </code>
  2633. </td>
  2634. <td>
  2635. <div>
  2636. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2637. </div>
  2638. </td>
  2639. </tr>
  2640. <tr>
  2641. <td>
  2642. <code>
  2643. <em>dataPreprocessor</em>
  2644. </code>
  2645. </td>
  2646. <td>
  2647. <div>
  2648. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2649. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2650. </div>
  2651. </td>
  2652. </tr>
  2653. <tr>
  2654. <td>
  2655. <code>
  2656. <em>encoding</em>
  2657. </code>
  2658. </td>
  2659. <td>
  2660. <div>
  2661. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2662. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2663. </div>
  2664. </td>
  2665. </tr>
  2666. <tr>
  2667. <td>
  2668. <code>
  2669. <em>emptyResponseCodes</em>
  2670. </code>
  2671. </td>
  2672. <td>
  2673. <div>
  2674. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2675. </div>
  2676. </td>
  2677. </tr>
  2678. <tr>
  2679. <td>
  2680. <code>
  2681. <em>emptyRequestMethods</em>
  2682. </code>
  2683. </td>
  2684. <td>
  2685. <div>
  2686. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2687. </div>
  2688. </td>
  2689. </tr>
  2690. <tr>
  2691. <td>
  2692. <code>
  2693. <em>completionHandler</em>
  2694. </code>
  2695. </td>
  2696. <td>
  2697. <div>
  2698. <p>A closure to be executed once the request has finished.</p>
  2699. </div>
  2700. </td>
  2701. </tr>
  2702. </tbody>
  2703. </table>
  2704. </div>
  2705. <div>
  2706. <h4>Return Value</h4>
  2707. <p>The request.</p>
  2708. </div>
  2709. </section>
  2710. </div>
  2711. </li>
  2712. </ul>
  2713. </div>
  2714. <div class="task-group">
  2715. <div class="task-name-container">
  2716. <a name="/JSON"></a>
  2717. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  2718. <div class="section-name-container">
  2719. <a class="section-name-link" href="#/JSON"></a>
  2720. <h3 class="section-name"><span>JSON</span>
  2721. </h3>
  2722. </div>
  2723. </div>
  2724. <ul class="item-container">
  2725. <li class="item">
  2726. <div>
  2727. <code>
  2728. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF"></a>
  2729. <a name="//apple_ref/swift/Method/responseJSON(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:options:completionHandler:)" class="dashAnchor"></a>
  2730. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF">responseJSON(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>options:<wbr>completionHandler:<wbr>)</a>
  2731. </code>
  2732. </div>
  2733. <div class="height-container">
  2734. <div class="pointer-container"></div>
  2735. <section class="section">
  2736. <div class="pointer"></div>
  2737. <div class="abstract">
  2738. <p>Adds a handler using a <code><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></code> to be called once the request has finished.</p>
  2739. </div>
  2740. <div class="declaration">
  2741. <h4>Declaration</h4>
  2742. <div class="language">
  2743. <p class="aside-title">Swift</p>
  2744. <pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "responseJSON deprecated and will be removed in Alamofire 6. Use responseDecodable instead.")</span>
  2745. <span class="kd">@discardableResult</span>
  2746. <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>
  2747. <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>
  2748. <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>
  2749. <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>
  2750. <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>
  2751. <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>
  2752. </div>
  2753. </div>
  2754. <div>
  2755. <h4>Parameters</h4>
  2756. <table class="graybox">
  2757. <tbody>
  2758. <tr>
  2759. <td>
  2760. <code>
  2761. <em>queue</em>
  2762. </code>
  2763. </td>
  2764. <td>
  2765. <div>
  2766. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2767. </div>
  2768. </td>
  2769. </tr>
  2770. <tr>
  2771. <td>
  2772. <code>
  2773. <em>dataPreprocessor</em>
  2774. </code>
  2775. </td>
  2776. <td>
  2777. <div>
  2778. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2779. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2780. </div>
  2781. </td>
  2782. </tr>
  2783. <tr>
  2784. <td>
  2785. <code>
  2786. <em>emptyResponseCodes</em>
  2787. </code>
  2788. </td>
  2789. <td>
  2790. <div>
  2791. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2792. </div>
  2793. </td>
  2794. </tr>
  2795. <tr>
  2796. <td>
  2797. <code>
  2798. <em>emptyRequestMethods</em>
  2799. </code>
  2800. </td>
  2801. <td>
  2802. <div>
  2803. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2804. </div>
  2805. </td>
  2806. </tr>
  2807. <tr>
  2808. <td>
  2809. <code>
  2810. <em>options</em>
  2811. </code>
  2812. </td>
  2813. <td>
  2814. <div>
  2815. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2816. by default.</p>
  2817. </div>
  2818. </td>
  2819. </tr>
  2820. <tr>
  2821. <td>
  2822. <code>
  2823. <em>completionHandler</em>
  2824. </code>
  2825. </td>
  2826. <td>
  2827. <div>
  2828. <p>A closure to be executed once the request has finished.</p>
  2829. </div>
  2830. </td>
  2831. </tr>
  2832. </tbody>
  2833. </table>
  2834. </div>
  2835. <div>
  2836. <h4>Return Value</h4>
  2837. <p>The request.</p>
  2838. </div>
  2839. </section>
  2840. </div>
  2841. </li>
  2842. </ul>
  2843. </div>
  2844. <div class="task-group">
  2845. <div class="task-name-container">
  2846. <a name="/Decodable"></a>
  2847. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  2848. <div class="section-name-container">
  2849. <a class="section-name-link" href="#/Decodable"></a>
  2850. <h3 class="section-name"><span>Decodable</span>
  2851. </h3>
  2852. </div>
  2853. </div>
  2854. <ul class="item-container">
  2855. <li class="item">
  2856. <div>
  2857. <code>
  2858. <a name="/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF"></a>
  2859. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2860. <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>
  2861. </code>
  2862. </div>
  2863. <div class="height-container">
  2864. <div class="pointer-container"></div>
  2865. <section class="section">
  2866. <div class="pointer"></div>
  2867. <div class="abstract">
  2868. <p>Adds a handler using a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to be called once the request has finished.</p>
  2869. </div>
  2870. <div class="declaration">
  2871. <h4>Declaration</h4>
  2872. <div class="language">
  2873. <p class="aside-title">Swift</p>
  2874. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2875. <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>
  2876. <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>
  2877. <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>
  2878. <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>
  2879. <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>
  2880. <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>
  2881. <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>
  2882. </div>
  2883. </div>
  2884. <div>
  2885. <h4>Parameters</h4>
  2886. <table class="graybox">
  2887. <tbody>
  2888. <tr>
  2889. <td>
  2890. <code>
  2891. <em>type</em>
  2892. </code>
  2893. </td>
  2894. <td>
  2895. <div>
  2896. <p><code>Decodable</code> type to decode from response data.</p>
  2897. </div>
  2898. </td>
  2899. </tr>
  2900. <tr>
  2901. <td>
  2902. <code>
  2903. <em>queue</em>
  2904. </code>
  2905. </td>
  2906. <td>
  2907. <div>
  2908. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2909. </div>
  2910. </td>
  2911. </tr>
  2912. <tr>
  2913. <td>
  2914. <code>
  2915. <em>dataPreprocessor</em>
  2916. </code>
  2917. </td>
  2918. <td>
  2919. <div>
  2920. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2921. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2922. </div>
  2923. </td>
  2924. </tr>
  2925. <tr>
  2926. <td>
  2927. <code>
  2928. <em>decoder</em>
  2929. </code>
  2930. </td>
  2931. <td>
  2932. <div>
  2933. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  2934. </div>
  2935. </td>
  2936. </tr>
  2937. <tr>
  2938. <td>
  2939. <code>
  2940. <em>emptyResponseCodes</em>
  2941. </code>
  2942. </td>
  2943. <td>
  2944. <div>
  2945. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2946. </div>
  2947. </td>
  2948. </tr>
  2949. <tr>
  2950. <td>
  2951. <code>
  2952. <em>emptyRequestMethods</em>
  2953. </code>
  2954. </td>
  2955. <td>
  2956. <div>
  2957. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2958. </div>
  2959. </td>
  2960. </tr>
  2961. <tr>
  2962. <td>
  2963. <code>
  2964. <em>completionHandler</em>
  2965. </code>
  2966. </td>
  2967. <td>
  2968. <div>
  2969. <p>A closure to be executed once the request has finished.</p>
  2970. </div>
  2971. </td>
  2972. </tr>
  2973. </tbody>
  2974. </table>
  2975. </div>
  2976. <div>
  2977. <h4>Return Value</h4>
  2978. <p>The request.</p>
  2979. </div>
  2980. </section>
  2981. </div>
  2982. </li>
  2983. </ul>
  2984. </div>
  2985. <div class="task-group">
  2986. <ul class="item-container">
  2987. <li class="item">
  2988. <div>
  2989. <code>
  2990. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  2991. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  2992. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  2993. </code>
  2994. </div>
  2995. <div class="height-container">
  2996. <div class="pointer-container"></div>
  2997. <section class="section">
  2998. <div class="pointer"></div>
  2999. <div class="abstract">
  3000. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  3001. destination URL, and returns whether the request was valid.</p>
  3002. </div>
  3003. <div class="declaration">
  3004. <h4>Declaration</h4>
  3005. <div class="language">
  3006. <p class="aside-title">Swift</p>
  3007. <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>
  3008. <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span>
  3009. <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span>
  3010. <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  3011. </div>
  3012. </div>
  3013. </section>
  3014. </div>
  3015. </li>
  3016. <li class="item">
  3017. <div>
  3018. <code>
  3019. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  3020. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  3021. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  3022. </code>
  3023. </div>
  3024. <div class="height-container">
  3025. <div class="pointer-container"></div>
  3026. <section class="section">
  3027. <div class="pointer"></div>
  3028. <div class="abstract">
  3029. <p>Validates that the response has a status code in the specified sequence.</p>
  3030. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3031. </div>
  3032. <div class="declaration">
  3033. <h4>Declaration</h4>
  3034. <div class="language">
  3035. <p class="aside-title">Swift</p>
  3036. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3037. <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>
  3038. </div>
  3039. </div>
  3040. <div>
  3041. <h4>Parameters</h4>
  3042. <table class="graybox">
  3043. <tbody>
  3044. <tr>
  3045. <td>
  3046. <code>
  3047. <em>acceptableStatusCodes</em>
  3048. </code>
  3049. </td>
  3050. <td>
  3051. <div>
  3052. <p><code>Sequence</code> of acceptable response status codes.</p>
  3053. </div>
  3054. </td>
  3055. </tr>
  3056. </tbody>
  3057. </table>
  3058. </div>
  3059. <div>
  3060. <h4>Return Value</h4>
  3061. <p>The instance.</p>
  3062. </div>
  3063. </section>
  3064. </div>
  3065. </li>
  3066. <li class="item">
  3067. <div>
  3068. <code>
  3069. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  3070. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  3071. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  3072. </code>
  3073. </div>
  3074. <div class="height-container">
  3075. <div class="pointer-container"></div>
  3076. <section class="section">
  3077. <div class="pointer"></div>
  3078. <div class="abstract">
  3079. <p>Validates that the response has a content type in the specified sequence.</p>
  3080. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3081. </div>
  3082. <div class="declaration">
  3083. <h4>Declaration</h4>
  3084. <div class="language">
  3085. <p class="aside-title">Swift</p>
  3086. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3087. <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>
  3088. </div>
  3089. </div>
  3090. <div>
  3091. <h4>Parameters</h4>
  3092. <table class="graybox">
  3093. <tbody>
  3094. <tr>
  3095. <td>
  3096. <code>
  3097. <em>contentType</em>
  3098. </code>
  3099. </td>
  3100. <td>
  3101. <div>
  3102. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  3103. </div>
  3104. </td>
  3105. </tr>
  3106. </tbody>
  3107. </table>
  3108. </div>
  3109. <div>
  3110. <h4>Return Value</h4>
  3111. <p>The request.</p>
  3112. </div>
  3113. </section>
  3114. </div>
  3115. </li>
  3116. <li class="item">
  3117. <div>
  3118. <code>
  3119. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  3120. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  3121. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  3122. </code>
  3123. </div>
  3124. <div class="height-container">
  3125. <div class="pointer-container"></div>
  3126. <section class="section">
  3127. <div class="pointer"></div>
  3128. <div class="abstract">
  3129. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  3130. type matches any specified in the Accept HTTP header field.</p>
  3131. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3132. </div>
  3133. <div class="declaration">
  3134. <h4>Declaration</h4>
  3135. <div class="language">
  3136. <p class="aside-title">Swift</p>
  3137. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3138. <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>
  3139. </div>
  3140. </div>
  3141. <div>
  3142. <h4>Return Value</h4>
  3143. <p>The request.</p>
  3144. </div>
  3145. </section>
  3146. </div>
  3147. </li>
  3148. </ul>
  3149. </div>
  3150. </div>
  3151. </section>
  3152. </article>
  3153. </div>
  3154. <section class="footer">
  3155. <p>&copy; 2022 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2022-11-21)</p>
  3156. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  3157. </section>
  3158. </body>
  3159. </html>