Request.html 124 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345
  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. (75% 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/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/MultipartUpload.html">MultipartUpload</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  181. </li>
  182. </ul>
  183. </li>
  184. <li class="nav-group-name">
  185. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  186. <ul class="nav-group-tasks">
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  216. </li>
  217. </ul>
  218. </li>
  219. <li class="nav-group-name">
  220. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  221. <ul class="nav-group-tasks">
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  259. </li>
  260. </ul>
  261. </li>
  262. <li class="nav-group-name">
  263. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  264. <ul class="nav-group-tasks">
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/SessionStateProvider.html">SessionStateProvider</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  327. </li>
  328. </ul>
  329. </li>
  330. <li class="nav-group-name">
  331. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  332. <ul class="nav-group-tasks">
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  377. </li>
  378. </ul>
  379. </li>
  380. <li class="nav-group-name">
  381. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  382. <ul class="nav-group-tasks">
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  388. </li>
  389. <li class="nav-group-task">
  390. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  391. </li>
  392. <li class="nav-group-task">
  393. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </nav>
  399. <article class="main-content">
  400. <section class="section">
  401. <div class="section-content">
  402. <h1>Request</h1>
  403. <div class="declaration">
  404. <div class="language">
  405. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  406. </div>
  407. </div>
  408. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  409. handling.</p>
  410. </div>
  411. </section>
  412. <section class="section">
  413. <div class="section-content">
  414. <div class="task-group">
  415. <ul class="item-container">
  416. <li class="item">
  417. <div>
  418. <code>
  419. <a name="/s:9Alamofire7RequestC5StateO"></a>
  420. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  421. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  422. </code>
  423. </div>
  424. <div class="height-container">
  425. <div class="pointer-container"></div>
  426. <section class="section">
  427. <div class="pointer"></div>
  428. <div class="abstract">
  429. <p>State of the <code><a href="../Classes/Request.html">Request</a></code>, with managed transitions between states set when calling <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code>, <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code>, or
  430. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  431. <ul>
  432. <li>initialized: Initial state of the <code><a href="../Classes/Request.html">Request</a></code>.</li>
  433. <li>resumed: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code> called on
  434. them in this state.</li>
  435. <li>suspended: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code> called on
  436. them in this state.</li>
  437. <li>cancelled: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> called on
  438. them. Unlike <code>resumed</code> or <code>suspended</code>, once in the <code>cancelled</code> state, the <code><a href="../Classes/Request.html">Request</a></code> can no longer
  439. transition to any other state.</li>
  440. </ul>
  441. <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
  442. </div>
  443. <div class="declaration">
  444. <h4>Declaration</h4>
  445. <div class="language">
  446. <p class="aside-title">Swift</p>
  447. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span></code></pre>
  448. </div>
  449. </div>
  450. </section>
  451. </div>
  452. </li>
  453. </ul>
  454. </div>
  455. <div class="task-group">
  456. <div class="task-name-container">
  457. <a name="/Initial%20State"></a>
  458. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  459. <a href="#/Initial%20State">
  460. <h3 class="section-name">Initial State</h3>
  461. </a>
  462. </div>
  463. <ul class="item-container">
  464. <li class="item">
  465. <div>
  466. <code>
  467. <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
  468. <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
  469. <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
  470. </code>
  471. </div>
  472. <div class="height-container">
  473. <div class="pointer-container"></div>
  474. <section class="section">
  475. <div class="pointer"></div>
  476. <div class="abstract">
  477. <p><code>UUID</code> prividing a unique identifier for the <code>Request</code>, used in the <code>Hashable</code> and <code>Equatable</code> conformances.</p>
  478. </div>
  479. <div class="declaration">
  480. <h4>Declaration</h4>
  481. <div class="language">
  482. <p class="aside-title">Swift</p>
  483. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">UUID</span></code></pre>
  484. </div>
  485. </div>
  486. </section>
  487. </div>
  488. </li>
  489. <li class="item">
  490. <div>
  491. <code>
  492. <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
  493. <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
  494. <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
  495. </code>
  496. </div>
  497. <div class="height-container">
  498. <div class="pointer-container"></div>
  499. <section class="section">
  500. <div class="pointer"></div>
  501. <div class="abstract">
  502. <p>The serial queue for all internal async actions.</p>
  503. </div>
  504. <div class="declaration">
  505. <h4>Declaration</h4>
  506. <div class="language">
  507. <p class="aside-title">Swift</p>
  508. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">underlyingQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  509. </div>
  510. </div>
  511. </section>
  512. </div>
  513. </li>
  514. <li class="item">
  515. <div>
  516. <code>
  517. <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  518. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  519. <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  520. </code>
  521. </div>
  522. <div class="height-container">
  523. <div class="pointer-container"></div>
  524. <section class="section">
  525. <div class="pointer"></div>
  526. <div class="abstract">
  527. <p>The queue used for all serialization actions. By default it&rsquo;s a serial queue that targets <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code>.</p>
  528. </div>
  529. <div class="declaration">
  530. <h4>Declaration</h4>
  531. <div class="language">
  532. <p class="aside-title">Swift</p>
  533. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  534. </div>
  535. </div>
  536. </section>
  537. </div>
  538. </li>
  539. <li class="item">
  540. <div>
  541. <code>
  542. <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
  543. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  544. <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
  545. </code>
  546. </div>
  547. <div class="height-container">
  548. <div class="pointer-container"></div>
  549. <section class="section">
  550. <div class="pointer"></div>
  551. <div class="abstract">
  552. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
  553. </div>
  554. <div class="declaration">
  555. <h4>Declaration</h4>
  556. <div class="language">
  557. <p class="aside-title">Swift</p>
  558. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">?</span></code></pre>
  559. </div>
  560. </div>
  561. </section>
  562. </div>
  563. </li>
  564. <li class="item">
  565. <div>
  566. <code>
  567. <a name="/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp"></a>
  568. <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
  569. <a class="token" href="#/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp">interceptor</a>
  570. </code>
  571. </div>
  572. <div class="height-container">
  573. <div class="pointer-container"></div>
  574. <section class="section">
  575. <div class="pointer"></div>
  576. <div class="abstract">
  577. <p>The <code>Request</code>&lsquo;s interceptor.</p>
  578. </div>
  579. <div class="declaration">
  580. <h4>Declaration</h4>
  581. <div class="language">
  582. <p class="aside-title">Swift</p>
  583. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span></code></pre>
  584. </div>
  585. </div>
  586. </section>
  587. </div>
  588. </li>
  589. <li class="item">
  590. <div>
  591. <code>
  592. <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp"></a>
  593. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  594. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp">delegate</a>
  595. </code>
  596. </div>
  597. <div class="height-container">
  598. <div class="pointer-container"></div>
  599. <section class="section">
  600. <div class="pointer"></div>
  601. <div class="abstract">
  602. <p>The <code>Request</code>&lsquo;s delegate.</p>
  603. </div>
  604. <div class="declaration">
  605. <h4>Declaration</h4>
  606. <div class="language">
  607. <p class="aside-title">Swift</p>
  608. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span><span class="p">?</span></code></pre>
  609. </div>
  610. </div>
  611. </section>
  612. </div>
  613. </li>
  614. </ul>
  615. </div>
  616. <div class="task-group">
  617. <div class="task-name-container">
  618. <a name="/Updated%20State"></a>
  619. <a name="//apple_ref/swift/Section/Updated State" class="dashAnchor"></a>
  620. <a href="#/Updated%20State">
  621. <h3 class="section-name">Updated State</h3>
  622. </a>
  623. </div>
  624. <ul class="item-container">
  625. <li class="item">
  626. <div>
  627. <code>
  628. <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
  629. <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
  630. <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
  631. </code>
  632. </div>
  633. <div class="height-container">
  634. <div class="pointer-container"></div>
  635. <section class="section">
  636. <div class="pointer"></div>
  637. <div class="abstract">
  638. <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
  639. </div>
  640. <div class="declaration">
  641. <h4>Declaration</h4>
  642. <div class="language">
  643. <p class="aside-title">Swift</p>
  644. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request/State.html">State</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  645. </div>
  646. </div>
  647. </section>
  648. </div>
  649. </li>
  650. <li class="item">
  651. <div>
  652. <code>
  653. <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
  654. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  655. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
  656. </code>
  657. </div>
  658. <div class="height-container">
  659. <div class="pointer-container"></div>
  660. <section class="section">
  661. <div class="pointer"></div>
  662. <div class="abstract">
  663. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
  664. </div>
  665. <div class="declaration">
  666. <h4>Declaration</h4>
  667. <div class="language">
  668. <p class="aside-title">Swift</p>
  669. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isCancelled</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  670. </div>
  671. </div>
  672. </section>
  673. </div>
  674. </li>
  675. <li class="item">
  676. <div>
  677. <code>
  678. <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
  679. <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
  680. <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
  681. </code>
  682. </div>
  683. <div class="height-container">
  684. <div class="pointer-container"></div>
  685. <section class="section">
  686. <div class="pointer"></div>
  687. <div class="abstract">
  688. <p>Returns whether <code>state is</code>.resumed`.</p>
  689. </div>
  690. <div class="declaration">
  691. <h4>Declaration</h4>
  692. <div class="language">
  693. <p class="aside-title">Swift</p>
  694. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isResumed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  695. </div>
  696. </div>
  697. </section>
  698. </div>
  699. </li>
  700. <li class="item">
  701. <div>
  702. <code>
  703. <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
  704. <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
  705. <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
  706. </code>
  707. </div>
  708. <div class="height-container">
  709. <div class="pointer-container"></div>
  710. <section class="section">
  711. <div class="pointer"></div>
  712. <div class="abstract">
  713. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
  714. </div>
  715. <div class="declaration">
  716. <h4>Declaration</h4>
  717. <div class="language">
  718. <p class="aside-title">Swift</p>
  719. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isSuspended</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  720. </div>
  721. </div>
  722. </section>
  723. </div>
  724. </li>
  725. <li class="item">
  726. <div>
  727. <code>
  728. <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
  729. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  730. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
  731. </code>
  732. </div>
  733. <div class="height-container">
  734. <div class="pointer-container"></div>
  735. <section class="section">
  736. <div class="pointer"></div>
  737. <div class="abstract">
  738. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
  739. </div>
  740. <div class="declaration">
  741. <h4>Declaration</h4>
  742. <div class="language">
  743. <p class="aside-title">Swift</p>
  744. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isInitialized</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  745. </div>
  746. </div>
  747. </section>
  748. </div>
  749. </li>
  750. <li class="item">
  751. <div>
  752. <code>
  753. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  754. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  755. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  756. </code>
  757. </div>
  758. <div class="height-container">
  759. <div class="pointer-container"></div>
  760. <section class="section">
  761. <div class="pointer"></div>
  762. <div class="abstract">
  763. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  764. </div>
  765. <div class="declaration">
  766. <h4>Declaration</h4>
  767. <div class="language">
  768. <p class="aside-title">Swift</p>
  769. <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>
  770. </div>
  771. </div>
  772. </section>
  773. </div>
  774. </li>
  775. <li class="item">
  776. <div>
  777. <code>
  778. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  779. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  780. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  781. </code>
  782. </div>
  783. <div class="height-container">
  784. <div class="pointer-container"></div>
  785. <section class="section">
  786. <div class="pointer"></div>
  787. <div class="abstract">
  788. <p><code>Progress</code> of the upload of the body of the executed <code>URLRequest</code>. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  789. </div>
  790. <div class="declaration">
  791. <h4>Declaration</h4>
  792. <div class="language">
  793. <p class="aside-title">Swift</p>
  794. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">uploadProgress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  795. </div>
  796. </div>
  797. </section>
  798. </div>
  799. </li>
  800. <li class="item">
  801. <div>
  802. <code>
  803. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  804. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  805. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  806. </code>
  807. </div>
  808. <div class="height-container">
  809. <div class="pointer-container"></div>
  810. <section class="section">
  811. <div class="pointer"></div>
  812. <div class="abstract">
  813. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  814. </div>
  815. <div class="declaration">
  816. <h4>Declaration</h4>
  817. <div class="language">
  818. <p class="aside-title">Swift</p>
  819. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">downloadProgress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  820. </div>
  821. </div>
  822. </section>
  823. </div>
  824. </li>
  825. <li class="item">
  826. <div>
  827. <code>
  828. <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  829. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  830. <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  831. </code>
  832. </div>
  833. <div class="height-container">
  834. <div class="pointer-container"></div>
  835. <section class="section">
  836. <div class="pointer"></div>
  837. <div class="abstract">
  838. <p>Undocumented</p>
  839. </div>
  840. <div class="declaration">
  841. <h4>Declaration</h4>
  842. <div class="language">
  843. <p class="aside-title">Swift</p>
  844. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  845. </div>
  846. </div>
  847. </section>
  848. </div>
  849. </li>
  850. <li class="item">
  851. <div>
  852. <code>
  853. <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  854. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  855. <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  856. </code>
  857. </div>
  858. <div class="height-container">
  859. <div class="pointer-container"></div>
  860. <section class="section">
  861. <div class="pointer"></div>
  862. <div class="abstract">
  863. <p>Undocumented</p>
  864. </div>
  865. <div class="declaration">
  866. <h4>Declaration</h4>
  867. <div class="language">
  868. <p class="aside-title">Swift</p>
  869. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  870. </div>
  871. </div>
  872. </section>
  873. </div>
  874. </li>
  875. <li class="item">
  876. <div>
  877. <code>
  878. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  879. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  880. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  881. </code>
  882. </div>
  883. <div class="height-container">
  884. <div class="pointer-container"></div>
  885. <section class="section">
  886. <div class="pointer"></div>
  887. <div class="abstract">
  888. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  889. </div>
  890. <div class="declaration">
  891. <h4>Declaration</h4>
  892. <div class="language">
  893. <p class="aside-title">Swift</p>
  894. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  895. </div>
  896. </div>
  897. </section>
  898. </div>
  899. </li>
  900. <li class="item">
  901. <div>
  902. <code>
  903. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  904. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  905. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
  906. </code>
  907. </div>
  908. <div class="height-container">
  909. <div class="pointer-container"></div>
  910. <section class="section">
  911. <div class="pointer"></div>
  912. <div class="abstract">
  913. <p>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  914. </div>
  915. <div class="declaration">
  916. <h4>Declaration</h4>
  917. <div class="language">
  918. <p class="aside-title">Swift</p>
  919. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLRequest</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  920. </div>
  921. </div>
  922. </section>
  923. </div>
  924. </li>
  925. <li class="item">
  926. <div>
  927. <code>
  928. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  929. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  930. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  931. </code>
  932. </div>
  933. <div class="height-container">
  934. <div class="pointer-container"></div>
  935. <section class="section">
  936. <div class="pointer"></div>
  937. <div class="abstract">
  938. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  939. </div>
  940. <div class="declaration">
  941. <h4>Declaration</h4>
  942. <div class="language">
  943. <p class="aside-title">Swift</p>
  944. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  945. </div>
  946. </div>
  947. </section>
  948. </div>
  949. </li>
  950. <li class="item">
  951. <div>
  952. <code>
  953. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  954. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  955. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  956. </code>
  957. </div>
  958. <div class="height-container">
  959. <div class="pointer-container"></div>
  960. <section class="section">
  961. <div class="pointer"></div>
  962. <div class="abstract">
  963. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  964. </div>
  965. <div class="declaration">
  966. <h4>Declaration</h4>
  967. <div class="language">
  968. <p class="aside-title">Swift</p>
  969. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  970. </div>
  971. </div>
  972. </section>
  973. </div>
  974. </li>
  975. <li class="item">
  976. <div>
  977. <code>
  978. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  979. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  980. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  981. </code>
  982. </div>
  983. <div class="height-container">
  984. <div class="pointer-container"></div>
  985. <section class="section">
  986. <div class="pointer"></div>
  987. <div class="abstract">
  988. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  989. </div>
  990. <div class="declaration">
  991. <h4>Declaration</h4>
  992. <div class="language">
  993. <p class="aside-title">Swift</p>
  994. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  995. </div>
  996. </div>
  997. </section>
  998. </div>
  999. </li>
  1000. <li class="item">
  1001. <div>
  1002. <code>
  1003. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  1004. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  1005. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  1006. </code>
  1007. </div>
  1008. <div class="height-container">
  1009. <div class="pointer-container"></div>
  1010. <section class="section">
  1011. <div class="pointer"></div>
  1012. <div class="abstract">
  1013. <p><code>URLRequest</code>s from all of the <code>URLSessionTask</code>s executed on behalf of the <code>Request</code>.</p>
  1014. </div>
  1015. <div class="declaration">
  1016. <h4>Declaration</h4>
  1017. <div class="language">
  1018. <p class="aside-title">Swift</p>
  1019. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">performedRequests</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLRequest</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1020. </div>
  1021. </div>
  1022. </section>
  1023. </div>
  1024. </li>
  1025. <li class="item">
  1026. <div>
  1027. <code>
  1028. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  1029. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  1030. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  1031. </code>
  1032. </div>
  1033. <div class="height-container">
  1034. <div class="pointer-container"></div>
  1035. <section class="section">
  1036. <div class="pointer"></div>
  1037. <div class="abstract">
  1038. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  1039. last <code>URLSessionTask</code>.</p>
  1040. </div>
  1041. <div class="declaration">
  1042. <h4>Declaration</h4>
  1043. <div class="language">
  1044. <p class="aside-title">Swift</p>
  1045. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1046. </div>
  1047. </div>
  1048. </section>
  1049. </div>
  1050. </li>
  1051. <li class="item">
  1052. <div>
  1053. <code>
  1054. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  1055. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  1056. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  1057. </code>
  1058. </div>
  1059. <div class="height-container">
  1060. <div class="pointer-container"></div>
  1061. <section class="section">
  1062. <div class="pointer"></div>
  1063. <div class="abstract">
  1064. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  1065. </div>
  1066. <div class="declaration">
  1067. <h4>Declaration</h4>
  1068. <div class="language">
  1069. <p class="aside-title">Swift</p>
  1070. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tasks</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLSessionTask</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1071. </div>
  1072. </div>
  1073. </section>
  1074. </div>
  1075. </li>
  1076. <li class="item">
  1077. <div>
  1078. <code>
  1079. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  1080. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  1081. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  1082. </code>
  1083. </div>
  1084. <div class="height-container">
  1085. <div class="pointer-container"></div>
  1086. <section class="section">
  1087. <div class="pointer"></div>
  1088. <div class="abstract">
  1089. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1090. </div>
  1091. <div class="declaration">
  1092. <h4>Declaration</h4>
  1093. <div class="language">
  1094. <p class="aside-title">Swift</p>
  1095. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstTask</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1096. </div>
  1097. </div>
  1098. </section>
  1099. </div>
  1100. </li>
  1101. <li class="item">
  1102. <div>
  1103. <code>
  1104. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  1105. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  1106. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  1107. </code>
  1108. </div>
  1109. <div class="height-container">
  1110. <div class="pointer-container"></div>
  1111. <section class="section">
  1112. <div class="pointer"></div>
  1113. <div class="abstract">
  1114. <p>Last <code>URLSessionTask</code> crated on behalf of the <code>Request</code>.</p>
  1115. </div>
  1116. <div class="declaration">
  1117. <h4>Declaration</h4>
  1118. <div class="language">
  1119. <p class="aside-title">Swift</p>
  1120. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastTask</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1121. </div>
  1122. </div>
  1123. </section>
  1124. </div>
  1125. </li>
  1126. <li class="item">
  1127. <div>
  1128. <code>
  1129. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1130. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1131. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1132. </code>
  1133. </div>
  1134. <div class="height-container">
  1135. <div class="pointer-container"></div>
  1136. <section class="section">
  1137. <div class="pointer"></div>
  1138. <div class="abstract">
  1139. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1140. </div>
  1141. <div class="declaration">
  1142. <h4>Declaration</h4>
  1143. <div class="language">
  1144. <p class="aside-title">Swift</p>
  1145. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1146. </div>
  1147. </div>
  1148. </section>
  1149. </div>
  1150. </li>
  1151. <li class="item">
  1152. <div>
  1153. <code>
  1154. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1155. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1156. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1157. </code>
  1158. </div>
  1159. <div class="height-container">
  1160. <div class="pointer-container"></div>
  1161. <section class="section">
  1162. <div class="pointer"></div>
  1163. <div class="abstract">
  1164. <p>All <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>. Should correspond to the <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a></code> created.</p>
  1165. </div>
  1166. <div class="declaration">
  1167. <h4>Declaration</h4>
  1168. <div class="language">
  1169. <p class="aside-title">Swift</p>
  1170. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">allMetrics</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLSessionTaskMetrics</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1171. </div>
  1172. </div>
  1173. </section>
  1174. </div>
  1175. </li>
  1176. <li class="item">
  1177. <div>
  1178. <code>
  1179. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1180. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1181. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1182. </code>
  1183. </div>
  1184. <div class="height-container">
  1185. <div class="pointer-container"></div>
  1186. <section class="section">
  1187. <div class="pointer"></div>
  1188. <div class="abstract">
  1189. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1190. </div>
  1191. <div class="declaration">
  1192. <h4>Declaration</h4>
  1193. <div class="language">
  1194. <p class="aside-title">Swift</p>
  1195. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstMetrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1196. </div>
  1197. </div>
  1198. </section>
  1199. </div>
  1200. </li>
  1201. <li class="item">
  1202. <div>
  1203. <code>
  1204. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1205. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1206. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1207. </code>
  1208. </div>
  1209. <div class="height-container">
  1210. <div class="pointer-container"></div>
  1211. <section class="section">
  1212. <div class="pointer"></div>
  1213. <div class="abstract">
  1214. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1215. </div>
  1216. <div class="declaration">
  1217. <h4>Declaration</h4>
  1218. <div class="language">
  1219. <p class="aside-title">Swift</p>
  1220. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastMetrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1221. </div>
  1222. </div>
  1223. </section>
  1224. </div>
  1225. </li>
  1226. <li class="item">
  1227. <div>
  1228. <code>
  1229. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1230. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1231. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1232. </code>
  1233. </div>
  1234. <div class="height-container">
  1235. <div class="pointer-container"></div>
  1236. <section class="section">
  1237. <div class="pointer"></div>
  1238. <div class="abstract">
  1239. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1240. </div>
  1241. <div class="declaration">
  1242. <h4>Declaration</h4>
  1243. <div class="language">
  1244. <p class="aside-title">Swift</p>
  1245. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1246. </div>
  1247. </div>
  1248. </section>
  1249. </div>
  1250. </li>
  1251. <li class="item">
  1252. <div>
  1253. <code>
  1254. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1255. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1256. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1257. </code>
  1258. </div>
  1259. <div class="height-container">
  1260. <div class="pointer-container"></div>
  1261. <section class="section">
  1262. <div class="pointer"></div>
  1263. <div class="abstract">
  1264. <p>Number of times the <code>Request</code> has been retried.</p>
  1265. </div>
  1266. <div class="declaration">
  1267. <h4>Declaration</h4>
  1268. <div class="language">
  1269. <p class="aside-title">Swift</p>
  1270. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">retryCount</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1271. </div>
  1272. </div>
  1273. </section>
  1274. </div>
  1275. </li>
  1276. <li class="item">
  1277. <div>
  1278. <code>
  1279. <a name="/s:9Alamofire7RequestC5errors5Error_pSgvp"></a>
  1280. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1281. <a class="token" href="#/s:9Alamofire7RequestC5errors5Error_pSgvp">error</a>
  1282. </code>
  1283. </div>
  1284. <div class="height-container">
  1285. <div class="pointer-container"></div>
  1286. <section class="section">
  1287. <div class="pointer"></div>
  1288. <div class="abstract">
  1289. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1290. </div>
  1291. <div class="declaration">
  1292. <h4>Declaration</h4>
  1293. <div class="language">
  1294. <p class="aside-title">Swift</p>
  1295. <pre class="highlight swift"><code><span class="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <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> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  1296. </div>
  1297. </div>
  1298. </section>
  1299. </div>
  1300. </li>
  1301. <li class="item">
  1302. <div>
  1303. <code>
  1304. <a name="/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor11interceptor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAnA05EventH0_pSgAA0B11Interceptor_pSgAA0B8Delegate_ptcfc"></a>
  1305. <a name="//apple_ref/swift/Method/init(id:underlyingQueue:serializationQueue:eventMonitor:interceptor:delegate:)" class="dashAnchor"></a>
  1306. <a class="token" href="#/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor11interceptor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAnA05EventH0_pSgAA0B11Interceptor_pSgAA0B8Delegate_ptcfc">init(id:underlyingQueue:serializationQueue:eventMonitor:interceptor:delegate:)</a>
  1307. </code>
  1308. </div>
  1309. <div class="height-container">
  1310. <div class="pointer-container"></div>
  1311. <section class="section">
  1312. <div class="pointer"></div>
  1313. <div class="abstract">
  1314. <p>Default initializer for the <code>Request</code> superclass.</p>
  1315. </div>
  1316. <div class="declaration">
  1317. <h4>Declaration</h4>
  1318. <div class="language">
  1319. <p class="aside-title">Swift</p>
  1320. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">id</span><span class="p">:</span> <span class="kt">UUID</span> <span class="o">=</span> <span class="kt">UUID</span><span class="p">(),</span>
  1321. <span class="nv">underlyingQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1322. <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1323. <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">?,</span>
  1324. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?,</span>
  1325. <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span><span class="p">)</span></code></pre>
  1326. </div>
  1327. </div>
  1328. <div>
  1329. <h4>Parameters</h4>
  1330. <table class="graybox">
  1331. <tbody>
  1332. <tr>
  1333. <td>
  1334. <code>
  1335. <em>id</em>
  1336. </code>
  1337. </td>
  1338. <td>
  1339. <div>
  1340. <p><code>UUID</code> used for the <code>Hashable</code> and <code>Equatable</code> implementations. Defaults to a random <code>UUID</code>.</p>
  1341. </div>
  1342. </td>
  1343. </tr>
  1344. <tr>
  1345. <td>
  1346. <code>
  1347. <em>underlyingQueue</em>
  1348. </code>
  1349. </td>
  1350. <td>
  1351. <div>
  1352. <p><code>DispatchQueue</code> on which all internal <code>Request</code> work is performed.</p>
  1353. </div>
  1354. </td>
  1355. </tr>
  1356. <tr>
  1357. <td>
  1358. <code>
  1359. <em>serializationQueue</em>
  1360. </code>
  1361. </td>
  1362. <td>
  1363. <div>
  1364. <p><code>DispatchQueue</code> on which all serialization work is performed. Targets the
  1365. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> when created by a <code>SessionManager</code>.</p>
  1366. </div>
  1367. </td>
  1368. </tr>
  1369. <tr>
  1370. <td>
  1371. <code>
  1372. <em>eventMonitor</em>
  1373. </code>
  1374. </td>
  1375. <td>
  1376. <div>
  1377. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks from internal <code>Request</code> actions.</p>
  1378. </div>
  1379. </td>
  1380. </tr>
  1381. <tr>
  1382. <td>
  1383. <code>
  1384. <em>interceptor</em>
  1385. </code>
  1386. </td>
  1387. <td>
  1388. <div>
  1389. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> used throughout the request lifecycle.</p>
  1390. </div>
  1391. </td>
  1392. </tr>
  1393. <tr>
  1394. <td>
  1395. <code>
  1396. <em>delegate</em>
  1397. </code>
  1398. </td>
  1399. <td>
  1400. <div>
  1401. <p><code><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></code> that provides an interface to actions not performed by the <code>Request</code>.</p>
  1402. </div>
  1403. </td>
  1404. </tr>
  1405. </tbody>
  1406. </table>
  1407. </div>
  1408. </section>
  1409. </div>
  1410. </li>
  1411. </ul>
  1412. </div>
  1413. <div class="task-group">
  1414. <div class="task-name-container">
  1415. <a name="/State"></a>
  1416. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1417. <a href="#/State">
  1418. <h3 class="section-name">State</h3>
  1419. </a>
  1420. </div>
  1421. <ul class="item-container">
  1422. <li class="item">
  1423. <div>
  1424. <code>
  1425. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1426. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1427. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1428. </code>
  1429. </div>
  1430. <div class="height-container">
  1431. <div class="pointer-container"></div>
  1432. <section class="section">
  1433. <div class="pointer"></div>
  1434. <div class="abstract">
  1435. <p>Cancels the <code>Request</code>. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1436. </div>
  1437. <div class="declaration">
  1438. <h4>Declaration</h4>
  1439. <div class="language">
  1440. <p class="aside-title">Swift</p>
  1441. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1442. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1443. </div>
  1444. </div>
  1445. <div>
  1446. <h4>Return Value</h4>
  1447. <p>The <code>Request</code>.</p>
  1448. </div>
  1449. </section>
  1450. </div>
  1451. </li>
  1452. <li class="item">
  1453. <div>
  1454. <code>
  1455. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1456. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1457. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1458. </code>
  1459. </div>
  1460. <div class="height-container">
  1461. <div class="pointer-container"></div>
  1462. <section class="section">
  1463. <div class="pointer"></div>
  1464. <div class="abstract">
  1465. <p>Suspends the <code>Request</code>.</p>
  1466. </div>
  1467. <div class="declaration">
  1468. <h4>Declaration</h4>
  1469. <div class="language">
  1470. <p class="aside-title">Swift</p>
  1471. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1472. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1473. </div>
  1474. </div>
  1475. <div>
  1476. <h4>Return Value</h4>
  1477. <p>The <code>Request</code>.</p>
  1478. </div>
  1479. </section>
  1480. </div>
  1481. </li>
  1482. <li class="item">
  1483. <div>
  1484. <code>
  1485. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1486. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1487. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1488. </code>
  1489. </div>
  1490. <div class="height-container">
  1491. <div class="pointer-container"></div>
  1492. <section class="section">
  1493. <div class="pointer"></div>
  1494. <div class="abstract">
  1495. <p>Resumes the <code>Request</code>.</p>
  1496. </div>
  1497. <div class="declaration">
  1498. <h4>Declaration</h4>
  1499. <div class="language">
  1500. <p class="aside-title">Swift</p>
  1501. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1502. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1503. </div>
  1504. </div>
  1505. <div>
  1506. <h4>Return Value</h4>
  1507. <p>The <code>Request</code>.</p>
  1508. </div>
  1509. </section>
  1510. </div>
  1511. </li>
  1512. </ul>
  1513. </div>
  1514. <div class="task-group">
  1515. <div class="task-name-container">
  1516. <a name="/Closure%20API"></a>
  1517. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1518. <a href="#/Closure%20API">
  1519. <h3 class="section-name">Closure API</h3>
  1520. </a>
  1521. </div>
  1522. <ul class="item-container">
  1523. <li class="item">
  1524. <div>
  1525. <code>
  1526. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1527. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1528. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:password:persistence:)</a>
  1529. </code>
  1530. </div>
  1531. <div class="height-container">
  1532. <div class="pointer-container"></div>
  1533. <section class="section">
  1534. <div class="pointer"></div>
  1535. <div class="abstract">
  1536. <p>Associates a credential using the provided values with the <code>Request</code>.</p>
  1537. </div>
  1538. <div class="declaration">
  1539. <h4>Declaration</h4>
  1540. <div class="language">
  1541. <p class="aside-title">Swift</p>
  1542. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1543. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="nv">username</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="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> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1544. </div>
  1545. </div>
  1546. <div>
  1547. <h4>Parameters</h4>
  1548. <table class="graybox">
  1549. <tbody>
  1550. <tr>
  1551. <td>
  1552. <code>
  1553. <em>username</em>
  1554. </code>
  1555. </td>
  1556. <td>
  1557. <div>
  1558. <p>The username.</p>
  1559. </div>
  1560. </td>
  1561. </tr>
  1562. <tr>
  1563. <td>
  1564. <code>
  1565. <em>password</em>
  1566. </code>
  1567. </td>
  1568. <td>
  1569. <div>
  1570. <p>The password.</p>
  1571. </div>
  1572. </td>
  1573. </tr>
  1574. <tr>
  1575. <td>
  1576. <code>
  1577. <em>persistence</em>
  1578. </code>
  1579. </td>
  1580. <td>
  1581. <div>
  1582. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>.</p>
  1583. </div>
  1584. </td>
  1585. </tr>
  1586. </tbody>
  1587. </table>
  1588. </div>
  1589. <div>
  1590. <h4>Return Value</h4>
  1591. <p>The <code>Request</code>.</p>
  1592. </div>
  1593. </section>
  1594. </div>
  1595. </li>
  1596. <li class="item">
  1597. <div>
  1598. <code>
  1599. <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1600. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1601. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:)</a>
  1602. </code>
  1603. </div>
  1604. <div class="height-container">
  1605. <div class="pointer-container"></div>
  1606. <section class="section">
  1607. <div class="pointer"></div>
  1608. <div class="abstract">
  1609. <p>Associates the provided credential with the <code>Request</code>.</p>
  1610. </div>
  1611. <div class="declaration">
  1612. <h4>Declaration</h4>
  1613. <div class="language">
  1614. <p class="aside-title">Swift</p>
  1615. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1616. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">with</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>
  1617. </div>
  1618. </div>
  1619. <div>
  1620. <h4>Parameters</h4>
  1621. <table class="graybox">
  1622. <tbody>
  1623. <tr>
  1624. <td>
  1625. <code>
  1626. <em>credential</em>
  1627. </code>
  1628. </td>
  1629. <td>
  1630. <div>
  1631. <p>The <code>URLCredential</code>.</p>
  1632. </div>
  1633. </td>
  1634. </tr>
  1635. </tbody>
  1636. </table>
  1637. </div>
  1638. <div>
  1639. <h4>Return Value</h4>
  1640. <p>The <code>Request</code>.</p>
  1641. </div>
  1642. </section>
  1643. </div>
  1644. </li>
  1645. <li class="item">
  1646. <div>
  1647. <code>
  1648. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1649. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1650. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  1651. </code>
  1652. </div>
  1653. <div class="height-container">
  1654. <div class="pointer-container"></div>
  1655. <section class="section">
  1656. <div class="pointer"></div>
  1657. <div class="abstract">
  1658. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is read from the server.</p>
  1659. <p>Only the last closure provided is used.</p>
  1660. </div>
  1661. <div class="declaration">
  1662. <h4>Declaration</h4>
  1663. <div class="language">
  1664. <p class="aside-title">Swift</p>
  1665. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1666. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">downloadProgress</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1667. </div>
  1668. </div>
  1669. <div>
  1670. <h4>Parameters</h4>
  1671. <table class="graybox">
  1672. <tbody>
  1673. <tr>
  1674. <td>
  1675. <code>
  1676. <em>queue</em>
  1677. </code>
  1678. </td>
  1679. <td>
  1680. <div>
  1681. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1682. </div>
  1683. </td>
  1684. </tr>
  1685. <tr>
  1686. <td>
  1687. <code>
  1688. <em>closure</em>
  1689. </code>
  1690. </td>
  1691. <td>
  1692. <div>
  1693. <p>The code to be executed periodically as data is read from the server.</p>
  1694. </div>
  1695. </td>
  1696. </tr>
  1697. </tbody>
  1698. </table>
  1699. </div>
  1700. <div>
  1701. <h4>Return Value</h4>
  1702. <p>The <code>Request</code>.</p>
  1703. </div>
  1704. </section>
  1705. </div>
  1706. </li>
  1707. <li class="item">
  1708. <div>
  1709. <code>
  1710. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1711. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1712. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:closure:)</a>
  1713. </code>
  1714. </div>
  1715. <div class="height-container">
  1716. <div class="pointer-container"></div>
  1717. <section class="section">
  1718. <div class="pointer"></div>
  1719. <div class="abstract">
  1720. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is sent to the server.</p>
  1721. <p>Only the last closure provided is used.</p>
  1722. </div>
  1723. <div class="declaration">
  1724. <h4>Declaration</h4>
  1725. <div class="language">
  1726. <p class="aside-title">Swift</p>
  1727. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1728. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">uploadProgress</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1729. </div>
  1730. </div>
  1731. <div>
  1732. <h4>Parameters</h4>
  1733. <table class="graybox">
  1734. <tbody>
  1735. <tr>
  1736. <td>
  1737. <code>
  1738. <em>queue</em>
  1739. </code>
  1740. </td>
  1741. <td>
  1742. <div>
  1743. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1744. </div>
  1745. </td>
  1746. </tr>
  1747. <tr>
  1748. <td>
  1749. <code>
  1750. <em>closure</em>
  1751. </code>
  1752. </td>
  1753. <td>
  1754. <div>
  1755. <p>The closure to be executed periodically as data is sent to the server.</p>
  1756. </div>
  1757. </td>
  1758. </tr>
  1759. </tbody>
  1760. </table>
  1761. </div>
  1762. <div>
  1763. <h4>Return Value</h4>
  1764. <p>The <code>Request</code>.</p>
  1765. </div>
  1766. </section>
  1767. </div>
  1768. </li>
  1769. </ul>
  1770. </div>
  1771. <div class="task-group">
  1772. <div class="task-name-container">
  1773. <a name="/Redirects"></a>
  1774. <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
  1775. <a href="#/Redirects">
  1776. <h3 class="section-name">Redirects</h3>
  1777. </a>
  1778. </div>
  1779. <ul class="item-container">
  1780. <li class="item">
  1781. <div>
  1782. <code>
  1783. <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
  1784. <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
  1785. <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:)</a>
  1786. </code>
  1787. </div>
  1788. <div class="height-container">
  1789. <div class="pointer-container"></div>
  1790. <section class="section">
  1791. <div class="pointer"></div>
  1792. <div class="abstract">
  1793. <p>Sets the redirect handler for the <code>Request</code> which will be used if a redirect response is encountered.</p>
  1794. </div>
  1795. <div class="declaration">
  1796. <h4>Declaration</h4>
  1797. <div class="language">
  1798. <p class="aside-title">Swift</p>
  1799. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1800. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">redirect</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1801. </div>
  1802. </div>
  1803. <div>
  1804. <h4>Parameters</h4>
  1805. <table class="graybox">
  1806. <tbody>
  1807. <tr>
  1808. <td>
  1809. <code>
  1810. <em>handler</em>
  1811. </code>
  1812. </td>
  1813. <td>
  1814. <div>
  1815. <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
  1816. </div>
  1817. </td>
  1818. </tr>
  1819. </tbody>
  1820. </table>
  1821. </div>
  1822. <div>
  1823. <h4>Return Value</h4>
  1824. <p>The <code>Request</code>.</p>
  1825. </div>
  1826. </section>
  1827. </div>
  1828. </li>
  1829. </ul>
  1830. </div>
  1831. <div class="task-group">
  1832. <div class="task-name-container">
  1833. <a name="/Cached%20Responses"></a>
  1834. <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
  1835. <a href="#/Cached%20Responses">
  1836. <h3 class="section-name">Cached Responses</h3>
  1837. </a>
  1838. </div>
  1839. <ul class="item-container">
  1840. <li class="item">
  1841. <div>
  1842. <code>
  1843. <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
  1844. <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
  1845. <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:)</a>
  1846. </code>
  1847. </div>
  1848. <div class="height-container">
  1849. <div class="pointer-container"></div>
  1850. <section class="section">
  1851. <div class="pointer"></div>
  1852. <div class="abstract">
  1853. <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
  1854. </div>
  1855. <div class="declaration">
  1856. <h4>Declaration</h4>
  1857. <div class="language">
  1858. <p class="aside-title">Swift</p>
  1859. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1860. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">cacheResponse</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1861. </div>
  1862. </div>
  1863. <div>
  1864. <h4>Parameters</h4>
  1865. <table class="graybox">
  1866. <tbody>
  1867. <tr>
  1868. <td>
  1869. <code>
  1870. <em>handler</em>
  1871. </code>
  1872. </td>
  1873. <td>
  1874. <div>
  1875. <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
  1876. </div>
  1877. </td>
  1878. </tr>
  1879. </tbody>
  1880. </table>
  1881. </div>
  1882. <div>
  1883. <h4>Return Value</h4>
  1884. <p>The <code>Request</code>.</p>
  1885. </div>
  1886. </section>
  1887. </div>
  1888. </li>
  1889. </ul>
  1890. </div>
  1891. <div class="task-group">
  1892. <div class="task-name-container">
  1893. <a name="/Cleanup"></a>
  1894. <a name="//apple_ref/swift/Section/Cleanup" class="dashAnchor"></a>
  1895. <a href="#/Cleanup">
  1896. <h3 class="section-name">Cleanup</h3>
  1897. </a>
  1898. </div>
  1899. <ul class="item-container">
  1900. <li class="item">
  1901. <div>
  1902. <code>
  1903. <a name="/s:9Alamofire7RequestC7cleanupyyF"></a>
  1904. <a name="//apple_ref/swift/Method/cleanup()" class="dashAnchor"></a>
  1905. <a class="token" href="#/s:9Alamofire7RequestC7cleanupyyF">cleanup()</a>
  1906. </code>
  1907. </div>
  1908. <div class="height-container">
  1909. <div class="pointer-container"></div>
  1910. <section class="section">
  1911. <div class="pointer"></div>
  1912. <div class="abstract">
  1913. <p>Final cleanup step executed when a <code>Request</code> finishes response serialization.</p>
  1914. </div>
  1915. <div class="declaration">
  1916. <h4>Declaration</h4>
  1917. <div class="language">
  1918. <p class="aside-title">Swift</p>
  1919. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">cleanup</span><span class="p">()</span></code></pre>
  1920. </div>
  1921. </div>
  1922. </section>
  1923. </div>
  1924. </li>
  1925. </ul>
  1926. </div>
  1927. <div class="task-group">
  1928. <ul class="item-container">
  1929. <li class="item">
  1930. <div>
  1931. <code>
  1932. <a name="/s:9Alamofire7RequestC9didResumeSo18NSNotificationNameavpZ"></a>
  1933. <a name="//apple_ref/swift/Variable/didResume" class="dashAnchor"></a>
  1934. <a class="token" href="#/s:9Alamofire7RequestC9didResumeSo18NSNotificationNameavpZ">didResume</a>
  1935. </code>
  1936. </div>
  1937. <div class="height-container">
  1938. <div class="pointer-container"></div>
  1939. <section class="section">
  1940. <div class="pointer"></div>
  1941. <div class="abstract">
  1942. <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  1943. </div>
  1944. <div class="declaration">
  1945. <h4>Declaration</h4>
  1946. <div class="language">
  1947. <p class="aside-title">Swift</p>
  1948. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResume</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1949. </div>
  1950. </div>
  1951. </section>
  1952. </div>
  1953. </li>
  1954. <li class="item">
  1955. <div>
  1956. <code>
  1957. <a name="/s:9Alamofire7RequestC10didSuspendSo18NSNotificationNameavpZ"></a>
  1958. <a name="//apple_ref/swift/Variable/didSuspend" class="dashAnchor"></a>
  1959. <a class="token" href="#/s:9Alamofire7RequestC10didSuspendSo18NSNotificationNameavpZ">didSuspend</a>
  1960. </code>
  1961. </div>
  1962. <div class="height-container">
  1963. <div class="pointer-container"></div>
  1964. <section class="section">
  1965. <div class="pointer"></div>
  1966. <div class="abstract">
  1967. <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  1968. </div>
  1969. <div class="declaration">
  1970. <h4>Declaration</h4>
  1971. <div class="language">
  1972. <p class="aside-title">Swift</p>
  1973. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didSuspend</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1974. </div>
  1975. </div>
  1976. </section>
  1977. </div>
  1978. </li>
  1979. <li class="item">
  1980. <div>
  1981. <code>
  1982. <a name="/s:9Alamofire7RequestC9didCancelSo18NSNotificationNameavpZ"></a>
  1983. <a name="//apple_ref/swift/Variable/didCancel" class="dashAnchor"></a>
  1984. <a class="token" href="#/s:9Alamofire7RequestC9didCancelSo18NSNotificationNameavpZ">didCancel</a>
  1985. </code>
  1986. </div>
  1987. <div class="height-container">
  1988. <div class="pointer-container"></div>
  1989. <section class="section">
  1990. <div class="pointer"></div>
  1991. <div class="abstract">
  1992. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  1993. </div>
  1994. <div class="declaration">
  1995. <h4>Declaration</h4>
  1996. <div class="language">
  1997. <p class="aside-title">Swift</p>
  1998. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancel</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1999. </div>
  2000. </div>
  2001. </section>
  2002. </div>
  2003. </li>
  2004. <li class="item">
  2005. <div>
  2006. <code>
  2007. <a name="/s:9Alamofire7RequestC9didFinishSo18NSNotificationNameavpZ"></a>
  2008. <a name="//apple_ref/swift/Variable/didFinish" class="dashAnchor"></a>
  2009. <a class="token" href="#/s:9Alamofire7RequestC9didFinishSo18NSNotificationNameavpZ">didFinish</a>
  2010. </code>
  2011. </div>
  2012. <div class="height-container">
  2013. <div class="pointer-container"></div>
  2014. <section class="section">
  2015. <div class="pointer"></div>
  2016. <div class="abstract">
  2017. <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  2018. </div>
  2019. <div class="declaration">
  2020. <h4>Declaration</h4>
  2021. <div class="language">
  2022. <p class="aside-title">Swift</p>
  2023. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didFinish</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2024. </div>
  2025. </div>
  2026. </section>
  2027. </div>
  2028. </li>
  2029. </ul>
  2030. </div>
  2031. <div class="task-group">
  2032. <div class="task-name-container">
  2033. <a name="/Protocol%20Conformances"></a>
  2034. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2035. <a href="#/Protocol%20Conformances">
  2036. <h3 class="section-name">Protocol Conformances</h3>
  2037. </a>
  2038. </div>
  2039. <ul class="item-container">
  2040. <li class="item">
  2041. <div>
  2042. <code>
  2043. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  2044. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  2045. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:_:)</a>
  2046. </code>
  2047. </div>
  2048. <div class="height-container">
  2049. <div class="pointer-container"></div>
  2050. <section class="section">
  2051. <div class="pointer"></div>
  2052. <div class="abstract">
  2053. </div>
  2054. <div class="declaration">
  2055. <h4>Declaration</h4>
  2056. <div class="language">
  2057. <p class="aside-title">Swift</p>
  2058. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">Request</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  2059. </div>
  2060. </div>
  2061. </section>
  2062. </div>
  2063. </li>
  2064. </ul>
  2065. </div>
  2066. <div class="task-group">
  2067. <div class="task-name-container">
  2068. <a name="/Protocol%20Conformances2"></a>
  2069. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2070. <a href="#/Protocol%20Conformances2">
  2071. <h3 class="section-name">Protocol Conformances</h3>
  2072. </a>
  2073. </div>
  2074. <ul class="item-container">
  2075. <li class="item">
  2076. <div>
  2077. <code>
  2078. <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
  2079. <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
  2080. <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:)</a>
  2081. </code>
  2082. </div>
  2083. <div class="height-container">
  2084. <div class="pointer-container"></div>
  2085. <section class="section">
  2086. <div class="pointer"></div>
  2087. <div class="abstract">
  2088. </div>
  2089. <div class="declaration">
  2090. <h4>Declaration</h4>
  2091. <div class="language">
  2092. <p class="aside-title">Swift</p>
  2093. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hash</span><span class="p">(</span><span class="n">into</span> <span class="nv">hasher</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Hasher</span><span class="p">)</span></code></pre>
  2094. </div>
  2095. </div>
  2096. </section>
  2097. </div>
  2098. </li>
  2099. </ul>
  2100. </div>
  2101. <div class="task-group">
  2102. <div class="task-name-container">
  2103. <a name="/Protocol%20Conformances3"></a>
  2104. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2105. <a href="#/Protocol%20Conformances3">
  2106. <h3 class="section-name">Protocol Conformances</h3>
  2107. </a>
  2108. </div>
  2109. <ul class="item-container">
  2110. <li class="item">
  2111. <div>
  2112. <code>
  2113. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  2114. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  2115. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  2116. </code>
  2117. </div>
  2118. <div class="height-container">
  2119. <div class="pointer-container"></div>
  2120. <section class="section">
  2121. <div class="pointer"></div>
  2122. <div class="abstract">
  2123. <p>A textual representation of this instance, including the <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code> and <code>URL</code> if the <code>URLRequest</code> has been
  2124. created, as well as the response status code, if a response has been received.</p>
  2125. </div>
  2126. <div class="declaration">
  2127. <h4>Declaration</h4>
  2128. <div class="language">
  2129. <p class="aside-title">Swift</p>
  2130. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  2131. </div>
  2132. </div>
  2133. </section>
  2134. </div>
  2135. </li>
  2136. </ul>
  2137. </div>
  2138. <div class="task-group">
  2139. <div class="task-name-container">
  2140. <a name="/Protocol%20Conformances4"></a>
  2141. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2142. <a href="#/Protocol%20Conformances4">
  2143. <h3 class="section-name">Protocol Conformances</h3>
  2144. </a>
  2145. </div>
  2146. <ul class="item-container">
  2147. <li class="item">
  2148. <div>
  2149. <code>
  2150. <a name="/s:9Alamofire7RequestC16debugDescriptionSSvp"></a>
  2151. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  2152. <a class="token" href="#/s:9Alamofire7RequestC16debugDescriptionSSvp">debugDescription</a>
  2153. </code>
  2154. </div>
  2155. <div class="height-container">
  2156. <div class="pointer-container"></div>
  2157. <section class="section">
  2158. <div class="pointer"></div>
  2159. <div class="abstract">
  2160. <p>A textual representation of this instance in the form of a cURL command.</p>
  2161. </div>
  2162. <div class="declaration">
  2163. <h4>Declaration</h4>
  2164. <div class="language">
  2165. <p class="aside-title">Swift</p>
  2166. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  2167. </div>
  2168. </div>
  2169. </section>
  2170. </div>
  2171. </li>
  2172. </ul>
  2173. </div>
  2174. <div class="task-group">
  2175. <div class="task-name-container">
  2176. <a name="/Helper%20Types"></a>
  2177. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  2178. <a href="#/Helper%20Types">
  2179. <h3 class="section-name">Helper Types</h3>
  2180. </a>
  2181. </div>
  2182. <ul class="item-container">
  2183. <li class="item">
  2184. <div>
  2185. <code>
  2186. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  2187. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  2188. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  2189. </code>
  2190. </div>
  2191. <div class="height-container">
  2192. <div class="pointer-container"></div>
  2193. <section class="section">
  2194. <div class="pointer"></div>
  2195. <div class="abstract">
  2196. <p>Used to represent whether a validation succeeded or failed.</p>
  2197. </div>
  2198. <div class="declaration">
  2199. <h4>Declaration</h4>
  2200. <div class="language">
  2201. <p class="aside-title">Swift</p>
  2202. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">ValidationResult</span> <span class="o">=</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a></span><span class="o">&lt;</span><span class="kt">Void</span><span class="o">&gt;</span></code></pre>
  2203. </div>
  2204. </div>
  2205. </section>
  2206. </div>
  2207. </li>
  2208. </ul>
  2209. </div>
  2210. </div>
  2211. </section>
  2212. </article>
  2213. </div>
  2214. <section class="footer">
  2215. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-03-29)</p>
  2216. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  2217. </section>
  2218. </body>
  2219. </div>
  2220. </html>