DataResponse.html 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954
  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 Docs
  21. </a>
  22. (86% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  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"/>
  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%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  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" />
  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/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>DataResponse</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <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">Value</span><span class="o">&gt;</span></code></pre>
  304. </div>
  305. </div>
  306. <p>Used to store all data associated with a serialized response of a data or upload request.</p>
  307. </div>
  308. </section>
  309. <section class="section">
  310. <div class="section-content">
  311. <div class="task-group">
  312. <ul class="item-container">
  313. <li class="item">
  314. <div>
  315. <code>
  316. <a name="/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp"></a>
  317. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  318. <a class="token" href="#/s:9Alamofire12DataResponseV7request10Foundation10URLRequestVSgvp">request</a>
  319. </code>
  320. </div>
  321. <div class="height-container">
  322. <div class="pointer-container"></div>
  323. <section class="section">
  324. <div class="pointer"></div>
  325. <div class="abstract">
  326. <p>The URL request sent to the server.</p>
  327. </div>
  328. <div class="declaration">
  329. <h4>Declaration</h4>
  330. <div class="language">
  331. <p class="aside-title">Swift</p>
  332. <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>
  333. </div>
  334. </div>
  335. </section>
  336. </div>
  337. </li>
  338. <li class="item">
  339. <div>
  340. <code>
  341. <a name="/s:9Alamofire12DataResponseV8responseSo15HTTPURLResponseCSgvp"></a>
  342. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  343. <a class="token" href="#/s:9Alamofire12DataResponseV8responseSo15HTTPURLResponseCSgvp">response</a>
  344. </code>
  345. </div>
  346. <div class="height-container">
  347. <div class="pointer-container"></div>
  348. <section class="section">
  349. <div class="pointer"></div>
  350. <div class="abstract">
  351. <p>The server&rsquo;s response to the URL request.</p>
  352. </div>
  353. <div class="declaration">
  354. <h4>Declaration</h4>
  355. <div class="language">
  356. <p class="aside-title">Swift</p>
  357. <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>
  358. </div>
  359. </div>
  360. </section>
  361. </div>
  362. </li>
  363. <li class="item">
  364. <div>
  365. <code>
  366. <a name="/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp"></a>
  367. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  368. <a class="token" href="#/s:9Alamofire12DataResponseV4data10Foundation0B0VSgvp">data</a>
  369. </code>
  370. </div>
  371. <div class="height-container">
  372. <div class="pointer-container"></div>
  373. <section class="section">
  374. <div class="pointer"></div>
  375. <div class="abstract">
  376. <p>The data returned by the server.</p>
  377. </div>
  378. <div class="declaration">
  379. <h4>Declaration</h4>
  380. <div class="language">
  381. <p class="aside-title">Swift</p>
  382. <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>
  383. </div>
  384. </div>
  385. </section>
  386. </div>
  387. </li>
  388. <li class="item">
  389. <div>
  390. <code>
  391. <a name="/s:9Alamofire12DataResponseV6resultAA6ResultOyxGvp"></a>
  392. <a name="//apple_ref/swift/Property/result" class="dashAnchor"></a>
  393. <a class="token" href="#/s:9Alamofire12DataResponseV6resultAA6ResultOyxGvp">result</a>
  394. </code>
  395. </div>
  396. <div class="height-container">
  397. <div class="pointer-container"></div>
  398. <section class="section">
  399. <div class="pointer"></div>
  400. <div class="abstract">
  401. <p>The result of response serialization.</p>
  402. </div>
  403. <div class="declaration">
  404. <h4>Declaration</h4>
  405. <div class="language">
  406. <p class="aside-title">Swift</p>
  407. <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"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  408. </div>
  409. </div>
  410. </section>
  411. </div>
  412. </li>
  413. <li class="item">
  414. <div>
  415. <code>
  416. <a name="/s:9Alamofire12DataResponseV8timelineAA8TimelineVvp"></a>
  417. <a name="//apple_ref/swift/Property/timeline" class="dashAnchor"></a>
  418. <a class="token" href="#/s:9Alamofire12DataResponseV8timelineAA8TimelineVvp">timeline</a>
  419. </code>
  420. </div>
  421. <div class="height-container">
  422. <div class="pointer-container"></div>
  423. <section class="section">
  424. <div class="pointer"></div>
  425. <div class="abstract">
  426. <p>The timeline of the complete lifecycle of the request.</p>
  427. </div>
  428. <div class="declaration">
  429. <h4>Declaration</h4>
  430. <div class="language">
  431. <p class="aside-title">Swift</p>
  432. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">timeline</span><span class="p">:</span> <span class="kt"><a href="../Structs/Timeline.html">Timeline</a></span></code></pre>
  433. </div>
  434. </div>
  435. </section>
  436. </div>
  437. </li>
  438. <li class="item">
  439. <div>
  440. <code>
  441. <a name="/s:9Alamofire12DataResponseV5valuexSgvp"></a>
  442. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  443. <a class="token" href="#/s:9Alamofire12DataResponseV5valuexSgvp">value</a>
  444. </code>
  445. </div>
  446. <div class="height-container">
  447. <div class="pointer-container"></div>
  448. <section class="section">
  449. <div class="pointer"></div>
  450. <div class="abstract">
  451. <p>Returns the associated value of the result if it is a success, <code>nil</code> otherwise.</p>
  452. </div>
  453. <div class="declaration">
  454. <h4>Declaration</h4>
  455. <div class="language">
  456. <p class="aside-title">Swift</p>
  457. <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">Value</span><span class="p">?</span></code></pre>
  458. </div>
  459. </div>
  460. </section>
  461. </div>
  462. </li>
  463. <li class="item">
  464. <div>
  465. <code>
  466. <a name="/s:9Alamofire12DataResponseV5errors5Error_pSgvp"></a>
  467. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  468. <a class="token" href="#/s:9Alamofire12DataResponseV5errors5Error_pSgvp">error</a>
  469. </code>
  470. </div>
  471. <div class="height-container">
  472. <div class="pointer-container"></div>
  473. <section class="section">
  474. <div class="pointer"></div>
  475. <div class="abstract">
  476. <p>Returns the associated error value if the result if it is a failure, <code>nil</code> otherwise.</p>
  477. </div>
  478. <div class="declaration">
  479. <h4>Declaration</h4>
  480. <div class="language">
  481. <p class="aside-title">Swift</p>
  482. <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">Error</span><span class="p">?</span></code></pre>
  483. </div>
  484. </div>
  485. </section>
  486. </div>
  487. </li>
  488. <li class="item">
  489. <div>
  490. <code>
  491. <a name="/s:9Alamofire12DataResponseVACyxG10Foundation10URLRequestVSg7request_So15HTTPURLResponseCSg8responseAE0B0VSg4dataAA6ResultOyxG6resultAA8TimelineV8timelinetcfc"></a>
  492. <a name="//apple_ref/swift/Method/init(request:response:data:result:timeline:)" class="dashAnchor"></a>
  493. <a class="token" href="#/s:9Alamofire12DataResponseVACyxG10Foundation10URLRequestVSg7request_So15HTTPURLResponseCSg8responseAE0B0VSg4dataAA6ResultOyxG6resultAA8TimelineV8timelinetcfc">init(request:response:data:result:timeline:)</a>
  494. </code>
  495. </div>
  496. <div class="height-container">
  497. <div class="pointer-container"></div>
  498. <section class="section">
  499. <div class="pointer"></div>
  500. <div class="abstract">
  501. <p>Creates a <code>DataResponse</code> instance with the specified parameters derived from response serialization.</p>
  502. </div>
  503. <div class="declaration">
  504. <h4>Declaration</h4>
  505. <div class="language">
  506. <p class="aside-title">Swift</p>
  507. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span>
  508. <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span>
  509. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  510. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  511. <span class="nv">result</span><span class="p">:</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span><span class="p">,</span>
  512. <span class="nv">timeline</span><span class="p">:</span> <span class="kt"><a href="../Structs/Timeline.html">Timeline</a></span> <span class="o">=</span> <span class="kt"><a href="../Structs/Timeline.html">Timeline</a></span><span class="p">())</span></code></pre>
  513. </div>
  514. </div>
  515. <div>
  516. <h4>Parameters</h4>
  517. <table class="graybox">
  518. <tbody>
  519. <tr>
  520. <td>
  521. <code>
  522. <em>request</em>
  523. </code>
  524. </td>
  525. <td>
  526. <div>
  527. <p>The URL request sent to the server.</p>
  528. </div>
  529. </td>
  530. </tr>
  531. <tr>
  532. <td>
  533. <code>
  534. <em>response</em>
  535. </code>
  536. </td>
  537. <td>
  538. <div>
  539. <p>The server&rsquo;s response to the URL request.</p>
  540. </div>
  541. </td>
  542. </tr>
  543. <tr>
  544. <td>
  545. <code>
  546. <em>data</em>
  547. </code>
  548. </td>
  549. <td>
  550. <div>
  551. <p>The data returned by the server.</p>
  552. </div>
  553. </td>
  554. </tr>
  555. <tr>
  556. <td>
  557. <code>
  558. <em>result</em>
  559. </code>
  560. </td>
  561. <td>
  562. <div>
  563. <p>The result of response serialization.</p>
  564. </div>
  565. </td>
  566. </tr>
  567. <tr>
  568. <td>
  569. <code>
  570. <em>timeline</em>
  571. </code>
  572. </td>
  573. <td>
  574. <div>
  575. <p>The timeline of the complete lifecycle of the <code><a href="../Classes/Request.html">Request</a></code>. Defaults to <code>Timeline()</code>.</p>
  576. </div>
  577. </td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. </div>
  582. <div>
  583. <h4>Return Value</h4>
  584. <p>The new <code>DataResponse</code> instance.</p>
  585. </div>
  586. </section>
  587. </div>
  588. </li>
  589. </ul>
  590. </div>
  591. <div class="task-group">
  592. <ul class="item-container">
  593. <li class="item">
  594. <div>
  595. <code>
  596. <a name="/s:9Alamofire12DataResponseV11descriptionSSvp"></a>
  597. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  598. <a class="token" href="#/s:9Alamofire12DataResponseV11descriptionSSvp">description</a>
  599. </code>
  600. </div>
  601. <div class="height-container">
  602. <div class="pointer-container"></div>
  603. <section class="section">
  604. <div class="pointer"></div>
  605. <div class="abstract">
  606. <p>The textual representation used when written to an output stream, which includes whether the result was a
  607. success or failure.</p>
  608. </div>
  609. <div class="declaration">
  610. <h4>Declaration</h4>
  611. <div class="language">
  612. <p class="aside-title">Swift</p>
  613. <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></code></pre>
  614. </div>
  615. </div>
  616. </section>
  617. </div>
  618. </li>
  619. <li class="item">
  620. <div>
  621. <code>
  622. <a name="/s:9Alamofire12DataResponseV16debugDescriptionSSvp"></a>
  623. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  624. <a class="token" href="#/s:9Alamofire12DataResponseV16debugDescriptionSSvp">debugDescription</a>
  625. </code>
  626. </div>
  627. <div class="height-container">
  628. <div class="pointer-container"></div>
  629. <section class="section">
  630. <div class="pointer"></div>
  631. <div class="abstract">
  632. <p>The debug textual representation used when written to an output stream, which includes the URL request, the URL
  633. response, the server data, the response serialization result and the timeline.</p>
  634. </div>
  635. <div class="declaration">
  636. <h4>Declaration</h4>
  637. <div class="language">
  638. <p class="aside-title">Swift</p>
  639. <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></code></pre>
  640. </div>
  641. </div>
  642. </section>
  643. </div>
  644. </li>
  645. </ul>
  646. </div>
  647. <div class="task-group">
  648. <ul class="item-container">
  649. <li class="item">
  650. <div>
  651. <code>
  652. <a name="/s:9Alamofire12DataResponseV3mapACyqd__Gqd__xclF"></a>
  653. <a name="//apple_ref/swift/Method/map(_:)" class="dashAnchor"></a>
  654. <a class="token" href="#/s:9Alamofire12DataResponseV3mapACyqd__Gqd__xclF">map(_:)</a>
  655. </code>
  656. </div>
  657. <div class="height-container">
  658. <div class="pointer-container"></div>
  659. <section class="section">
  660. <div class="pointer"></div>
  661. <div class="abstract">
  662. <p>Evaluates the specified closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped
  663. result value as a parameter.</p>
  664. <p>Use the <code>map</code> method with a closure that does not throw. For example:</p>
  665. <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>
  666. <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>
  667. </code></pre>
  668. </div>
  669. <div class="declaration">
  670. <h4>Declaration</h4>
  671. <div class="language">
  672. <p class="aside-title">Swift</p>
  673. <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">T</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">Value</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  674. </div>
  675. </div>
  676. <div>
  677. <h4>Parameters</h4>
  678. <table class="graybox">
  679. <tbody>
  680. <tr>
  681. <td>
  682. <code>
  683. <em>transform</em>
  684. </code>
  685. </td>
  686. <td>
  687. <div>
  688. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  689. </div>
  690. </td>
  691. </tr>
  692. </tbody>
  693. </table>
  694. </div>
  695. <div>
  696. <h4>Return Value</h4>
  697. <p>A <code>DataResponse</code> whose result wraps the value returned by the given closure. If this instance&rsquo;s
  698. result is a failure, returns a response wrapping the same failure.</p>
  699. </div>
  700. </section>
  701. </div>
  702. </li>
  703. <li class="item">
  704. <div>
  705. <code>
  706. <a name="/s:9Alamofire12DataResponseV7flatMapACyqd__Gqd__xKclF"></a>
  707. <a name="//apple_ref/swift/Method/flatMap(_:)" class="dashAnchor"></a>
  708. <a class="token" href="#/s:9Alamofire12DataResponseV7flatMapACyqd__Gqd__xKclF">flatMap(_:)</a>
  709. </code>
  710. </div>
  711. <div class="height-container">
  712. <div class="pointer-container"></div>
  713. <section class="section">
  714. <div class="pointer"></div>
  715. <div class="abstract">
  716. <p>Evaluates the given closure when the result of this <code>DataResponse</code> is a success, passing the unwrapped result
  717. value as a parameter.</p>
  718. <p>Use the <code>flatMap</code> method with a closure that may throw an error. For example:</p>
  719. <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>
  720. <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">flatMap</span> <span class="p">{</span>
  721. <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>
  722. <span class="p">}</span>
  723. </code></pre>
  724. </div>
  725. <div class="declaration">
  726. <h4>Declaration</h4>
  727. <div class="language">
  728. <p class="aside-title">Swift</p>
  729. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">flatMap</span><span class="o">&lt;</span><span class="kt">T</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">Value</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  730. </div>
  731. </div>
  732. <div>
  733. <h4>Parameters</h4>
  734. <table class="graybox">
  735. <tbody>
  736. <tr>
  737. <td>
  738. <code>
  739. <em>transform</em>
  740. </code>
  741. </td>
  742. <td>
  743. <div>
  744. <p>A closure that takes the success value of the instance&rsquo;s result.</p>
  745. </div>
  746. </td>
  747. </tr>
  748. </tbody>
  749. </table>
  750. </div>
  751. <div>
  752. <h4>Return Value</h4>
  753. <p>A success or failure <code>DataResponse</code> depending on the result of the given closure. If this instance&rsquo;s
  754. result is a failure, returns the same failure.</p>
  755. </div>
  756. </section>
  757. </div>
  758. </li>
  759. <li class="item">
  760. <div>
  761. <code>
  762. <a name="/s:9Alamofire12DataResponseV8mapErrorACyxGqd__s0E0_pcsAFRd__lF"></a>
  763. <a name="//apple_ref/swift/Method/mapError(_:)" class="dashAnchor"></a>
  764. <a class="token" href="#/s:9Alamofire12DataResponseV8mapErrorACyxGqd__s0E0_pcsAFRd__lF">mapError(_:)</a>
  765. </code>
  766. </div>
  767. <div class="height-container">
  768. <div class="pointer-container"></div>
  769. <section class="section">
  770. <div class="pointer"></div>
  771. <div class="abstract">
  772. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  773. <p>Use the <code>mapError</code> function with a closure that does not throw. For example:</p>
  774. <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>
  775. <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>
  776. </code></pre>
  777. </div>
  778. <div class="declaration">
  779. <h4>Declaration</h4>
  780. <div class="language">
  781. <p class="aside-title">Swift</p>
  782. <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">E</span><span class="p">:</span> <span class="kt">Error</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">Error</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">E</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span></code></pre>
  783. </div>
  784. </div>
  785. <div>
  786. <h4>Parameters</h4>
  787. <table class="graybox">
  788. <tbody>
  789. <tr>
  790. <td>
  791. <code>
  792. <em>transform</em>
  793. </code>
  794. </td>
  795. <td>
  796. <div>
  797. <p>A closure that takes the error of the instance.</p>
  798. </div>
  799. </td>
  800. </tr>
  801. </tbody>
  802. </table>
  803. </div>
  804. <div>
  805. <h4>Return Value</h4>
  806. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  807. </div>
  808. </section>
  809. </div>
  810. </li>
  811. <li class="item">
  812. <div>
  813. <code>
  814. <a name="/s:9Alamofire12DataResponseV12flatMapErrorACyxGqd__s0F0_pKcsAFRd__lF"></a>
  815. <a name="//apple_ref/swift/Method/flatMapError(_:)" class="dashAnchor"></a>
  816. <a class="token" href="#/s:9Alamofire12DataResponseV12flatMapErrorACyxGqd__s0F0_pKcsAFRd__lF">flatMapError(_:)</a>
  817. </code>
  818. </div>
  819. <div class="height-container">
  820. <div class="pointer-container"></div>
  821. <section class="section">
  822. <div class="pointer"></div>
  823. <div class="abstract">
  824. <p>Evaluates the specified closure when the <code>DataResponse</code> is a failure, passing the unwrapped error as a parameter.</p>
  825. <p>Use the <code>flatMapError</code> function with a closure that may throw an error. For example:</p>
  826. <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>
  827. <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">flatMapError</span> <span class="p">{</span>
  828. <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>
  829. <span class="p">}</span>
  830. </code></pre>
  831. </div>
  832. <div class="declaration">
  833. <h4>Declaration</h4>
  834. <div class="language">
  835. <p class="aside-title">Swift</p>
  836. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">flatMapError</span><span class="o">&lt;</span><span class="kt">E</span><span class="p">:</span> <span class="kt">Error</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">Error</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">E</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">DataResponse</span></code></pre>
  837. </div>
  838. </div>
  839. <div>
  840. <h4>Parameters</h4>
  841. <table class="graybox">
  842. <tbody>
  843. <tr>
  844. <td>
  845. <code>
  846. <em>transform</em>
  847. </code>
  848. </td>
  849. <td>
  850. <div>
  851. <p>A throwing closure that takes the error of the instance.</p>
  852. </div>
  853. </td>
  854. </tr>
  855. </tbody>
  856. </table>
  857. </div>
  858. <div>
  859. <h4>Return Value</h4>
  860. <p>A <code>DataResponse</code> instance containing the result of the transform.</p>
  861. </div>
  862. </section>
  863. </div>
  864. </li>
  865. </ul>
  866. </div>
  867. <div class="task-group">
  868. <ul class="item-container">
  869. <li class="item">
  870. <div>
  871. <code>
  872. <a name="/s:9Alamofire12DataResponseV7metricsSo21URLSessionTaskMetricsCSgvp"></a>
  873. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  874. <a class="token" href="#/s:9Alamofire12DataResponseV7metricsSo21URLSessionTaskMetricsCSgvp">metrics</a>
  875. </code>
  876. </div>
  877. <div class="height-container">
  878. <div class="pointer-container"></div>
  879. <section class="section">
  880. <div class="pointer"></div>
  881. <div class="abstract">
  882. <p>The task metrics containing the request / response statistics.</p>
  883. </div>
  884. <div class="declaration">
  885. <h4>Declaration</h4>
  886. <div class="language">
  887. <p class="aside-title">Swift</p>
  888. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span></code></pre>
  889. </div>
  890. </div>
  891. </section>
  892. </div>
  893. </li>
  894. </ul>
  895. </div>
  896. </div>
  897. </section>
  898. </article>
  899. </div>
  900. <section class="footer">
  901. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-03-31)</p>
  902. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  903. </section>
  904. </body>
  905. </div>
  906. </html>