ResponseSerializer.html 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>ResponseSerializer Protocol 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/Protocol/ResponseSerializer" class="dashAnchor"></a>
  16. <a title="ResponseSerializer Protocol Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.6.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. ResponseSerializer Protocol Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  310. </li>
  311. </ul>
  312. </li>
  313. <li class="nav-group-name">
  314. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  315. <ul class="nav-group-tasks">
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  387. </li>
  388. </ul>
  389. </li>
  390. <li class="nav-group-name">
  391. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  392. <ul class="nav-group-tasks">
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  485. </li>
  486. </ul>
  487. </li>
  488. <li class="nav-group-name">
  489. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  490. <ul class="nav-group-tasks">
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  511. </li>
  512. </ul>
  513. </li>
  514. </ul>
  515. </nav>
  516. <article class="main-content">
  517. <section class="section">
  518. <div class="section-content top-matter">
  519. <h1>ResponseSerializer</h1>
  520. <div class="declaration">
  521. <div class="language">
  522. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ResponseSerializer</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span></code></pre>
  523. </div>
  524. </div>
  525. <p>A serializer that can handle both data and download responses.</p>
  526. </div>
  527. </section>
  528. <section class="section">
  529. <div class="section-content">
  530. <div class="task-group">
  531. <ul class="item-container">
  532. <li class="item">
  533. <div>
  534. <code>
  535. <a name="/s:9Alamofire18ResponseSerializerP16dataPreprocessorAA04DataE0_pvp"></a>
  536. <a name="//apple_ref/swift/Property/dataPreprocessor" class="dashAnchor"></a>
  537. <a class="token" href="#/s:9Alamofire18ResponseSerializerP16dataPreprocessorAA04DataE0_pvp">dataPreprocessor</a>
  538. </code>
  539. <span class="declaration-note">
  540. Default implementation
  541. </span>
  542. </div>
  543. <div class="height-container">
  544. <div class="pointer-container"></div>
  545. <section class="section">
  546. <div class="pointer"></div>
  547. <div class="abstract">
  548. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> used to prepare incoming <code>Data</code> for serialization.</p>
  549. </div>
  550. <h4>Default Implementation</h4>
  551. <div class="default_impl abstract">
  552. </div>
  553. <div class="declaration">
  554. <h4>Declaration</h4>
  555. <div class="language">
  556. <p class="aside-title">Swift</p>
  557. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  558. </div>
  559. </div>
  560. </section>
  561. </div>
  562. </li>
  563. <li class="item">
  564. <div>
  565. <code>
  566. <a name="/s:9Alamofire18ResponseSerializerP19emptyRequestMethodsShyAA10HTTPMethodVGvp"></a>
  567. <a name="//apple_ref/swift/Property/emptyRequestMethods" class="dashAnchor"></a>
  568. <a class="token" href="#/s:9Alamofire18ResponseSerializerP19emptyRequestMethodsShyAA10HTTPMethodVGvp">emptyRequestMethods</a>
  569. </code>
  570. <span class="declaration-note">
  571. Default implementation
  572. </span>
  573. </div>
  574. <div class="height-container">
  575. <div class="pointer-container"></div>
  576. <section class="section">
  577. <div class="pointer"></div>
  578. <div class="abstract">
  579. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty response bodies are considered appropriate.</p>
  580. </div>
  581. <h4>Default Implementation</h4>
  582. <div class="default_impl abstract">
  583. </div>
  584. <div class="declaration">
  585. <h4>Declaration</h4>
  586. <div class="language">
  587. <p class="aside-title">Swift</p>
  588. <pre class="highlight swift"><code><span class="k">var</span> <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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  589. </div>
  590. </div>
  591. </section>
  592. </div>
  593. </li>
  594. <li class="item">
  595. <div>
  596. <code>
  597. <a name="/s:9Alamofire18ResponseSerializerP05emptyB5CodesShySiGvp"></a>
  598. <a name="//apple_ref/swift/Property/emptyResponseCodes" class="dashAnchor"></a>
  599. <a class="token" href="#/s:9Alamofire18ResponseSerializerP05emptyB5CodesShySiGvp">emptyResponseCodes</a>
  600. </code>
  601. <span class="declaration-note">
  602. Default implementation
  603. </span>
  604. </div>
  605. <div class="height-container">
  606. <div class="pointer-container"></div>
  607. <section class="section">
  608. <div class="pointer"></div>
  609. <div class="abstract">
  610. <p>HTTP response codes for which empty response bodies are considered appropriate.</p>
  611. </div>
  612. <h4>Default Implementation</h4>
  613. <div class="default_impl abstract">
  614. </div>
  615. <div class="declaration">
  616. <h4>Declaration</h4>
  617. <div class="language">
  618. <p class="aside-title">Swift</p>
  619. <pre class="highlight swift"><code><span class="k">var</span> <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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  620. </div>
  621. </div>
  622. </section>
  623. </div>
  624. </li>
  625. </ul>
  626. </div>
  627. <div class="task-group">
  628. <div class="task-name-container">
  629. <a name="/Protocols"></a>
  630. <a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
  631. <div class="section-name-container">
  632. <a class="section-name-link" href="#/Protocols"></a>
  633. <h3 class="section-name"><span>Protocols</span>
  634. </h3>
  635. </div>
  636. </div>
  637. <ul class="item-container">
  638. <li class="item">
  639. <div>
  640. <code>
  641. <a name="/s:9Alamofire18ResponseSerializerPAAE23defaultDataPreprocessorAA0eF0_pvpZ"></a>
  642. <a name="//apple_ref/swift/Variable/defaultDataPreprocessor" class="dashAnchor"></a>
  643. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE23defaultDataPreprocessorAA0eF0_pvpZ">defaultDataPreprocessor</a>
  644. </code>
  645. <span class="declaration-note">
  646. Extension method
  647. </span>
  648. </div>
  649. <div class="height-container">
  650. <div class="pointer-container"></div>
  651. <section class="section">
  652. <div class="pointer"></div>
  653. <div class="abstract">
  654. <p>Default <code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code>. <code><a href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a></code> by default.</p>
  655. </div>
  656. <div class="declaration">
  657. <h4>Declaration</h4>
  658. <div class="language">
  659. <p class="aside-title">Swift</p>
  660. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">defaultDataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  661. </div>
  662. </div>
  663. </section>
  664. </div>
  665. </li>
  666. <li class="item">
  667. <div>
  668. <code>
  669. <a name="/s:9Alamofire18ResponseSerializerPAAE26defaultEmptyRequestMethodsShyAA10HTTPMethodVGvpZ"></a>
  670. <a name="//apple_ref/swift/Variable/defaultEmptyRequestMethods" class="dashAnchor"></a>
  671. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE26defaultEmptyRequestMethodsShyAA10HTTPMethodVGvpZ">defaultEmptyRequestMethods</a>
  672. </code>
  673. <span class="declaration-note">
  674. Extension method
  675. </span>
  676. </div>
  677. <div class="height-container">
  678. <div class="pointer-container"></div>
  679. <section class="section">
  680. <div class="pointer"></div>
  681. <div class="abstract">
  682. <p>Default <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty response bodies are considered appropriate. <code>[.head]</code> by default.</p>
  683. </div>
  684. <div class="declaration">
  685. <h4>Declaration</h4>
  686. <div class="language">
  687. <p class="aside-title">Swift</p>
  688. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">defaultEmptyRequestMethods</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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  689. </div>
  690. </div>
  691. </section>
  692. </div>
  693. </li>
  694. <li class="item">
  695. <div>
  696. <code>
  697. <a name="/s:9Alamofire18ResponseSerializerPAAE012defaultEmptyB5CodesShySiGvpZ"></a>
  698. <a name="//apple_ref/swift/Variable/defaultEmptyResponseCodes" class="dashAnchor"></a>
  699. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE012defaultEmptyB5CodesShySiGvpZ">defaultEmptyResponseCodes</a>
  700. </code>
  701. <span class="declaration-note">
  702. Extension method
  703. </span>
  704. </div>
  705. <div class="height-container">
  706. <div class="pointer-container"></div>
  707. <section class="section">
  708. <div class="pointer"></div>
  709. <div class="abstract">
  710. <p>HTTP response codes for which empty response bodies are considered appropriate. <code>[204, 205]</code> by default.</p>
  711. </div>
  712. <div class="declaration">
  713. <h4>Declaration</h4>
  714. <div class="language">
  715. <p class="aside-title">Swift</p>
  716. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">defaultEmptyResponseCodes</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="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  717. </div>
  718. </div>
  719. </section>
  720. </div>
  721. </li>
  722. <li class="item">
  723. <div>
  724. <code>
  725. <a name="/s:9Alamofire18ResponseSerializerPAAE018requestAllowsEmptyB4DataySbSg10Foundation10URLRequestVSgF"></a>
  726. <a name="//apple_ref/swift/Method/requestAllowsEmptyResponseData(_:)" class="dashAnchor"></a>
  727. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE018requestAllowsEmptyB4DataySbSg10Foundation10URLRequestVSgF">requestAllowsEmptyResponseData(_:<wbr>)</a>
  728. </code>
  729. <span class="declaration-note">
  730. Extension method
  731. </span>
  732. </div>
  733. <div class="height-container">
  734. <div class="pointer-container"></div>
  735. <section class="section">
  736. <div class="pointer"></div>
  737. <div class="abstract">
  738. <p>Determines whether the <code>request</code> allows empty response bodies, if <code>request</code> exists.</p>
  739. </div>
  740. <div class="declaration">
  741. <h4>Declaration</h4>
  742. <div class="language">
  743. <p class="aside-title">Swift</p>
  744. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">requestAllowsEmptyResponseData</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span><span class="p">?</span></code></pre>
  745. </div>
  746. </div>
  747. <div>
  748. <h4>Parameters</h4>
  749. <table class="graybox">
  750. <tbody>
  751. <tr>
  752. <td>
  753. <code>
  754. <em>request</em>
  755. </code>
  756. </td>
  757. <td>
  758. <div>
  759. <p><code>URLRequest</code> to evaluate.</p>
  760. </div>
  761. </td>
  762. </tr>
  763. </tbody>
  764. </table>
  765. </div>
  766. <div>
  767. <h4>Return Value</h4>
  768. <p><code>Bool</code> representing the outcome of the evaluation, or <code>nil</code> if <code>request</code> was <code>nil</code>.</p>
  769. </div>
  770. </section>
  771. </div>
  772. </li>
  773. <li class="item">
  774. <div>
  775. <code>
  776. <a name="/s:9Alamofire18ResponseSerializerPAAE019responseAllowsEmptyB4DataySbSgSo17NSHTTPURLResponseCSgF"></a>
  777. <a name="//apple_ref/swift/Method/responseAllowsEmptyResponseData(_:)" class="dashAnchor"></a>
  778. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE019responseAllowsEmptyB4DataySbSgSo17NSHTTPURLResponseCSgF">responseAllowsEmptyResponseData(_:<wbr>)</a>
  779. </code>
  780. <span class="declaration-note">
  781. Extension method
  782. </span>
  783. </div>
  784. <div class="height-container">
  785. <div class="pointer-container"></div>
  786. <section class="section">
  787. <div class="pointer"></div>
  788. <div class="abstract">
  789. <p>Determines whether the <code>response</code> allows empty response bodies, if <code>response</code> exists`.</p>
  790. </div>
  791. <div class="declaration">
  792. <h4>Declaration</h4>
  793. <div class="language">
  794. <p class="aside-title">Swift</p>
  795. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseAllowsEmptyResponseData</span><span class="p">(</span><span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span><span class="p">?</span></code></pre>
  796. </div>
  797. </div>
  798. <div>
  799. <h4>Parameters</h4>
  800. <table class="graybox">
  801. <tbody>
  802. <tr>
  803. <td>
  804. <code>
  805. <em>response</em>
  806. </code>
  807. </td>
  808. <td>
  809. <div>
  810. <p><code>HTTPURLResponse</code> to evaluate.</p>
  811. </div>
  812. </td>
  813. </tr>
  814. </tbody>
  815. </table>
  816. </div>
  817. <div>
  818. <h4>Return Value</h4>
  819. <p><code>Bool</code> representing the outcome of the evaluation, or <code>nil</code> if <code>response</code> was <code>nil</code>.</p>
  820. </div>
  821. </section>
  822. </div>
  823. </li>
  824. <li class="item">
  825. <div>
  826. <code>
  827. <a name="/s:9Alamofire18ResponseSerializerPAAE05emptyB7Allowed10forRequest8responseSb10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgtF"></a>
  828. <a name="//apple_ref/swift/Method/emptyResponseAllowed(forRequest:response:)" class="dashAnchor"></a>
  829. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE05emptyB7Allowed10forRequest8responseSb10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgtF">emptyResponseAllowed(forRequest:<wbr>response:<wbr>)</a>
  830. </code>
  831. <span class="declaration-note">
  832. Extension method
  833. </span>
  834. </div>
  835. <div class="height-container">
  836. <div class="pointer-container"></div>
  837. <section class="section">
  838. <div class="pointer"></div>
  839. <div class="abstract">
  840. <p>Determines whether <code>request</code> and <code>response</code> allow empty response bodies.</p>
  841. </div>
  842. <div class="declaration">
  843. <h4>Declaration</h4>
  844. <div class="language">
  845. <p class="aside-title">Swift</p>
  846. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">emptyResponseAllowed</span><span class="p">(</span><span class="n">forRequest</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  847. </div>
  848. </div>
  849. <div>
  850. <h4>Parameters</h4>
  851. <table class="graybox">
  852. <tbody>
  853. <tr>
  854. <td>
  855. <code>
  856. <em>request</em>
  857. </code>
  858. </td>
  859. <td>
  860. <div>
  861. <p><code>URLRequest</code> to evaluate.</p>
  862. </div>
  863. </td>
  864. </tr>
  865. <tr>
  866. <td>
  867. <code>
  868. <em>response</em>
  869. </code>
  870. </td>
  871. <td>
  872. <div>
  873. <p><code>HTTPURLResponse</code> to evaluate.</p>
  874. </div>
  875. </td>
  876. </tr>
  877. </tbody>
  878. </table>
  879. </div>
  880. <div>
  881. <h4>Return Value</h4>
  882. <p><code>true</code> if <code>request</code> or <code>response</code> allow empty bodies, <code>false</code> otherwise.</p>
  883. </div>
  884. </section>
  885. </div>
  886. </li>
  887. </ul>
  888. </div>
  889. <div class="task-group">
  890. <div class="task-name-container">
  891. <a name="/Decodable"></a>
  892. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  893. <div class="section-name-container">
  894. <a class="section-name-link" href="#/Decodable"></a>
  895. <h3 class="section-name"><span>Decodable</span>
  896. </h3>
  897. </div>
  898. </div>
  899. <ul class="item-container">
  900. <li class="item">
  901. <div>
  902. <code>
  903. <a name="/s:9Alamofire18ResponseSerializerPAAE9decodable2of16dataPreprocessor7decoder05emptyB5Codes0I14RequestMethodsAA09DecodablebC0Cyqd__Gqd__m_AA04DataG0_pAA0N7Decoder_pShySiGShyAA10HTTPMethodVGtALRszSeRd__lFZ"></a>
  904. <a name="//apple_ref/swift/Method/decodable(of:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  905. <a class="token" href="#/s:9Alamofire18ResponseSerializerPAAE9decodable2of16dataPreprocessor7decoder05emptyB5Codes0I14RequestMethodsAA09DecodablebC0Cyqd__Gqd__m_AA04DataG0_pAA0N7Decoder_pShySiGShyAA10HTTPMethodVGtALRszSeRd__lFZ">decodable(of:<wbr>dataPreprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  906. </code>
  907. <span class="declaration-note">
  908. Extension method
  909. </span>
  910. </div>
  911. <div class="height-container">
  912. <div class="pointer-container"></div>
  913. <section class="section">
  914. <div class="pointer"></div>
  915. <div class="abstract">
  916. <p>Creates a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> using the values provided.</p>
  917. </div>
  918. <div class="declaration">
  919. <h4>Declaration</h4>
  920. <div class="language">
  921. <p class="aside-title">Swift</p>
  922. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">decodable</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="p">,</span>
  923. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE23defaultDataPreprocessorAA0eF0_pvpZ">defaultDataPreprocessor</a></span><span class="p">,</span>
  924. <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>
  925. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE012defaultEmptyB5CodesShySiGvpZ">defaultEmptyResponseCodes</a></span><span class="p">,</span>
  926. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE26defaultEmptyRequestMethodsShyAA10HTTPMethodVGvpZ">defaultEmptyRequestMethods</a></span><span class="p">)</span> <span class="o">-&gt;</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="k">where</span> <span class="k">Self</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></code></pre>
  927. </div>
  928. </div>
  929. <div>
  930. <h4>Parameters</h4>
  931. <table class="graybox">
  932. <tbody>
  933. <tr>
  934. <td>
  935. <code>
  936. <em>type</em>
  937. </code>
  938. </td>
  939. <td>
  940. <div>
  941. <p><code>Decodable</code> type to decode from response data.</p>
  942. </div>
  943. </td>
  944. </tr>
  945. <tr>
  946. <td>
  947. <code>
  948. <em>dataPreprocessor</em>
  949. </code>
  950. </td>
  951. <td>
  952. <div>
  953. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> used to prepare the received <code>Data</code> for serialization.</p>
  954. </div>
  955. </td>
  956. </tr>
  957. <tr>
  958. <td>
  959. <code>
  960. <em>decoder</em>
  961. </code>
  962. </td>
  963. <td>
  964. <div>
  965. <p>The <code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code>. <code>JSONDecoder()</code> by default.</p>
  966. </div>
  967. </td>
  968. </tr>
  969. <tr>
  970. <td>
  971. <code>
  972. <em>emptyResponseCodes</em>
  973. </code>
  974. </td>
  975. <td>
  976. <div>
  977. <p>The HTTP response codes for which empty responses are allowed. <code>[204, 205]</code> by default.</p>
  978. </div>
  979. </td>
  980. </tr>
  981. <tr>
  982. <td>
  983. <code>
  984. <em>emptyRequestMethods</em>
  985. </code>
  986. </td>
  987. <td>
  988. <div>
  989. <p>The HTTP request methods for which empty responses are allowed. <code>[.head]</code> by default.</p>
  990. </div>
  991. </td>
  992. </tr>
  993. </tbody>
  994. </table>
  995. </div>
  996. <div>
  997. <h4>Return Value</h4>
  998. <p>The <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code>.</p>
  999. </div>
  1000. </section>
  1001. </div>
  1002. </li>
  1003. </ul>
  1004. </div>
  1005. <div class="task-group">
  1006. <div class="task-name-container">
  1007. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60DataResponseSerializer%60"></a>
  1008. <a name="//apple_ref/swift/Section/Available where `Self` == `DataResponseSerializer`" class="dashAnchor"></a>
  1009. <div class="section-name-container">
  1010. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60DataResponseSerializer%60"></a>
  1011. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code></span>
  1012. </h3>
  1013. </div>
  1014. </div>
  1015. <ul class="item-container">
  1016. <li class="item">
  1017. <div>
  1018. <code>
  1019. <a name="/s:9Alamofire18ResponseSerializerPA2A04DatabC0CRszrlE4dataAEvpZ"></a>
  1020. <a name="//apple_ref/swift/Variable/data" class="dashAnchor"></a>
  1021. <a class="token" href="#/s:9Alamofire18ResponseSerializerPA2A04DatabC0CRszrlE4dataAEvpZ">data</a>
  1022. </code>
  1023. <span class="declaration-note">
  1024. Extension method
  1025. </span>
  1026. </div>
  1027. <div class="height-container">
  1028. <div class="pointer-container"></div>
  1029. <section class="section">
  1030. <div class="pointer"></div>
  1031. <div class="abstract">
  1032. <p>Provides a default <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> instance.</p>
  1033. </div>
  1034. <div class="declaration">
  1035. <h4>Declaration</h4>
  1036. <div class="language">
  1037. <p class="aside-title">Swift</p>
  1038. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1039. </div>
  1040. </div>
  1041. </section>
  1042. </div>
  1043. </li>
  1044. <li class="item">
  1045. <div>
  1046. <code>
  1047. <a name="/s:9Alamofire18ResponseSerializerPA2A04DatabC0CRszrlE4data0E12Preprocessor05emptyB5Codes0G14RequestMethodsAeA0dF0_p_ShySiGShyAA10HTTPMethodVGtFZ"></a>
  1048. <a name="//apple_ref/swift/Method/data(dataPreprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1049. <a class="token" href="#/s:9Alamofire18ResponseSerializerPA2A04DatabC0CRszrlE4data0E12Preprocessor05emptyB5Codes0G14RequestMethodsAeA0dF0_p_ShySiGShyAA10HTTPMethodVGtFZ">data(dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1050. </code>
  1051. <span class="declaration-note">
  1052. Extension method
  1053. </span>
  1054. </div>
  1055. <div class="height-container">
  1056. <div class="pointer-container"></div>
  1057. <section class="section">
  1058. <div class="pointer"></div>
  1059. <div class="abstract">
  1060. <p>Creates a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> using the provided parameters.</p>
  1061. </div>
  1062. <div class="declaration">
  1063. <h4>Declaration</h4>
  1064. <div class="language">
  1065. <p class="aside-title">Swift</p>
  1066. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">(</span><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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE23defaultDataPreprocessorAA0eF0_pvpZ">defaultDataPreprocessor</a></span><span class="p">,</span>
  1067. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE012defaultEmptyB5CodesShySiGvpZ">defaultEmptyResponseCodes</a></span><span class="p">,</span>
  1068. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE26defaultEmptyRequestMethodsShyAA10HTTPMethodVGvpZ">defaultEmptyRequestMethods</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span></code></pre>
  1069. </div>
  1070. </div>
  1071. <div>
  1072. <h4>Parameters</h4>
  1073. <table class="graybox">
  1074. <tbody>
  1075. <tr>
  1076. <td>
  1077. <code>
  1078. <em>dataPreprocessor</em>
  1079. </code>
  1080. </td>
  1081. <td>
  1082. <div>
  1083. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> used to prepare the received <code>Data</code> for serialization.</p>
  1084. </div>
  1085. </td>
  1086. </tr>
  1087. <tr>
  1088. <td>
  1089. <code>
  1090. <em>emptyResponseCodes</em>
  1091. </code>
  1092. </td>
  1093. <td>
  1094. <div>
  1095. <p>The HTTP response codes for which empty responses are allowed. <code>[204, 205]</code> by default.</p>
  1096. </div>
  1097. </td>
  1098. </tr>
  1099. <tr>
  1100. <td>
  1101. <code>
  1102. <em>emptyRequestMethods</em>
  1103. </code>
  1104. </td>
  1105. <td>
  1106. <div>
  1107. <p>The HTTP request methods for which empty responses are allowed. <code>[.head]</code> by default.</p>
  1108. </div>
  1109. </td>
  1110. </tr>
  1111. </tbody>
  1112. </table>
  1113. </div>
  1114. <div>
  1115. <h4>Return Value</h4>
  1116. <p>The <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code>.</p>
  1117. </div>
  1118. </section>
  1119. </div>
  1120. </li>
  1121. </ul>
  1122. </div>
  1123. <div class="task-group">
  1124. <div class="task-name-container">
  1125. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60StringResponseSerializer%60"></a>
  1126. <a name="//apple_ref/swift/Section/Available where `Self` == `StringResponseSerializer`" class="dashAnchor"></a>
  1127. <div class="section-name-container">
  1128. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60StringResponseSerializer%60"></a>
  1129. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code></span>
  1130. </h3>
  1131. </div>
  1132. </div>
  1133. <ul class="item-container">
  1134. <li class="item">
  1135. <div>
  1136. <code>
  1137. <a name="/s:9Alamofire18ResponseSerializerPA2A06StringbC0CRszrlE6stringAEvpZ"></a>
  1138. <a name="//apple_ref/swift/Variable/string" class="dashAnchor"></a>
  1139. <a class="token" href="#/s:9Alamofire18ResponseSerializerPA2A06StringbC0CRszrlE6stringAEvpZ">string</a>
  1140. </code>
  1141. <span class="declaration-note">
  1142. Extension method
  1143. </span>
  1144. </div>
  1145. <div class="height-container">
  1146. <div class="pointer-container"></div>
  1147. <section class="section">
  1148. <div class="pointer"></div>
  1149. <div class="abstract">
  1150. <p>Provides a default <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> instance.</p>
  1151. </div>
  1152. <div class="declaration">
  1153. <h4>Declaration</h4>
  1154. <div class="language">
  1155. <p class="aside-title">Swift</p>
  1156. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">string</span><span class="p">:</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1157. </div>
  1158. </div>
  1159. </section>
  1160. </div>
  1161. </li>
  1162. <li class="item">
  1163. <div>
  1164. <code>
  1165. <a name="/s:9Alamofire18ResponseSerializerPA2A06StringbC0CRszrlE6string16dataPreprocessor8encoding05emptyB5Codes0I14RequestMethodsAeA04DataG0_p_SS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtFZ"></a>
  1166. <a name="//apple_ref/swift/Method/string(dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1167. <a class="token" href="#/s:9Alamofire18ResponseSerializerPA2A06StringbC0CRszrlE6string16dataPreprocessor8encoding05emptyB5Codes0I14RequestMethodsAeA04DataG0_p_SS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtFZ">string(dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1168. </code>
  1169. <span class="declaration-note">
  1170. Extension method
  1171. </span>
  1172. </div>
  1173. <div class="height-container">
  1174. <div class="pointer-container"></div>
  1175. <section class="section">
  1176. <div class="pointer"></div>
  1177. <div class="abstract">
  1178. <p>Creates a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> with the provided values.</p>
  1179. </div>
  1180. <div class="declaration">
  1181. <h4>Declaration</h4>
  1182. <div class="language">
  1183. <p class="aside-title">Swift</p>
  1184. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">string</span><span class="p">(</span><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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE23defaultDataPreprocessorAA0eF0_pvpZ">defaultDataPreprocessor</a></span><span class="p">,</span>
  1185. <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>
  1186. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE012defaultEmptyB5CodesShySiGvpZ">defaultEmptyResponseCodes</a></span><span class="p">,</span>
  1187. <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"><a href="../Protocols/ResponseSerializer.html#/s:9Alamofire18ResponseSerializerPAAE26defaultEmptyRequestMethodsShyAA10HTTPMethodVGvpZ">defaultEmptyRequestMethods</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span></code></pre>
  1188. </div>
  1189. </div>
  1190. <div>
  1191. <h4>Parameters</h4>
  1192. <table class="graybox">
  1193. <tbody>
  1194. <tr>
  1195. <td>
  1196. <code>
  1197. <em>dataPreprocessor</em>
  1198. </code>
  1199. </td>
  1200. <td>
  1201. <div>
  1202. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> used to prepare the received <code>Data</code> for serialization.</p>
  1203. </div>
  1204. </td>
  1205. </tr>
  1206. <tr>
  1207. <td>
  1208. <code>
  1209. <em>encoding</em>
  1210. </code>
  1211. </td>
  1212. <td>
  1213. <div>
  1214. <p>A string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  1215. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1216. </div>
  1217. </td>
  1218. </tr>
  1219. <tr>
  1220. <td>
  1221. <code>
  1222. <em>emptyResponseCodes</em>
  1223. </code>
  1224. </td>
  1225. <td>
  1226. <div>
  1227. <p>The HTTP response codes for which empty responses are allowed. <code>[204, 205]</code> by default.</p>
  1228. </div>
  1229. </td>
  1230. </tr>
  1231. <tr>
  1232. <td>
  1233. <code>
  1234. <em>emptyRequestMethods</em>
  1235. </code>
  1236. </td>
  1237. <td>
  1238. <div>
  1239. <p>The HTTP request methods for which empty responses are allowed. <code>[.head]</code> by default.</p>
  1240. </div>
  1241. </td>
  1242. </tr>
  1243. </tbody>
  1244. </table>
  1245. </div>
  1246. <div>
  1247. <h4>Return Value</h4>
  1248. <p>The <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code>.</p>
  1249. </div>
  1250. </section>
  1251. </div>
  1252. </li>
  1253. </ul>
  1254. </div>
  1255. </div>
  1256. </section>
  1257. </article>
  1258. </div>
  1259. <section class="footer">
  1260. <p>&copy; 2022 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2022-04-17)</p>
  1261. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1262. </section>
  1263. </body>
  1264. </html>