DownloadRequest.html 203 KB

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