DataRequest.html 162 KB

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