DataResponse.html 44 KB

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