DownloadRequest.html 206 KB

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