DataRequest.html 181 KB

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