Request.html 67 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Request Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
  16. <a title="Request Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 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. Request Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/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>Request</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  304. </div>
  305. </div>
  306. <p>Responsible for sending a request and receiving the response and associated data from the server, as well as
  307. managing its underlying <code>URLSessionTask</code>.</p>
  308. </div>
  309. </section>
  310. <section class="section">
  311. <div class="section-content">
  312. <div class="task-group">
  313. <div class="task-name-container">
  314. <a name="/Helper%20Types"></a>
  315. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  316. <a href="#/Helper%20Types">
  317. <h3 class="section-name">Helper Types</h3>
  318. </a>
  319. </div>
  320. <ul class="item-container">
  321. <li class="item">
  322. <div>
  323. <code>
  324. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  325. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  326. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  327. </code>
  328. </div>
  329. <div class="height-container">
  330. <div class="pointer-container"></div>
  331. <section class="section">
  332. <div class="pointer"></div>
  333. <div class="abstract">
  334. <p>A closure executed when monitoring upload or download progress of a request.</p>
  335. </div>
  336. <div class="declaration">
  337. <h4>Declaration</h4>
  338. <div class="language">
  339. <p class="aside-title">Swift</p>
  340. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">ProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Progress</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>
  341. </div>
  342. </div>
  343. </section>
  344. </div>
  345. </li>
  346. </ul>
  347. </div>
  348. <div class="task-group">
  349. <div class="task-name-container">
  350. <a name="/Properties"></a>
  351. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  352. <a href="#/Properties">
  353. <h3 class="section-name">Properties</h3>
  354. </a>
  355. </div>
  356. <ul class="item-container">
  357. <li class="item">
  358. <div>
  359. <code>
  360. <a name="/s:9Alamofire7RequestC8delegateAA12TaskDelegateCvp"></a>
  361. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  362. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA12TaskDelegateCvp">delegate</a>
  363. </code>
  364. </div>
  365. <div class="height-container">
  366. <div class="pointer-container"></div>
  367. <section class="section">
  368. <div class="pointer"></div>
  369. <div class="abstract">
  370. <p>The delegate for the underlying task.</p>
  371. </div>
  372. <div class="declaration">
  373. <h4>Declaration</h4>
  374. <div class="language">
  375. <p class="aside-title">Swift</p>
  376. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/TaskDelegate.html">TaskDelegate</a></span></code></pre>
  377. </div>
  378. </div>
  379. </section>
  380. </div>
  381. </li>
  382. <li class="item">
  383. <div>
  384. <code>
  385. <a name="/s:9Alamofire7RequestC4taskSo14URLSessionTaskCSgvp"></a>
  386. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  387. <a class="token" href="#/s:9Alamofire7RequestC4taskSo14URLSessionTaskCSgvp">task</a>
  388. </code>
  389. </div>
  390. <div class="height-container">
  391. <div class="pointer-container"></div>
  392. <section class="section">
  393. <div class="pointer"></div>
  394. <div class="abstract">
  395. <p>The underlying task.</p>
  396. </div>
  397. <div class="declaration">
  398. <h4>Declaration</h4>
  399. <div class="language">
  400. <p class="aside-title">Swift</p>
  401. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span></code></pre>
  402. </div>
  403. </div>
  404. </section>
  405. </div>
  406. </li>
  407. <li class="item">
  408. <div>
  409. <code>
  410. <a name="/s:9Alamofire7RequestC7sessionSo10URLSessionCvp"></a>
  411. <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
  412. <a class="token" href="#/s:9Alamofire7RequestC7sessionSo10URLSessionCvp">session</a>
  413. </code>
  414. </div>
  415. <div class="height-container">
  416. <div class="pointer-container"></div>
  417. <section class="section">
  418. <div class="pointer"></div>
  419. <div class="abstract">
  420. <p>The session belonging to the underlying task.</p>
  421. </div>
  422. <div class="declaration">
  423. <h4>Declaration</h4>
  424. <div class="language">
  425. <p class="aside-title">Swift</p>
  426. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span></code></pre>
  427. </div>
  428. </div>
  429. </section>
  430. </div>
  431. </li>
  432. <li class="item">
  433. <div>
  434. <code>
  435. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  436. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  437. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  438. </code>
  439. </div>
  440. <div class="height-container">
  441. <div class="pointer-container"></div>
  442. <section class="section">
  443. <div class="pointer"></div>
  444. <div class="abstract">
  445. <p>The request sent or to be sent to the server.</p>
  446. </div>
  447. <div class="declaration">
  448. <h4>Declaration</h4>
  449. <div class="language">
  450. <p class="aside-title">Swift</p>
  451. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span></code></pre>
  452. </div>
  453. </div>
  454. </section>
  455. </div>
  456. </li>
  457. <li class="item">
  458. <div>
  459. <code>
  460. <a name="/s:9Alamofire7RequestC8responseSo15HTTPURLResponseCSgvp"></a>
  461. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  462. <a class="token" href="#/s:9Alamofire7RequestC8responseSo15HTTPURLResponseCSgvp">response</a>
  463. </code>
  464. </div>
  465. <div class="height-container">
  466. <div class="pointer-container"></div>
  467. <section class="section">
  468. <div class="pointer"></div>
  469. <div class="abstract">
  470. <p>The response received from the server, if any.</p>
  471. </div>
  472. <div class="declaration">
  473. <h4>Declaration</h4>
  474. <div class="language">
  475. <p class="aside-title">Swift</p>
  476. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?</span></code></pre>
  477. </div>
  478. </div>
  479. </section>
  480. </div>
  481. </li>
  482. <li class="item">
  483. <div>
  484. <code>
  485. <a name="/s:9Alamofire7RequestC10retryCountSuvp"></a>
  486. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  487. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSuvp">retryCount</a>
  488. </code>
  489. </div>
  490. <div class="height-container">
  491. <div class="pointer-container"></div>
  492. <section class="section">
  493. <div class="pointer"></div>
  494. <div class="abstract">
  495. <p>The number of times the request has been retried.</p>
  496. </div>
  497. <div class="declaration">
  498. <h4>Declaration</h4>
  499. <div class="language">
  500. <p class="aside-title">Swift</p>
  501. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">retryCount</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="mi">0</span></code></pre>
  502. </div>
  503. </div>
  504. </section>
  505. </div>
  506. </li>
  507. </ul>
  508. </div>
  509. <div class="task-group">
  510. <div class="task-name-container">
  511. <a name="/Authentication"></a>
  512. <a name="//apple_ref/swift/Section/Authentication" class="dashAnchor"></a>
  513. <a href="#/Authentication">
  514. <h3 class="section-name">Authentication</h3>
  515. </a>
  516. </div>
  517. <ul class="item-container">
  518. <li class="item">
  519. <div>
  520. <code>
  521. <a name="/s:9Alamofire7RequestC12authenticateACXDSS4user_SS8passwordSo13URLCredentialC11PersistenceO11persistencetF"></a>
  522. <a name="//apple_ref/swift/Method/authenticate(user:password:persistence:)" class="dashAnchor"></a>
  523. <a class="token" href="#/s:9Alamofire7RequestC12authenticateACXDSS4user_SS8passwordSo13URLCredentialC11PersistenceO11persistencetF">authenticate(user:password:persistence:)</a>
  524. </code>
  525. </div>
  526. <div class="height-container">
  527. <div class="pointer-container"></div>
  528. <section class="section">
  529. <div class="pointer"></div>
  530. <div class="abstract">
  531. <p>Associates an HTTP Basic credential with the request.</p>
  532. </div>
  533. <div class="declaration">
  534. <h4>Declaration</h4>
  535. <div class="language">
  536. <p class="aside-title">Swift</p>
  537. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span>
  538. <span class="nv">user</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  539. <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  540. <span class="nv">persistence</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="o">.</span><span class="kt">Persistence</span> <span class="o">=</span> <span class="o">.</span><span class="n">forSession</span><span class="p">)</span>
  541. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  542. </div>
  543. </div>
  544. <div>
  545. <h4>Parameters</h4>
  546. <table class="graybox">
  547. <tbody>
  548. <tr>
  549. <td>
  550. <code>
  551. <em>user</em>
  552. </code>
  553. </td>
  554. <td>
  555. <div>
  556. <p>The user.</p>
  557. </div>
  558. </td>
  559. </tr>
  560. <tr>
  561. <td>
  562. <code>
  563. <em>password</em>
  564. </code>
  565. </td>
  566. <td>
  567. <div>
  568. <p>The password.</p>
  569. </div>
  570. </td>
  571. </tr>
  572. <tr>
  573. <td>
  574. <code>
  575. <em>persistence</em>
  576. </code>
  577. </td>
  578. <td>
  579. <div>
  580. <p>The URL credential persistence. <code>.ForSession</code> by default.</p>
  581. </div>
  582. </td>
  583. </tr>
  584. </tbody>
  585. </table>
  586. </div>
  587. <div>
  588. <h4>Return Value</h4>
  589. <p>The request.</p>
  590. </div>
  591. </section>
  592. </div>
  593. </li>
  594. <li class="item">
  595. <div>
  596. <code>
  597. <a name="/s:9Alamofire7RequestC12authenticateACXDSo13URLCredentialC15usingCredential_tF"></a>
  598. <a name="//apple_ref/swift/Method/authenticate(usingCredential:)" class="dashAnchor"></a>
  599. <a class="token" href="#/s:9Alamofire7RequestC12authenticateACXDSo13URLCredentialC15usingCredential_tF">authenticate(usingCredential:)</a>
  600. </code>
  601. </div>
  602. <div class="height-container">
  603. <div class="pointer-container"></div>
  604. <section class="section">
  605. <div class="pointer"></div>
  606. <div class="abstract">
  607. <p>Associates a specified credential with the request.</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">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">usingCredential</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  614. </div>
  615. </div>
  616. <div>
  617. <h4>Parameters</h4>
  618. <table class="graybox">
  619. <tbody>
  620. <tr>
  621. <td>
  622. <code>
  623. <em>credential</em>
  624. </code>
  625. </td>
  626. <td>
  627. <div>
  628. <p>The credential.</p>
  629. </div>
  630. </td>
  631. </tr>
  632. </tbody>
  633. </table>
  634. </div>
  635. <div>
  636. <h4>Return Value</h4>
  637. <p>The request.</p>
  638. </div>
  639. </section>
  640. </div>
  641. </li>
  642. <li class="item">
  643. <div>
  644. <code>
  645. <a name="/s:9Alamofire7RequestC19authorizationHeaderSS3key_SS5valuetSgSS4user_SS8passwordtFZ"></a>
  646. <a name="//apple_ref/swift/Method/authorizationHeader(user:password:)" class="dashAnchor"></a>
  647. <a class="token" href="#/s:9Alamofire7RequestC19authorizationHeaderSS3key_SS5valuetSgSS4user_SS8passwordtFZ">authorizationHeader(user:password:)</a>
  648. </code>
  649. </div>
  650. <div class="height-container">
  651. <div class="pointer-container"></div>
  652. <section class="section">
  653. <div class="pointer"></div>
  654. <div class="abstract">
  655. <p>Returns a base64 encoded basic authentication credential as an authorization header tuple.</p>
  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 swift"><code><span class="kd">open</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authorizationHeader</span><span class="p">(</span><span class="nv">user</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)?</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>user</em>
  672. </code>
  673. </td>
  674. <td>
  675. <div>
  676. <p>The user.</p>
  677. </div>
  678. </td>
  679. </tr>
  680. <tr>
  681. <td>
  682. <code>
  683. <em>password</em>
  684. </code>
  685. </td>
  686. <td>
  687. <div>
  688. <p>The password.</p>
  689. </div>
  690. </td>
  691. </tr>
  692. </tbody>
  693. </table>
  694. </div>
  695. <div>
  696. <h4>Return Value</h4>
  697. <p>A tuple with Authorization header and credential value if encoding succeeds, <code>nil</code> otherwise.</p>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. </ul>
  703. </div>
  704. <div class="task-group">
  705. <div class="task-name-container">
  706. <a name="/State"></a>
  707. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  708. <a href="#/State">
  709. <h3 class="section-name">State</h3>
  710. </a>
  711. </div>
  712. <ul class="item-container">
  713. <li class="item">
  714. <div>
  715. <code>
  716. <a name="/s:9Alamofire7RequestC6resumeyyF"></a>
  717. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  718. <a class="token" href="#/s:9Alamofire7RequestC6resumeyyF">resume()</a>
  719. </code>
  720. </div>
  721. <div class="height-container">
  722. <div class="pointer-container"></div>
  723. <section class="section">
  724. <div class="pointer"></div>
  725. <div class="abstract">
  726. <p>Resumes the request.</p>
  727. </div>
  728. <div class="declaration">
  729. <h4>Declaration</h4>
  730. <div class="language">
  731. <p class="aside-title">Swift</p>
  732. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span></code></pre>
  733. </div>
  734. </div>
  735. </section>
  736. </div>
  737. </li>
  738. <li class="item">
  739. <div>
  740. <code>
  741. <a name="/s:9Alamofire7RequestC7suspendyyF"></a>
  742. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  743. <a class="token" href="#/s:9Alamofire7RequestC7suspendyyF">suspend()</a>
  744. </code>
  745. </div>
  746. <div class="height-container">
  747. <div class="pointer-container"></div>
  748. <section class="section">
  749. <div class="pointer"></div>
  750. <div class="abstract">
  751. <p>Suspends the request.</p>
  752. </div>
  753. <div class="declaration">
  754. <h4>Declaration</h4>
  755. <div class="language">
  756. <p class="aside-title">Swift</p>
  757. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span></code></pre>
  758. </div>
  759. </div>
  760. </section>
  761. </div>
  762. </li>
  763. <li class="item">
  764. <div>
  765. <code>
  766. <a name="/s:9Alamofire7RequestC6cancelyyF"></a>
  767. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  768. <a class="token" href="#/s:9Alamofire7RequestC6cancelyyF">cancel()</a>
  769. </code>
  770. </div>
  771. <div class="height-container">
  772. <div class="pointer-container"></div>
  773. <section class="section">
  774. <div class="pointer"></div>
  775. <div class="abstract">
  776. <p>Cancels the request.</p>
  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">open</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
  783. </div>
  784. </div>
  785. </section>
  786. </div>
  787. </li>
  788. </ul>
  789. </div>
  790. <div class="task-group">
  791. <ul class="item-container">
  792. <li class="item">
  793. <div>
  794. <code>
  795. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  796. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  797. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  798. </code>
  799. </div>
  800. <div class="height-container">
  801. <div class="pointer-container"></div>
  802. <section class="section">
  803. <div class="pointer"></div>
  804. <div class="abstract">
  805. <p>The textual representation used when written to an output stream, which includes the HTTP method and URL, as
  806. well as the response status code if a response has been received.</p>
  807. </div>
  808. <div class="declaration">
  809. <h4>Declaration</h4>
  810. <div class="language">
  811. <p class="aside-title">Swift</p>
  812. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  813. </div>
  814. </div>
  815. </section>
  816. </div>
  817. </li>
  818. </ul>
  819. </div>
  820. <div class="task-group">
  821. <ul class="item-container">
  822. <li class="item">
  823. <div>
  824. <code>
  825. <a name="/s:9Alamofire7RequestC16debugDescriptionSSvp"></a>
  826. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  827. <a class="token" href="#/s:9Alamofire7RequestC16debugDescriptionSSvp">debugDescription</a>
  828. </code>
  829. </div>
  830. <div class="height-container">
  831. <div class="pointer-container"></div>
  832. <section class="section">
  833. <div class="pointer"></div>
  834. <div class="abstract">
  835. <p>The textual representation used when written to an output stream, in the form of a cURL command.</p>
  836. </div>
  837. <div class="declaration">
  838. <h4>Declaration</h4>
  839. <div class="language">
  840. <p class="aside-title">Swift</p>
  841. <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  842. </div>
  843. </div>
  844. </section>
  845. </div>
  846. </li>
  847. </ul>
  848. </div>
  849. <div class="task-group">
  850. <ul class="item-container">
  851. <li class="item">
  852. <div>
  853. <code>
  854. <a name="/s:9Alamofire7RequestC21serializeResponseDataAA6ResultOy10Foundation0E0VGSo15HTTPURLResponseCSg8response_AISg4datas5Error_pSg5errortFZ"></a>
  855. <a name="//apple_ref/swift/Method/serializeResponseData(response:data:error:)" class="dashAnchor"></a>
  856. <a class="token" href="#/s:9Alamofire7RequestC21serializeResponseDataAA6ResultOy10Foundation0E0VGSo15HTTPURLResponseCSg8response_AISg4datas5Error_pSg5errortFZ">serializeResponseData(response:data:error:)</a>
  857. </code>
  858. </div>
  859. <div class="height-container">
  860. <div class="pointer-container"></div>
  861. <section class="section">
  862. <div class="pointer"></div>
  863. <div class="abstract">
  864. <p>Returns a result data type that contains the response data as-is.</p>
  865. </div>
  866. <div class="declaration">
  867. <h4>Declaration</h4>
  868. <div class="language">
  869. <p class="aside-title">Swift</p>
  870. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">serializeResponseData</span><span class="p">(</span><span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  871. </div>
  872. </div>
  873. <div>
  874. <h4>Parameters</h4>
  875. <table class="graybox">
  876. <tbody>
  877. <tr>
  878. <td>
  879. <code>
  880. <em>response</em>
  881. </code>
  882. </td>
  883. <td>
  884. <div>
  885. <p>The response from the server.</p>
  886. </div>
  887. </td>
  888. </tr>
  889. <tr>
  890. <td>
  891. <code>
  892. <em>data</em>
  893. </code>
  894. </td>
  895. <td>
  896. <div>
  897. <p>The data returned from the server.</p>
  898. </div>
  899. </td>
  900. </tr>
  901. <tr>
  902. <td>
  903. <code>
  904. <em>error</em>
  905. </code>
  906. </td>
  907. <td>
  908. <div>
  909. <p>The error already encountered if it exists.</p>
  910. </div>
  911. </td>
  912. </tr>
  913. </tbody>
  914. </table>
  915. </div>
  916. <div>
  917. <h4>Return Value</h4>
  918. <p>The result data type.</p>
  919. </div>
  920. </section>
  921. </div>
  922. </li>
  923. </ul>
  924. </div>
  925. <div class="task-group">
  926. <ul class="item-container">
  927. <li class="item">
  928. <div>
  929. <code>
  930. <a name="/s:9Alamofire7RequestC23serializeResponseStringAA6ResultOySSGSS10FoundationE8EncodingVSg8encoding_So15HTTPURLResponseCSg8responseAH4DataVSg4datas5Error_pSg5errortFZ"></a>
  931. <a name="//apple_ref/swift/Method/serializeResponseString(encoding:response:data:error:)" class="dashAnchor"></a>
  932. <a class="token" href="#/s:9Alamofire7RequestC23serializeResponseStringAA6ResultOySSGSS10FoundationE8EncodingVSg8encoding_So15HTTPURLResponseCSg8responseAH4DataVSg4datas5Error_pSg5errortFZ">serializeResponseString(encoding:response:data:error:)</a>
  933. </code>
  934. </div>
  935. <div class="height-container">
  936. <div class="pointer-container"></div>
  937. <section class="section">
  938. <div class="pointer"></div>
  939. <div class="abstract">
  940. <p>Returns a result string type initialized from the response data with the specified string encoding.</p>
  941. </div>
  942. <div class="declaration">
  943. <h4>Declaration</h4>
  944. <div class="language">
  945. <p class="aside-title">Swift</p>
  946. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">serializeResponseString</span><span class="p">(</span>
  947. <span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?,</span>
  948. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  949. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  950. <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span>
  951. <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  952. </div>
  953. </div>
  954. <div>
  955. <h4>Parameters</h4>
  956. <table class="graybox">
  957. <tbody>
  958. <tr>
  959. <td>
  960. <code>
  961. <em>encoding</em>
  962. </code>
  963. </td>
  964. <td>
  965. <div>
  966. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server
  967. response, falling back to the default HTTP default character set, ISO-8859-1.</p>
  968. </div>
  969. </td>
  970. </tr>
  971. <tr>
  972. <td>
  973. <code>
  974. <em>response</em>
  975. </code>
  976. </td>
  977. <td>
  978. <div>
  979. <p>The response from the server.</p>
  980. </div>
  981. </td>
  982. </tr>
  983. <tr>
  984. <td>
  985. <code>
  986. <em>data</em>
  987. </code>
  988. </td>
  989. <td>
  990. <div>
  991. <p>The data returned from the server.</p>
  992. </div>
  993. </td>
  994. </tr>
  995. <tr>
  996. <td>
  997. <code>
  998. <em>error</em>
  999. </code>
  1000. </td>
  1001. <td>
  1002. <div>
  1003. <p>The error already encountered if it exists.</p>
  1004. </div>
  1005. </td>
  1006. </tr>
  1007. </tbody>
  1008. </table>
  1009. </div>
  1010. <div>
  1011. <h4>Return Value</h4>
  1012. <p>The result data type.</p>
  1013. </div>
  1014. </section>
  1015. </div>
  1016. </li>
  1017. </ul>
  1018. </div>
  1019. <div class="task-group">
  1020. <ul class="item-container">
  1021. <li class="item">
  1022. <div>
  1023. <code>
  1024. <a name="/s:9Alamofire7RequestC21serializeResponseJSONAA6ResultOyypGSo17JSONSerializationC14ReadingOptionsV7options_So15HTTPURLResponseCSg8response10Foundation4DataVSg4datas5Error_pSg5errortFZ"></a>
  1025. <a name="//apple_ref/swift/Method/serializeResponseJSON(options:response:data:error:)" class="dashAnchor"></a>
  1026. <a class="token" href="#/s:9Alamofire7RequestC21serializeResponseJSONAA6ResultOyypGSo17JSONSerializationC14ReadingOptionsV7options_So15HTTPURLResponseCSg8response10Foundation4DataVSg4datas5Error_pSg5errortFZ">serializeResponseJSON(options:response:data:error:)</a>
  1027. </code>
  1028. </div>
  1029. <div class="height-container">
  1030. <div class="pointer-container"></div>
  1031. <section class="section">
  1032. <div class="pointer"></div>
  1033. <div class="abstract">
  1034. <p>Returns a JSON object contained in a result type constructed from the response data using <code>JSONSerialization</code>
  1035. with the specified reading options.</p>
  1036. </div>
  1037. <div class="declaration">
  1038. <h4>Declaration</h4>
  1039. <div class="language">
  1040. <p class="aside-title">Swift</p>
  1041. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">serializeResponseJSON</span><span class="p">(</span>
  1042. <span class="nv">options</span><span class="p">:</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="kt">ReadingOptions</span><span class="p">,</span>
  1043. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  1044. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  1045. <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span>
  1046. <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1047. </div>
  1048. </div>
  1049. <div>
  1050. <h4>Parameters</h4>
  1051. <table class="graybox">
  1052. <tbody>
  1053. <tr>
  1054. <td>
  1055. <code>
  1056. <em>options</em>
  1057. </code>
  1058. </td>
  1059. <td>
  1060. <div>
  1061. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1062. </div>
  1063. </td>
  1064. </tr>
  1065. <tr>
  1066. <td>
  1067. <code>
  1068. <em>response</em>
  1069. </code>
  1070. </td>
  1071. <td>
  1072. <div>
  1073. <p>The response from the server.</p>
  1074. </div>
  1075. </td>
  1076. </tr>
  1077. <tr>
  1078. <td>
  1079. <code>
  1080. <em>data</em>
  1081. </code>
  1082. </td>
  1083. <td>
  1084. <div>
  1085. <p>The data returned from the server.</p>
  1086. </div>
  1087. </td>
  1088. </tr>
  1089. <tr>
  1090. <td>
  1091. <code>
  1092. <em>error</em>
  1093. </code>
  1094. </td>
  1095. <td>
  1096. <div>
  1097. <p>The error already encountered if it exists.</p>
  1098. </div>
  1099. </td>
  1100. </tr>
  1101. </tbody>
  1102. </table>
  1103. </div>
  1104. <div>
  1105. <h4>Return Value</h4>
  1106. <p>The result data type.</p>
  1107. </div>
  1108. </section>
  1109. </div>
  1110. </li>
  1111. </ul>
  1112. </div>
  1113. <div class="task-group">
  1114. <ul class="item-container">
  1115. <li class="item">
  1116. <div>
  1117. <code>
  1118. <a name="/s:9Alamofire7RequestC29serializeResponsePropertyListAA6ResultOyypGSo0eF13SerializationC17MutabilityOptionsV7options_So15HTTPURLResponseCSg8response10Foundation4DataVSg4datas5Error_pSg5errortFZ"></a>
  1119. <a name="//apple_ref/swift/Method/serializeResponsePropertyList(options:response:data:error:)" class="dashAnchor"></a>
  1120. <a class="token" href="#/s:9Alamofire7RequestC29serializeResponsePropertyListAA6ResultOyypGSo0eF13SerializationC17MutabilityOptionsV7options_So15HTTPURLResponseCSg8response10Foundation4DataVSg4datas5Error_pSg5errortFZ">serializeResponsePropertyList(options:response:data:error:)</a>
  1121. </code>
  1122. </div>
  1123. <div class="height-container">
  1124. <div class="pointer-container"></div>
  1125. <section class="section">
  1126. <div class="pointer"></div>
  1127. <div class="abstract">
  1128. <p>Returns a plist object contained in a result type constructed from the response data using
  1129. <code>PropertyListSerialization</code> with the specified reading options.</p>
  1130. </div>
  1131. <div class="declaration">
  1132. <h4>Declaration</h4>
  1133. <div class="language">
  1134. <p class="aside-title">Swift</p>
  1135. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">serializeResponsePropertyList</span><span class="p">(</span>
  1136. <span class="nv">options</span><span class="p">:</span> <span class="kt">PropertyListSerialization</span><span class="o">.</span><span class="kt">ReadOptions</span><span class="p">,</span>
  1137. <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?,</span>
  1138. <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
  1139. <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span>
  1140. <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1141. </div>
  1142. </div>
  1143. <div>
  1144. <h4>Parameters</h4>
  1145. <table class="graybox">
  1146. <tbody>
  1147. <tr>
  1148. <td>
  1149. <code>
  1150. <em>options</em>
  1151. </code>
  1152. </td>
  1153. <td>
  1154. <div>
  1155. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1156. </div>
  1157. </td>
  1158. </tr>
  1159. <tr>
  1160. <td>
  1161. <code>
  1162. <em>response</em>
  1163. </code>
  1164. </td>
  1165. <td>
  1166. <div>
  1167. <p>The response from the server.</p>
  1168. </div>
  1169. </td>
  1170. </tr>
  1171. <tr>
  1172. <td>
  1173. <code>
  1174. <em>data</em>
  1175. </code>
  1176. </td>
  1177. <td>
  1178. <div>
  1179. <p>The data returned from the server.</p>
  1180. </div>
  1181. </td>
  1182. </tr>
  1183. <tr>
  1184. <td>
  1185. <code>
  1186. <em>error</em>
  1187. </code>
  1188. </td>
  1189. <td>
  1190. <div>
  1191. <p>The error already encountered if it exists.</p>
  1192. </div>
  1193. </td>
  1194. </tr>
  1195. </tbody>
  1196. </table>
  1197. </div>
  1198. <div>
  1199. <h4>Return Value</h4>
  1200. <p>The result data type.</p>
  1201. </div>
  1202. </section>
  1203. </div>
  1204. </li>
  1205. </ul>
  1206. </div>
  1207. <div class="task-group">
  1208. <div class="task-name-container">
  1209. <a name="/Helper%20Types2"></a>
  1210. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  1211. <a href="#/Helper%20Types2">
  1212. <h3 class="section-name">Helper Types</h3>
  1213. </a>
  1214. </div>
  1215. <ul class="item-container">
  1216. <li class="item">
  1217. <div>
  1218. <code>
  1219. <a name="/s:9Alamofire7RequestC16ValidationResultO"></a>
  1220. <a name="//apple_ref/swift/Enum/ValidationResult" class="dashAnchor"></a>
  1221. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResultO">ValidationResult</a>
  1222. </code>
  1223. </div>
  1224. <div class="height-container">
  1225. <div class="pointer-container"></div>
  1226. <section class="section">
  1227. <div class="pointer"></div>
  1228. <div class="abstract">
  1229. <p>Used to represent whether validation was successful or encountered an error resulting in a failure.</p>
  1230. <ul>
  1231. <li>success: The validation was successful.</li>
  1232. <li>failure: The validation failed encountering the provided error.</li>
  1233. </ul>
  1234. <a href="../Classes/Request/ValidationResult.html" class="slightly-smaller">See more</a>
  1235. </div>
  1236. <div class="declaration">
  1237. <h4>Declaration</h4>
  1238. <div class="language">
  1239. <p class="aside-title">Swift</p>
  1240. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ValidationResult</span></code></pre>
  1241. </div>
  1242. </div>
  1243. </section>
  1244. </div>
  1245. </li>
  1246. </ul>
  1247. </div>
  1248. </div>
  1249. </section>
  1250. </article>
  1251. </div>
  1252. <section class="footer">
  1253. <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>
  1254. <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>
  1255. </section>
  1256. </body>
  1257. </div>
  1258. </html>