DataResponse.html 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DataResponse Structure 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/Struct/DataResponse" class="dashAnchor"></a>
  16. <a title="DataResponse Structure 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. DataResponse Structure 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>DataResponse</h1>
  538. <div class="declaration">
  539. <div class="language">
  540. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  541. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DataResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
  542. </div>
  543. </div>
  544. <p>Type used to store all values associated with a serialized response of a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  545. </div>
  546. </section>
  547. <section class="section">
  548. <div class="section-content">
  549. <div class="task-group">
  550. <ul class="item-container">
  551. <li class="item">
  552. <div>
  553. <code>
  554. <a name="/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp"></a>
  555. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  556. <a class="token" href="#/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp">request</a>
  557. </code>
  558. </div>
  559. <div class="height-container">
  560. <div class="pointer-container"></div>
  561. <section class="section">
  562. <div class="pointer"></div>
  563. <div class="abstract">
  564. <p>The URL request sent to the server.</p>
  565. </div>
  566. <div class="declaration">
  567. <h4>Declaration</h4>
  568. <div class="language">
  569. <p class="aside-title">Swift</p>
  570. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span></code></pre>
  571. </div>
  572. </div>
  573. </section>
  574. </div>
  575. </li>
  576. <li class="item">
  577. <div>
  578. <code>
  579. <a name="/s:9Alamofire12DataResponseV8responseSo17NSHTTPURLResponseCSgvp"></a>
  580. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  581. <a class="token" href="#/s:9Alamofire12DataResponseV8responseSo17NSHTTPURLResponseCSgvp">response</a>
  582. </code>
  583. </div>
  584. <div class="height-container">
  585. <div class="pointer-container"></div>
  586. <section class="section">
  587. <div class="pointer"></div>
  588. <div class="abstract">
  589. <p>The server&rsquo;s response to the URL request.</p>
  590. </div>
  591. <div class="declaration">
  592. <h4>Declaration</h4>
  593. <div class="language">
  594. <p class="aside-title">Swift</p>
  595. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?</span></code></pre>
  596. </div>
  597. </div>
  598. </section>
  599. </div>
  600. </li>
  601. <li class="item">
  602. <div>
  603. <code>
  604. <a name="/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp"></a>
  605. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  606. <a class="token" href="#/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp">data</a>
  607. </code>
  608. </div>
  609. <div class="height-container">
  610. <div class="pointer-container"></div>
  611. <section class="section">
  612. <div class="pointer"></div>
  613. <div class="abstract">
  614. <p>The data returned by the server.</p>
  615. </div>
  616. <div class="declaration">
  617. <h4>Declaration</h4>
  618. <div class="language">
  619. <p class="aside-title">Swift</p>
  620. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?</span></code></pre>
  621. </div>
  622. </div>
  623. </section>
  624. </div>
  625. </li>
  626. <li class="item">
  627. <div>
  628. <code>
  629. <a name="/s:9Alamofire12DataResponseV7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  630. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  631. <a class="token" href="#/s:9Alamofire12DataResponseV7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  632. </code>
  633. </div>
  634. <div class="height-container">
  635. <div class="pointer-container"></div>
  636. <section class="section">
  637. <div class="pointer"></div>
  638. <div class="abstract">
  639. <p>The final metrics of the response.</p>
  640. <div class="aside aside-note">
  641. <p class="aside-title">Note</p>
  642. Due to <code>FB7624529</code>, collection of <code>URLSessionTaskMetrics</code> on watchOS is currently disabled.`
  643. </div>
  644. </div>
  645. <div class="declaration">
  646. <h4>Declaration</h4>
  647. <div class="language">
  648. <p class="aside-title">Swift</p>
  649. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span></code></pre>
  650. </div>
  651. </div>
  652. </section>
  653. </div>
  654. </li>
  655. <li class="item">
  656. <div>
  657. <code>
  658. <a name="/s:9Alamofire12DataResponseV21serializationDurationSdvp"></a>
  659. <a name="//apple_ref/swift/Property/serializationDuration" class="dashAnchor"></a>
  660. <a class="token" href="#/s:9Alamofire12DataResponseV21serializationDurationSdvp">serializationDuration</a>
  661. </code>
  662. </div>
  663. <div class="height-container">
  664. <div class="pointer-container"></div>
  665. <section class="section">
  666. <div class="pointer"></div>
  667. <div class="abstract">
  668. <p>The time taken to serialize the response.</p>
  669. </div>
  670. <div class="declaration">
  671. <h4>Declaration</h4>
  672. <div class="language">
  673. <p class="aside-title">Swift</p>
  674. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span></code></pre>
  675. </div>
  676. </div>
  677. </section>
  678. </div>
  679. </li>
  680. <li class="item">
  681. <div>
  682. <code>
  683. <a name="/s:9Alamofire12DataResponseV6results6ResultOyxq_Gvp"></a>
  684. <a name="//apple_ref/swift/Property/result" class="dashAnchor"></a>
  685. <a class="token" href="#/s:9Alamofire12DataResponseV6results6ResultOyxq_Gvp">result</a>
  686. </code>
  687. </div>
  688. <div class="height-container">
  689. <div class="pointer-container"></div>
  690. <section class="section">
  691. <div class="pointer"></div>
  692. <div class="abstract">
  693. <p>The result of response serialization.</p>
  694. </div>
  695. <div class="declaration">
  696. <h4>Declaration</h4>
  697. <div class="language">
  698. <p class="aside-title">Swift</p>
  699. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">result</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span></code></pre>
  700. </div>
  701. </div>
  702. </section>
  703. </div>
  704. </li>
  705. <li class="item">
  706. <div>
  707. <code>
  708. <a name="/s:9Alamofire12DataResponseV5valuexSgvp"></a>
  709. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  710. <a class="token" href="#/s:9Alamofire12DataResponseV5valuexSgvp">value</a>
  711. </code>
  712. </div>
  713. <div class="height-container">
  714. <div class="pointer-container"></div>
  715. <section class="section">
  716. <div class="pointer"></div>
  717. <div class="abstract">
  718. <p>Returns the associated value of the result if it is a success, <code>nil</code> otherwise.</p>
  719. </div>
  720. <div class="declaration">
  721. <h4>Declaration</h4>
  722. <div class="language">
  723. <p class="aside-title">Swift</p>
  724. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Success</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  725. </div>
  726. </div>
  727. </section>
  728. </div>
  729. </li>
  730. <li class="item">
  731. <div>
  732. <code>
  733. <a name="/s:9Alamofire12DataResponseV5errorq_Sgvp"></a>
  734. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  735. <a class="token" href="#/s:9Alamofire12DataResponseV5errorq_Sgvp">error</a>
  736. </code>
  737. </div>
  738. <div class="height-container">
  739. <div class="pointer-container"></div>
  740. <section class="section">
  741. <div class="pointer"></div>
  742. <div class="abstract">
  743. <p>Returns the associated error value if the result if it is a failure, <code>nil</code> otherwise.</p>
  744. </div>
  745. <div class="declaration">
  746. <h4>Declaration</h4>
  747. <div class="language">
  748. <p class="aside-title">Swift</p>
  749. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Failure</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  750. </div>
  751. </div>
  752. </section>
  753. </div>
  754. </li>
  755. <li class="item">
  756. <div>
  757. <code>
  758. <a name="/s:9Alamofire12DataResponseV7request8response4data7metrics21serializationDuration6resultACyxq_G10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgSo23NSURLSessionTaskMetricsCSgSds6ResultOyxq_Gtcfc"></a>
  759. <a name="//apple_ref/swift/Method/init(request:response:data:metrics:serializationDuration:result:)" class="dashAnchor"></a>
  760. <a class="token" href="#/s:9Alamofire12DataResponseV7request8response4data7metrics21serializationDuration6resultACyxq_G10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgSo23NSURLSessionTaskMetricsCSgSds6ResultOyxq_Gtcfc">init(request:<wbr>response:<wbr>data:<wbr>metrics:<wbr>serializationDuration:<wbr>result:<wbr>)</a>
  761. </code>
  762. </div>
  763. <div class="height-container">
  764. <div class="pointer-container"></div>
  765. <section class="section">
  766. <div class="pointer"></div>
  767. <div class="abstract">
  768. <p>Creates a <code>DataResponse</code> instance with the specified parameters derived from the response serialization.</p>
  769. </div>
  770. <div class="declaration">
  771. <h4>Declaration</h4>
  772. <div class="language">
  773. <p class="aside-title">Swift</p>
  774. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span>
  775. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  776. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  777. <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?,</span>
  778. <span class="nv">serializationDuration</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">,</span>
  779. <span class="nv">result</span><span class="p">:</span> <span class="kt">Result</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
  780. </div>
  781. </div>
  782. <div>
  783. <h4>Parameters</h4>
  784. <table class="graybox">
  785. <tbody>
  786. <tr>
  787. <td>
  788. <code>
  789. <em>request</em>
  790. </code>
  791. </td>
  792. <td>
  793. <div>
  794. <p>The <code>URLRequest</code> sent to the server.</p>
  795. </div>
  796. </td>
  797. </tr>
  798. <tr>
  799. <td>
  800. <code>
  801. <em>response</em>
  802. </code>
  803. </td>
  804. <td>
  805. <div>
  806. <p>The <code>HTTPURLResponse</code> from the server.</p>
  807. </div>
  808. </td>
  809. </tr>
  810. <tr>
  811. <td>
  812. <code>
  813. <em>data</em>
  814. </code>
  815. </td>
  816. <td>
  817. <div>
  818. <p>The <code>Data</code> returned by the server.</p>
  819. </div>
  820. </td>
  821. </tr>
  822. <tr>
  823. <td>
  824. <code>
  825. <em>metrics</em>
  826. </code>
  827. </td>
  828. <td>
  829. <div>
  830. <p>The <code>URLSessionTaskMetrics</code> of the <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  831. </div>
  832. </td>
  833. </tr>
  834. <tr>
  835. <td>
  836. <code>
  837. <em>serializationDuration</em>
  838. </code>
  839. </td>
  840. <td>
  841. <div>
  842. <p>The duration taken by serialization.</p>
  843. </div>
  844. </td>
  845. </tr>
  846. <tr>
  847. <td>
  848. <code>
  849. <em>result</em>
  850. </code>
  851. </td>
  852. <td>
  853. <div>
  854. <p>The <code>Result</code> of response serialization.</p>
  855. </div>
  856. </td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. </div>
  861. </section>
  862. </div>
  863. </li>
  864. <li class="item">
  865. <div>
  866. <code>
  867. <a name="/s:9Alamofire12DataResponseV11descriptionSSvp"></a>
  868. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  869. <a class="token" href="#/s:9Alamofire12DataResponseV11descriptionSSvp">description</a>
  870. </code>
  871. </div>
  872. <div class="height-container">
  873. <div class="pointer-container"></div>
  874. <section class="section">
  875. <div class="pointer"></div>
  876. <div class="abstract">
  877. <p>The textual representation used when written to an output stream, which includes whether the result was a
  878. success or failure.</p>
  879. </div>
  880. <div class="declaration">
  881. <h4>Declaration</h4>
  882. <div class="language">
  883. <p class="aside-title">Swift</p>
  884. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  885. </div>
  886. </div>
  887. </section>
  888. </div>
  889. </li>
  890. <li class="item">
  891. <div>
  892. <code>
  893. <a name="/s:9Alamofire12DataResponseV16debugDescriptionSSvp"></a>
  894. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  895. <a class="token" href="#/s:9Alamofire12DataResponseV16debugDescriptionSSvp">debugDescription</a>
  896. </code>
  897. </div>
  898. <div class="height-container">
  899. <div class="pointer-container"></div>
  900. <section class="section">
  901. <div class="pointer"></div>
  902. <div class="abstract">
  903. <p>The debug textual representation used when written to an output stream, which includes (if available) a summary
  904. of the <code>URLRequest</code>, the request&rsquo;s headers and body (if decodable as a <code>String</code> below 100KB); the
  905. <code>HTTPURLResponse</code>&lsquo;s status code, headers, and body; the duration of the network and serialization actions; and
  906. the <code>Result</code> of serialization.</p>
  907. </div>
  908. <div class="declaration">
  909. <h4>Declaration</h4>
  910. <div class="language">
  911. <p class="aside-title">Swift</p>
  912. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  913. </div>
  914. </div>
  915. </section>
  916. </div>
  917. </li>
  918. <li class="item">
  919. <div>
  920. <code>
  921. <a name="/s:9Alamofire12DataResponseV3mapyACyqd__q_Gqd__xXElF"></a>
  922. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  923. <a class="token" href="#/s:9Alamofire12DataResponseV3mapyACyqd__q_Gqd__xXElF">map(_:<wbr>)</a>
  924. </code>
  925. </div>
  926. <div class="height-container">
  927. <div class="pointer-container"></div>
  928. <section class="section">
  929. <div class="pointer"></div>
  930. <div class="abstract">
  931. <p>Evaluates the specified closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped
  932. result value as a parameter.</p>
  933. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  934. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  935. <span class="k">let</span> <span class="nv">possibleInt</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="nv">$0</span><span class="o">.</span><span class="n">count</span> <span class="p">}</span>
  936. </code></pre>
  937. </div>
  938. <div class="declaration">
  939. <h4>Declaration</h4>
  940. <div class="language">
  941. <p class="aside-title">Swift</p>
  942. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">map</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Success</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">NewSuccess</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span></code></pre>
  943. </div>
  944. </div>
  945. <div>
  946. <h4>Parameters</h4>
  947. <table class="graybox">
  948. <tbody>
  949. <tr>
  950. <td>
  951. <code>
  952. <em>transform</em>
  953. </code>
  954. </td>
  955. <td>
  956. <div>
  957. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  958. </div>
  959. </td>
  960. </tr>
  961. </tbody>
  962. </table>
  963. </div>
  964. <div>
  965. <h4>Return Value</h4>
  966. <p>A <code>DataResponse</code> whose result wraps the value returned by the given closure. If this instance&rsquo;s
  967. result is a failure, returns a response wrapping the same failure.</p>
  968. </div>
  969. </section>
  970. </div>
  971. </li>
  972. <li class="item">
  973. <div>
  974. <code>
  975. <a name="/s:9Alamofire12DataResponseV6tryMapyACyqd__s5Error_pGqd__xKXElF"></a>
  976. <a name="//apple_ref/swift/Method/tryMap(_:)" class="dashAnchor"></a>
  977. <a class="token" href="#/s:9Alamofire12DataResponseV6tryMapyACyqd__s5Error_pGqd__xKXElF">tryMap(_:<wbr>)</a>
  978. </code>
  979. </div>
  980. <div class="height-container">
  981. <div class="pointer-container"></div>
  982. <section class="section">
  983. <div class="pointer"></div>
  984. <div class="abstract">
  985. <p>Evaluates the given closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped result
  986. value as a parameter.</p>
  987. <p>Use the <code>tryMap</code> method with a closure that may throw an error. For example:</p>
  988. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  989. <span class="k">let</span> <span class="nv">possibleObject</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">tryMap</span> <span class="p">{</span>
  990. <span class="k">try</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="nf">jsonObject</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="nv">$0</span><span class="p">)</span>
  991. <span class="p">}</span>
  992. </code></pre>
  993. </div>
  994. <div class="declaration">
  995. <h4>Declaration</h4>
  996. <div class="language">
  997. <p class="aside-title">Swift</p>
  998. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">tryMap</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Success</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">NewSuccess</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">NewSuccess</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span></code></pre>
  999. </div>
  1000. </div>
  1001. <div>
  1002. <h4>Parameters</h4>
  1003. <table class="graybox">
  1004. <tbody>
  1005. <tr>
  1006. <td>
  1007. <code>
  1008. <em>transform</em>
  1009. </code>
  1010. </td>
  1011. <td>
  1012. <div>
  1013. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  1014. </div>
  1015. </td>
  1016. </tr>
  1017. </tbody>
  1018. </table>
  1019. </div>
  1020. <div>
  1021. <h4>Return Value</h4>
  1022. <p>A success or failure <code>DataResponse</code> depending on the result of the given closure. If this instance&rsquo;s
  1023. result is a failure, returns the same failure.</p>
  1024. </div>
  1025. </section>
  1026. </div>
  1027. </li>
  1028. <li class="item">
  1029. <div>
  1030. <code>
  1031. <a name="/s:9Alamofire12DataResponseV8mapErroryACyxqd__Gqd__q_XEs0E0Rd__lF"></a>
  1032. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  1033. <a class="token" href="#/s:9Alamofire12DataResponseV8mapErroryACyxqd__Gqd__q_XEs0E0Rd__lF">mapError(_:<wbr>)</a>
  1034. </code>
  1035. </div>
  1036. <div class="height-container">
  1037. <div class="pointer-container"></div>
  1038. <section class="section">
  1039. <div class="pointer"></div>
  1040. <div class="abstract">
  1041. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  1042. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  1043. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  1044. <span class="k">let</span> <span class="nv">withMyError</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">mapError</span> <span class="p">{</span> <span class="kt">MyError</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="nv">$0</span><span class="p">)</span> <span class="p">}</span>
  1045. </code></pre>
  1046. </div>
  1047. <div class="declaration">
  1048. <h4>Declaration</h4>
  1049. <div class="language">
  1050. <p class="aside-title">Swift</p>
  1051. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">mapError</span><span class="o">&lt;</span><span class="kt">NewFailure</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Failure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">NewFailure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">NewFailure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">NewFailure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  1052. </div>
  1053. </div>
  1054. <div>
  1055. <h4>Parameters</h4>
  1056. <table class="graybox">
  1057. <tbody>
  1058. <tr>
  1059. <td>
  1060. <code>
  1061. <em>transform</em>
  1062. </code>
  1063. </td>
  1064. <td>
  1065. <div>
  1066. <p>A closure that takes the error of the instance.</p>
  1067. </div>
  1068. </td>
  1069. </tr>
  1070. </tbody>
  1071. </table>
  1072. </div>
  1073. <div>
  1074. <h4>Return Value</h4>
  1075. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  1076. </div>
  1077. </section>
  1078. </div>
  1079. </li>
  1080. <li class="item">
  1081. <div>
  1082. <code>
  1083. <a name="/s:9Alamofire12DataResponseV11tryMapErroryACyxs0F0_pGqd__q_KXEsAERd__lF"></a>
  1084. <a name="//apple_ref/swift/Method/tryMapError(_:)" class="dashAnchor"></a>
  1085. <a class="token" href="#/s:9Alamofire12DataResponseV11tryMapErroryACyxs0F0_pGqd__q_KXEsAERd__lF">tryMapError(_:<wbr>)</a>
  1086. </code>
  1087. </div>
  1088. <div class="height-container">
  1089. <div class="pointer-container"></div>
  1090. <section class="section">
  1091. <div class="pointer"></div>
  1092. <div class="abstract">
  1093. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  1094. <p>Use the <code>tryMapError</code> function with a closure that may throw an error. For example:</p>
  1095. <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">possibleData</span><span class="p">:</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span> <span class="o">=</span> <span class="o">...</span>
  1096. <span class="k">let</span> <span class="nv">possibleObject</span> <span class="o">=</span> <span class="n">possibleData</span><span class="o">.</span><span class="n">tryMapError</span> <span class="p">{</span>
  1097. <span class="k">try</span> <span class="nf">someFailableFunction</span><span class="p">(</span><span class="nv">taking</span><span class="p">:</span> <span class="nv">$0</span><span class="p">)</span>
  1098. <span class="p">}</span>
  1099. </code></pre>
  1100. </div>
  1101. <div class="declaration">
  1102. <h4>Declaration</h4>
  1103. <div class="language">
  1104. <p class="aside-title">Swift</p>
  1105. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">tryMapError</span><span class="o">&lt;</span><span class="kt">NewFailure</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">Failure</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">NewFailure</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">NewFailure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  1106. </div>
  1107. </div>
  1108. <div>
  1109. <h4>Parameters</h4>
  1110. <table class="graybox">
  1111. <tbody>
  1112. <tr>
  1113. <td>
  1114. <code>
  1115. <em>transform</em>
  1116. </code>
  1117. </td>
  1118. <td>
  1119. <div>
  1120. <p>A throwing closure that takes the error of the instance.</p>
  1121. </div>
  1122. </td>
  1123. </tr>
  1124. </tbody>
  1125. </table>
  1126. </div>
  1127. <div>
  1128. <h4>Return Value</h4>
  1129. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  1130. </div>
  1131. </section>
  1132. </div>
  1133. </li>
  1134. </ul>
  1135. </div>
  1136. </div>
  1137. </section>
  1138. </article>
  1139. </div>
  1140. <section class="footer">
  1141. <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>
  1142. <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>
  1143. </section>
  1144. </body>
  1145. </html>