Request.html 131 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516
  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. (98% 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/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  254. </li>
  255. </ul>
  256. </li>
  257. <li class="nav-group-name">
  258. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  259. <ul class="nav-group-tasks">
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  322. </li>
  323. </ul>
  324. </li>
  325. <li class="nav-group-name">
  326. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  327. <ul class="nav-group-tasks">
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  381. </li>
  382. </ul>
  383. </li>
  384. <li class="nav-group-name">
  385. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  386. <ul class="nav-group-tasks">
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  404. </li>
  405. </ul>
  406. </li>
  407. </ul>
  408. </nav>
  409. <article class="main-content">
  410. <section class="section">
  411. <div class="section-content">
  412. <h1>Request</h1>
  413. <div class="declaration">
  414. <div class="language">
  415. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  416. </div>
  417. </div>
  418. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  419. handling.</p>
  420. </div>
  421. </section>
  422. <section class="section">
  423. <div class="section-content">
  424. <div class="task-group">
  425. <ul class="item-container">
  426. <li class="item">
  427. <div>
  428. <code>
  429. <a name="/s:9Alamofire7RequestC5StateO"></a>
  430. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  431. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  432. </code>
  433. </div>
  434. <div class="height-container">
  435. <div class="pointer-container"></div>
  436. <section class="section">
  437. <div class="pointer"></div>
  438. <div class="abstract">
  439. <p>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
  440. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  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> providing 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="kd">private(set)</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="/Mutable%20State"></a>
  619. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  620. <a href="#/Mutable%20State">
  621. <h3 class="section-name">Mutable 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="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="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:9Alamofire7RequestC13isInitializedSbvp"></a>
  654. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  655. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</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>.initialized</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">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>
  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:9Alamofire7RequestC11isCancelledSbvp"></a>
  729. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  730. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</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>.cancelled</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">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>
  745. </div>
  746. </div>
  747. </section>
  748. </div>
  749. </li>
  750. <li class="item">
  751. <div>
  752. <code>
  753. <a name="/s:9Alamofire7RequestC10isFinishedSbvp"></a>
  754. <a name="//apple_ref/swift/Property/isFinished" class="dashAnchor"></a>
  755. <a class="token" href="#/s:9Alamofire7RequestC10isFinishedSbvp">isFinished</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>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.finished</code>.</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="k">var</span> <span class="nv">isFinished</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>
  770. </div>
  771. </div>
  772. </section>
  773. </div>
  774. </li>
  775. </ul>
  776. </div>
  777. <div class="task-group">
  778. <div class="task-name-container">
  779. <a name="/Progress"></a>
  780. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  781. <a href="#/Progress">
  782. <h3 class="section-name">Progress</h3>
  783. </a>
  784. </div>
  785. <ul class="item-container">
  786. <li class="item">
  787. <div>
  788. <code>
  789. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  790. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  791. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  792. </code>
  793. </div>
  794. <div class="height-container">
  795. <div class="pointer-container"></div>
  796. <section class="section">
  797. <div class="pointer"></div>
  798. <div class="abstract">
  799. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  800. </div>
  801. <div class="declaration">
  802. <h4>Declaration</h4>
  803. <div class="language">
  804. <p class="aside-title">Swift</p>
  805. <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>
  806. </div>
  807. </div>
  808. </section>
  809. </div>
  810. </li>
  811. <li class="item">
  812. <div>
  813. <code>
  814. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  815. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  816. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  817. </code>
  818. </div>
  819. <div class="height-container">
  820. <div class="pointer-container"></div>
  821. <section class="section">
  822. <div class="pointer"></div>
  823. <div class="abstract">
  824. <p><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>
  825. </div>
  826. <div class="declaration">
  827. <h4>Declaration</h4>
  828. <div class="language">
  829. <p class="aside-title">Swift</p>
  830. <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>
  831. </div>
  832. </div>
  833. </section>
  834. </div>
  835. </li>
  836. <li class="item">
  837. <div>
  838. <code>
  839. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  840. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  841. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  842. </code>
  843. </div>
  844. <div class="height-container">
  845. <div class="pointer-container"></div>
  846. <section class="section">
  847. <div class="pointer"></div>
  848. <div class="abstract">
  849. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  850. </div>
  851. <div class="declaration">
  852. <h4>Declaration</h4>
  853. <div class="language">
  854. <p class="aside-title">Swift</p>
  855. <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>
  856. </div>
  857. </div>
  858. </section>
  859. </div>
  860. </li>
  861. </ul>
  862. </div>
  863. <div class="task-group">
  864. <div class="task-name-container">
  865. <a name="/Redirect%20Handling"></a>
  866. <a name="//apple_ref/swift/Section/Redirect Handling" class="dashAnchor"></a>
  867. <a href="#/Redirect%20Handling">
  868. <h3 class="section-name">Redirect Handling</h3>
  869. </a>
  870. </div>
  871. <ul class="item-container">
  872. <li class="item">
  873. <div>
  874. <code>
  875. <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  876. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  877. <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  878. </code>
  879. </div>
  880. <div class="height-container">
  881. <div class="pointer-container"></div>
  882. <section class="section">
  883. <div class="pointer"></div>
  884. <div class="abstract">
  885. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> set on the instance.</p>
  886. </div>
  887. <div class="declaration">
  888. <h4>Declaration</h4>
  889. <div class="language">
  890. <p class="aside-title">Swift</p>
  891. <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>
  892. </div>
  893. </div>
  894. </section>
  895. </div>
  896. </li>
  897. </ul>
  898. </div>
  899. <div class="task-group">
  900. <div class="task-name-container">
  901. <a name="/Cached%20Response%20Handling"></a>
  902. <a name="//apple_ref/swift/Section/Cached Response Handling" class="dashAnchor"></a>
  903. <a href="#/Cached%20Response%20Handling">
  904. <h3 class="section-name">Cached Response Handling</h3>
  905. </a>
  906. </div>
  907. <ul class="item-container">
  908. <li class="item">
  909. <div>
  910. <code>
  911. <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  912. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  913. <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  914. </code>
  915. </div>
  916. <div class="height-container">
  917. <div class="pointer-container"></div>
  918. <section class="section">
  919. <div class="pointer"></div>
  920. <div class="abstract">
  921. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> set on the instance.</p>
  922. </div>
  923. <div class="declaration">
  924. <h4>Declaration</h4>
  925. <div class="language">
  926. <p class="aside-title">Swift</p>
  927. <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>
  928. </div>
  929. </div>
  930. </section>
  931. </div>
  932. </li>
  933. </ul>
  934. </div>
  935. <div class="task-group">
  936. <div class="task-name-container">
  937. <a name="/URLCredential"></a>
  938. <a name="//apple_ref/swift/Section/URLCredential" class="dashAnchor"></a>
  939. <a href="#/URLCredential">
  940. <h3 class="section-name">URLCredential</h3>
  941. </a>
  942. </div>
  943. <ul class="item-container">
  944. <li class="item">
  945. <div>
  946. <code>
  947. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  948. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  949. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  950. </code>
  951. </div>
  952. <div class="height-container">
  953. <div class="pointer-container"></div>
  954. <section class="section">
  955. <div class="pointer"></div>
  956. <div class="abstract">
  957. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  958. </div>
  959. <div class="declaration">
  960. <h4>Declaration</h4>
  961. <div class="language">
  962. <p class="aside-title">Swift</p>
  963. <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>
  964. </div>
  965. </div>
  966. </section>
  967. </div>
  968. </li>
  969. </ul>
  970. </div>
  971. <div class="task-group">
  972. <div class="task-name-container">
  973. <a name="/URLRequests"></a>
  974. <a name="//apple_ref/swift/Section/URLRequests" class="dashAnchor"></a>
  975. <a href="#/URLRequests">
  976. <h3 class="section-name">URLRequests</h3>
  977. </a>
  978. </div>
  979. <ul class="item-container">
  980. <li class="item">
  981. <div>
  982. <code>
  983. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  984. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  985. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
  986. </code>
  987. </div>
  988. <div class="height-container">
  989. <div class="pointer-container"></div>
  990. <section class="section">
  991. <div class="pointer"></div>
  992. <div class="abstract">
  993. <p>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  994. </div>
  995. <div class="declaration">
  996. <h4>Declaration</h4>
  997. <div class="language">
  998. <p class="aside-title">Swift</p>
  999. <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>
  1000. </div>
  1001. </div>
  1002. </section>
  1003. </div>
  1004. </li>
  1005. <li class="item">
  1006. <div>
  1007. <code>
  1008. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  1009. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  1010. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  1011. </code>
  1012. </div>
  1013. <div class="height-container">
  1014. <div class="pointer-container"></div>
  1015. <section class="section">
  1016. <div class="pointer"></div>
  1017. <div class="abstract">
  1018. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  1019. </div>
  1020. <div class="declaration">
  1021. <h4>Declaration</h4>
  1022. <div class="language">
  1023. <p class="aside-title">Swift</p>
  1024. <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>
  1025. </div>
  1026. </div>
  1027. </section>
  1028. </div>
  1029. </li>
  1030. <li class="item">
  1031. <div>
  1032. <code>
  1033. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  1034. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  1035. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  1036. </code>
  1037. </div>
  1038. <div class="height-container">
  1039. <div class="pointer-container"></div>
  1040. <section class="section">
  1041. <div class="pointer"></div>
  1042. <div class="abstract">
  1043. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1044. </div>
  1045. <div class="declaration">
  1046. <h4>Declaration</h4>
  1047. <div class="language">
  1048. <p class="aside-title">Swift</p>
  1049. <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>
  1050. </div>
  1051. </div>
  1052. </section>
  1053. </div>
  1054. </li>
  1055. <li class="item">
  1056. <div>
  1057. <code>
  1058. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  1059. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  1060. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  1061. </code>
  1062. </div>
  1063. <div class="height-container">
  1064. <div class="pointer-container"></div>
  1065. <section class="section">
  1066. <div class="pointer"></div>
  1067. <div class="abstract">
  1068. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1069. </div>
  1070. <div class="declaration">
  1071. <h4>Declaration</h4>
  1072. <div class="language">
  1073. <p class="aside-title">Swift</p>
  1074. <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>
  1075. </div>
  1076. </div>
  1077. </section>
  1078. </div>
  1079. </li>
  1080. <li class="item">
  1081. <div>
  1082. <code>
  1083. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  1084. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  1085. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  1086. </code>
  1087. </div>
  1088. <div class="height-container">
  1089. <div class="pointer-container"></div>
  1090. <section class="section">
  1091. <div class="pointer"></div>
  1092. <div class="abstract">
  1093. <p><code>URLRequest</code>s from all of the <code>URLSessionTask</code>s executed on behalf of the <code>Request</code>. May be different from
  1094. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a></code> due to <code>URLSession</code> manipulation.</p>
  1095. </div>
  1096. <div class="declaration">
  1097. <h4>Declaration</h4>
  1098. <div class="language">
  1099. <p class="aside-title">Swift</p>
  1100. <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>
  1101. </div>
  1102. </div>
  1103. </section>
  1104. </div>
  1105. </li>
  1106. </ul>
  1107. </div>
  1108. <div class="task-group">
  1109. <div class="task-name-container">
  1110. <a name="/HTTPURLResponse"></a>
  1111. <a name="//apple_ref/swift/Section/HTTPURLResponse" class="dashAnchor"></a>
  1112. <a href="#/HTTPURLResponse">
  1113. <h3 class="section-name">HTTPURLResponse</h3>
  1114. </a>
  1115. </div>
  1116. <ul class="item-container">
  1117. <li class="item">
  1118. <div>
  1119. <code>
  1120. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  1121. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  1122. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  1123. </code>
  1124. </div>
  1125. <div class="height-container">
  1126. <div class="pointer-container"></div>
  1127. <section class="section">
  1128. <div class="pointer"></div>
  1129. <div class="abstract">
  1130. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  1131. last <code>URLSessionTask</code>.</p>
  1132. </div>
  1133. <div class="declaration">
  1134. <h4>Declaration</h4>
  1135. <div class="language">
  1136. <p class="aside-title">Swift</p>
  1137. <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>
  1138. </div>
  1139. </div>
  1140. </section>
  1141. </div>
  1142. </li>
  1143. </ul>
  1144. </div>
  1145. <div class="task-group">
  1146. <div class="task-name-container">
  1147. <a name="/Tasks"></a>
  1148. <a name="//apple_ref/swift/Section/Tasks" class="dashAnchor"></a>
  1149. <a href="#/Tasks">
  1150. <h3 class="section-name">Tasks</h3>
  1151. </a>
  1152. </div>
  1153. <ul class="item-container">
  1154. <li class="item">
  1155. <div>
  1156. <code>
  1157. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  1158. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  1159. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  1160. </code>
  1161. </div>
  1162. <div class="height-container">
  1163. <div class="pointer-container"></div>
  1164. <section class="section">
  1165. <div class="pointer"></div>
  1166. <div class="abstract">
  1167. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  1168. </div>
  1169. <div class="declaration">
  1170. <h4>Declaration</h4>
  1171. <div class="language">
  1172. <p class="aside-title">Swift</p>
  1173. <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>
  1174. </div>
  1175. </div>
  1176. </section>
  1177. </div>
  1178. </li>
  1179. <li class="item">
  1180. <div>
  1181. <code>
  1182. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  1183. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  1184. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  1185. </code>
  1186. </div>
  1187. <div class="height-container">
  1188. <div class="pointer-container"></div>
  1189. <section class="section">
  1190. <div class="pointer"></div>
  1191. <div class="abstract">
  1192. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1193. </div>
  1194. <div class="declaration">
  1195. <h4>Declaration</h4>
  1196. <div class="language">
  1197. <p class="aside-title">Swift</p>
  1198. <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>
  1199. </div>
  1200. </div>
  1201. </section>
  1202. </div>
  1203. </li>
  1204. <li class="item">
  1205. <div>
  1206. <code>
  1207. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  1208. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  1209. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  1210. </code>
  1211. </div>
  1212. <div class="height-container">
  1213. <div class="pointer-container"></div>
  1214. <section class="section">
  1215. <div class="pointer"></div>
  1216. <div class="abstract">
  1217. <p>Last <code>URLSessionTask</code> crated on behalf of the <code>Request</code>.</p>
  1218. </div>
  1219. <div class="declaration">
  1220. <h4>Declaration</h4>
  1221. <div class="language">
  1222. <p class="aside-title">Swift</p>
  1223. <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>
  1224. </div>
  1225. </div>
  1226. </section>
  1227. </div>
  1228. </li>
  1229. <li class="item">
  1230. <div>
  1231. <code>
  1232. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1233. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1234. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1235. </code>
  1236. </div>
  1237. <div class="height-container">
  1238. <div class="pointer-container"></div>
  1239. <section class="section">
  1240. <div class="pointer"></div>
  1241. <div class="abstract">
  1242. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1243. </div>
  1244. <div class="declaration">
  1245. <h4>Declaration</h4>
  1246. <div class="language">
  1247. <p class="aside-title">Swift</p>
  1248. <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>
  1249. </div>
  1250. </div>
  1251. </section>
  1252. </div>
  1253. </li>
  1254. </ul>
  1255. </div>
  1256. <div class="task-group">
  1257. <div class="task-name-container">
  1258. <a name="/Metrics"></a>
  1259. <a name="//apple_ref/swift/Section/Metrics" class="dashAnchor"></a>
  1260. <a href="#/Metrics">
  1261. <h3 class="section-name">Metrics</h3>
  1262. </a>
  1263. </div>
  1264. <ul class="item-container">
  1265. <li class="item">
  1266. <div>
  1267. <code>
  1268. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1269. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1270. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1271. </code>
  1272. </div>
  1273. <div class="height-container">
  1274. <div class="pointer-container"></div>
  1275. <section class="section">
  1276. <div class="pointer"></div>
  1277. <div class="abstract">
  1278. <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>
  1279. </div>
  1280. <div class="declaration">
  1281. <h4>Declaration</h4>
  1282. <div class="language">
  1283. <p class="aside-title">Swift</p>
  1284. <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>
  1285. </div>
  1286. </div>
  1287. </section>
  1288. </div>
  1289. </li>
  1290. <li class="item">
  1291. <div>
  1292. <code>
  1293. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1294. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1295. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1296. </code>
  1297. </div>
  1298. <div class="height-container">
  1299. <div class="pointer-container"></div>
  1300. <section class="section">
  1301. <div class="pointer"></div>
  1302. <div class="abstract">
  1303. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1304. </div>
  1305. <div class="declaration">
  1306. <h4>Declaration</h4>
  1307. <div class="language">
  1308. <p class="aside-title">Swift</p>
  1309. <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>
  1310. </div>
  1311. </div>
  1312. </section>
  1313. </div>
  1314. </li>
  1315. <li class="item">
  1316. <div>
  1317. <code>
  1318. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1319. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1320. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1321. </code>
  1322. </div>
  1323. <div class="height-container">
  1324. <div class="pointer-container"></div>
  1325. <section class="section">
  1326. <div class="pointer"></div>
  1327. <div class="abstract">
  1328. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1329. </div>
  1330. <div class="declaration">
  1331. <h4>Declaration</h4>
  1332. <div class="language">
  1333. <p class="aside-title">Swift</p>
  1334. <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>
  1335. </div>
  1336. </div>
  1337. </section>
  1338. </div>
  1339. </li>
  1340. <li class="item">
  1341. <div>
  1342. <code>
  1343. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1344. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1345. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1346. </code>
  1347. </div>
  1348. <div class="height-container">
  1349. <div class="pointer-container"></div>
  1350. <section class="section">
  1351. <div class="pointer"></div>
  1352. <div class="abstract">
  1353. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1354. </div>
  1355. <div class="declaration">
  1356. <h4>Declaration</h4>
  1357. <div class="language">
  1358. <p class="aside-title">Swift</p>
  1359. <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>
  1360. </div>
  1361. </div>
  1362. </section>
  1363. </div>
  1364. </li>
  1365. </ul>
  1366. </div>
  1367. <div class="task-group">
  1368. <div class="task-name-container">
  1369. <a name="/Retry%20Count"></a>
  1370. <a name="//apple_ref/swift/Section/Retry Count" class="dashAnchor"></a>
  1371. <a href="#/Retry%20Count">
  1372. <h3 class="section-name">Retry Count</h3>
  1373. </a>
  1374. </div>
  1375. <ul class="item-container">
  1376. <li class="item">
  1377. <div>
  1378. <code>
  1379. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1380. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1381. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1382. </code>
  1383. </div>
  1384. <div class="height-container">
  1385. <div class="pointer-container"></div>
  1386. <section class="section">
  1387. <div class="pointer"></div>
  1388. <div class="abstract">
  1389. <p>Number of times the <code>Request</code> has been retried.</p>
  1390. </div>
  1391. <div class="declaration">
  1392. <h4>Declaration</h4>
  1393. <div class="language">
  1394. <p class="aside-title">Swift</p>
  1395. <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>
  1396. </div>
  1397. </div>
  1398. </section>
  1399. </div>
  1400. </li>
  1401. </ul>
  1402. </div>
  1403. <div class="task-group">
  1404. <div class="task-name-container">
  1405. <a name="/Error"></a>
  1406. <a name="//apple_ref/swift/Section/Error" class="dashAnchor"></a>
  1407. <a href="#/Error">
  1408. <h3 class="section-name">Error</h3>
  1409. </a>
  1410. </div>
  1411. <ul class="item-container">
  1412. <li class="item">
  1413. <div>
  1414. <code>
  1415. <a name="/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp"></a>
  1416. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1417. <a class="token" href="#/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp">error</a>
  1418. </code>
  1419. </div>
  1420. <div class="height-container">
  1421. <div class="pointer-container"></div>
  1422. <section class="section">
  1423. <div class="pointer"></div>
  1424. <div class="abstract">
  1425. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1426. </div>
  1427. <div class="declaration">
  1428. <h4>Declaration</h4>
  1429. <div class="language">
  1430. <p class="aside-title">Swift</p>
  1431. <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">error</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError.html">AFError</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>
  1432. </div>
  1433. </div>
  1434. </section>
  1435. </div>
  1436. </li>
  1437. </ul>
  1438. </div>
  1439. <div class="task-group">
  1440. <div class="task-name-container">
  1441. <a name="/State"></a>
  1442. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1443. <a href="#/State">
  1444. <h3 class="section-name">State</h3>
  1445. </a>
  1446. </div>
  1447. <ul class="item-container">
  1448. <li class="item">
  1449. <div>
  1450. <code>
  1451. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1452. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1453. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1454. </code>
  1455. </div>
  1456. <div class="height-container">
  1457. <div class="pointer-container"></div>
  1458. <section class="section">
  1459. <div class="pointer"></div>
  1460. <div class="abstract">
  1461. <p>Cancels the instance. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1462. </div>
  1463. <div class="declaration">
  1464. <h4>Declaration</h4>
  1465. <div class="language">
  1466. <p class="aside-title">Swift</p>
  1467. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1468. <span class="kd">public</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>
  1469. </div>
  1470. </div>
  1471. <div>
  1472. <h4>Return Value</h4>
  1473. <p>The instance.</p>
  1474. </div>
  1475. </section>
  1476. </div>
  1477. </li>
  1478. <li class="item">
  1479. <div>
  1480. <code>
  1481. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1482. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1483. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1484. </code>
  1485. </div>
  1486. <div class="height-container">
  1487. <div class="pointer-container"></div>
  1488. <section class="section">
  1489. <div class="pointer"></div>
  1490. <div class="abstract">
  1491. <p>Suspends the instance.</p>
  1492. </div>
  1493. <div class="declaration">
  1494. <h4>Declaration</h4>
  1495. <div class="language">
  1496. <p class="aside-title">Swift</p>
  1497. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1498. <span class="kd">public</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>
  1499. </div>
  1500. </div>
  1501. <div>
  1502. <h4>Return Value</h4>
  1503. <p>The instance.</p>
  1504. </div>
  1505. </section>
  1506. </div>
  1507. </li>
  1508. <li class="item">
  1509. <div>
  1510. <code>
  1511. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1512. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1513. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1514. </code>
  1515. </div>
  1516. <div class="height-container">
  1517. <div class="pointer-container"></div>
  1518. <section class="section">
  1519. <div class="pointer"></div>
  1520. <div class="abstract">
  1521. <p>Resumes the instance.</p>
  1522. </div>
  1523. <div class="declaration">
  1524. <h4>Declaration</h4>
  1525. <div class="language">
  1526. <p class="aside-title">Swift</p>
  1527. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1528. <span class="kd">public</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>
  1529. </div>
  1530. </div>
  1531. <div>
  1532. <h4>Return Value</h4>
  1533. <p>The instance.</p>
  1534. </div>
  1535. </section>
  1536. </div>
  1537. </li>
  1538. </ul>
  1539. </div>
  1540. <div class="task-group">
  1541. <div class="task-name-container">
  1542. <a name="/Closure%20API"></a>
  1543. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1544. <a href="#/Closure%20API">
  1545. <h3 class="section-name">Closure API</h3>
  1546. </a>
  1547. </div>
  1548. <ul class="item-container">
  1549. <li class="item">
  1550. <div>
  1551. <code>
  1552. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1553. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1554. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:password:persistence:)</a>
  1555. </code>
  1556. </div>
  1557. <div class="height-container">
  1558. <div class="pointer-container"></div>
  1559. <section class="section">
  1560. <div class="pointer"></div>
  1561. <div class="abstract">
  1562. <p>Associates a credential using the provided values with the instance.</p>
  1563. </div>
  1564. <div class="declaration">
  1565. <h4>Declaration</h4>
  1566. <div class="language">
  1567. <p class="aside-title">Swift</p>
  1568. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1569. <span class="kd">public</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>
  1570. </div>
  1571. </div>
  1572. <div>
  1573. <h4>Parameters</h4>
  1574. <table class="graybox">
  1575. <tbody>
  1576. <tr>
  1577. <td>
  1578. <code>
  1579. <em>username</em>
  1580. </code>
  1581. </td>
  1582. <td>
  1583. <div>
  1584. <p>The username.</p>
  1585. </div>
  1586. </td>
  1587. </tr>
  1588. <tr>
  1589. <td>
  1590. <code>
  1591. <em>password</em>
  1592. </code>
  1593. </td>
  1594. <td>
  1595. <div>
  1596. <p>The password.</p>
  1597. </div>
  1598. </td>
  1599. </tr>
  1600. <tr>
  1601. <td>
  1602. <code>
  1603. <em>persistence</em>
  1604. </code>
  1605. </td>
  1606. <td>
  1607. <div>
  1608. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>. <code>.forSession</code> by default.</p>
  1609. </div>
  1610. </td>
  1611. </tr>
  1612. </tbody>
  1613. </table>
  1614. </div>
  1615. <div>
  1616. <h4>Return Value</h4>
  1617. <p>The instance.</p>
  1618. </div>
  1619. </section>
  1620. </div>
  1621. </li>
  1622. <li class="item">
  1623. <div>
  1624. <code>
  1625. <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1626. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1627. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:)</a>
  1628. </code>
  1629. </div>
  1630. <div class="height-container">
  1631. <div class="pointer-container"></div>
  1632. <section class="section">
  1633. <div class="pointer"></div>
  1634. <div class="abstract">
  1635. <p>Associates the provided credential with the instance.</p>
  1636. </div>
  1637. <div class="declaration">
  1638. <h4>Declaration</h4>
  1639. <div class="language">
  1640. <p class="aside-title">Swift</p>
  1641. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1642. <span class="kd">public</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>
  1643. </div>
  1644. </div>
  1645. <div>
  1646. <h4>Parameters</h4>
  1647. <table class="graybox">
  1648. <tbody>
  1649. <tr>
  1650. <td>
  1651. <code>
  1652. <em>credential</em>
  1653. </code>
  1654. </td>
  1655. <td>
  1656. <div>
  1657. <p>The <code>URLCredential</code>.</p>
  1658. </div>
  1659. </td>
  1660. </tr>
  1661. </tbody>
  1662. </table>
  1663. </div>
  1664. <div>
  1665. <h4>Return Value</h4>
  1666. <p>The instance.</p>
  1667. </div>
  1668. </section>
  1669. </div>
  1670. </li>
  1671. <li class="item">
  1672. <div>
  1673. <code>
  1674. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1675. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1676. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  1677. </code>
  1678. </div>
  1679. <div class="height-container">
  1680. <div class="pointer-container"></div>
  1681. <section class="section">
  1682. <div class="pointer"></div>
  1683. <div class="abstract">
  1684. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is read from the server.</p>
  1685. <div class="aside aside-note">
  1686. <p class="aside-title">Note</p>
  1687. <p>Only the last closure provided is used.</p>
  1688. </div>
  1689. </div>
  1690. <div class="declaration">
  1691. <h4>Declaration</h4>
  1692. <div class="language">
  1693. <p class="aside-title">Swift</p>
  1694. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1695. <span class="kd">public</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>
  1696. </div>
  1697. </div>
  1698. <div>
  1699. <h4>Parameters</h4>
  1700. <table class="graybox">
  1701. <tbody>
  1702. <tr>
  1703. <td>
  1704. <code>
  1705. <em>queue</em>
  1706. </code>
  1707. </td>
  1708. <td>
  1709. <div>
  1710. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1711. </div>
  1712. </td>
  1713. </tr>
  1714. <tr>
  1715. <td>
  1716. <code>
  1717. <em>closure</em>
  1718. </code>
  1719. </td>
  1720. <td>
  1721. <div>
  1722. <p>The closure to be executed periodically as data is read from the server.</p>
  1723. </div>
  1724. </td>
  1725. </tr>
  1726. </tbody>
  1727. </table>
  1728. </div>
  1729. <div>
  1730. <h4>Return Value</h4>
  1731. <p>The instance.</p>
  1732. </div>
  1733. </section>
  1734. </div>
  1735. </li>
  1736. <li class="item">
  1737. <div>
  1738. <code>
  1739. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1740. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1741. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:closure:)</a>
  1742. </code>
  1743. </div>
  1744. <div class="height-container">
  1745. <div class="pointer-container"></div>
  1746. <section class="section">
  1747. <div class="pointer"></div>
  1748. <div class="abstract">
  1749. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is sent to the server.</p>
  1750. <div class="aside aside-note">
  1751. <p class="aside-title">Note</p>
  1752. <p>Only the last closure provided is used.</p>
  1753. </div>
  1754. </div>
  1755. <div class="declaration">
  1756. <h4>Declaration</h4>
  1757. <div class="language">
  1758. <p class="aside-title">Swift</p>
  1759. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1760. <span class="kd">public</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>
  1761. </div>
  1762. </div>
  1763. <div>
  1764. <h4>Parameters</h4>
  1765. <table class="graybox">
  1766. <tbody>
  1767. <tr>
  1768. <td>
  1769. <code>
  1770. <em>queue</em>
  1771. </code>
  1772. </td>
  1773. <td>
  1774. <div>
  1775. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1776. </div>
  1777. </td>
  1778. </tr>
  1779. <tr>
  1780. <td>
  1781. <code>
  1782. <em>closure</em>
  1783. </code>
  1784. </td>
  1785. <td>
  1786. <div>
  1787. <p>The closure to be executed periodically as data is sent to the server.</p>
  1788. </div>
  1789. </td>
  1790. </tr>
  1791. </tbody>
  1792. </table>
  1793. </div>
  1794. <div>
  1795. <h4>Return Value</h4>
  1796. <p>The instance.</p>
  1797. </div>
  1798. </section>
  1799. </div>
  1800. </li>
  1801. </ul>
  1802. </div>
  1803. <div class="task-group">
  1804. <div class="task-name-container">
  1805. <a name="/Redirects"></a>
  1806. <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
  1807. <a href="#/Redirects">
  1808. <h3 class="section-name">Redirects</h3>
  1809. </a>
  1810. </div>
  1811. <ul class="item-container">
  1812. <li class="item">
  1813. <div>
  1814. <code>
  1815. <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
  1816. <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
  1817. <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:)</a>
  1818. </code>
  1819. </div>
  1820. <div class="height-container">
  1821. <div class="pointer-container"></div>
  1822. <section class="section">
  1823. <div class="pointer"></div>
  1824. <div class="abstract">
  1825. <p>Sets the redirect handler for the instance which will be used if a redirect response is encountered.</p>
  1826. <div class="aside aside-note">
  1827. <p class="aside-title">Note</p>
  1828. <p>Attempting to set the redirect handler more than once is a logic error and will crash.</p>
  1829. </div>
  1830. </div>
  1831. <div class="declaration">
  1832. <h4>Declaration</h4>
  1833. <div class="language">
  1834. <p class="aside-title">Swift</p>
  1835. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1836. <span class="kd">public</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>
  1837. </div>
  1838. </div>
  1839. <div>
  1840. <h4>Parameters</h4>
  1841. <table class="graybox">
  1842. <tbody>
  1843. <tr>
  1844. <td>
  1845. <code>
  1846. <em>handler</em>
  1847. </code>
  1848. </td>
  1849. <td>
  1850. <div>
  1851. <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
  1852. </div>
  1853. </td>
  1854. </tr>
  1855. </tbody>
  1856. </table>
  1857. </div>
  1858. <div>
  1859. <h4>Return Value</h4>
  1860. <p>The instance.</p>
  1861. </div>
  1862. </section>
  1863. </div>
  1864. </li>
  1865. </ul>
  1866. </div>
  1867. <div class="task-group">
  1868. <div class="task-name-container">
  1869. <a name="/Cached%20Responses"></a>
  1870. <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
  1871. <a href="#/Cached%20Responses">
  1872. <h3 class="section-name">Cached Responses</h3>
  1873. </a>
  1874. </div>
  1875. <ul class="item-container">
  1876. <li class="item">
  1877. <div>
  1878. <code>
  1879. <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
  1880. <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
  1881. <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:)</a>
  1882. </code>
  1883. </div>
  1884. <div class="height-container">
  1885. <div class="pointer-container"></div>
  1886. <section class="section">
  1887. <div class="pointer"></div>
  1888. <div class="abstract">
  1889. <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
  1890. <div class="aside aside-note">
  1891. <p class="aside-title">Note</p>
  1892. <p>Attempting to set the cache handler more than once is a logic error and will crash.</p>
  1893. </div>
  1894. </div>
  1895. <div class="declaration">
  1896. <h4>Declaration</h4>
  1897. <div class="language">
  1898. <p class="aside-title">Swift</p>
  1899. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1900. <span class="kd">public</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>
  1901. </div>
  1902. </div>
  1903. <div>
  1904. <h4>Parameters</h4>
  1905. <table class="graybox">
  1906. <tbody>
  1907. <tr>
  1908. <td>
  1909. <code>
  1910. <em>handler</em>
  1911. </code>
  1912. </td>
  1913. <td>
  1914. <div>
  1915. <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
  1916. </div>
  1917. </td>
  1918. </tr>
  1919. </tbody>
  1920. </table>
  1921. </div>
  1922. <div>
  1923. <h4>Return Value</h4>
  1924. <p>The instance.</p>
  1925. </div>
  1926. </section>
  1927. </div>
  1928. </li>
  1929. <li class="item">
  1930. <div>
  1931. <code>
  1932. <a name="/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF"></a>
  1933. <a name="//apple_ref/swift/Method/cURLDescription(calling:)" class="dashAnchor"></a>
  1934. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF">cURLDescription(calling:)</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>Sets a handler to be called when the cURL description of the request is available.</p>
  1943. <div class="aside aside-note">
  1944. <p class="aside-title">Note</p>
  1945. <p>When waiting for a <code>Request</code>&lsquo;s <code>URLRequest</code> to be created, only the last <code>handler</code> will be called.</p>
  1946. </div>
  1947. </div>
  1948. <div class="declaration">
  1949. <h4>Declaration</h4>
  1950. <div class="language">
  1951. <p class="aside-title">Swift</p>
  1952. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1953. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">calling</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1954. </div>
  1955. </div>
  1956. <div>
  1957. <h4>Parameters</h4>
  1958. <table class="graybox">
  1959. <tbody>
  1960. <tr>
  1961. <td>
  1962. <code>
  1963. <em>handler</em>
  1964. </code>
  1965. </td>
  1966. <td>
  1967. <div>
  1968. <p>Closure to be called when the cURL description is available.</p>
  1969. </div>
  1970. </td>
  1971. </tr>
  1972. </tbody>
  1973. </table>
  1974. </div>
  1975. <div>
  1976. <h4>Return Value</h4>
  1977. <p>The instance.</p>
  1978. </div>
  1979. </section>
  1980. </div>
  1981. </li>
  1982. </ul>
  1983. </div>
  1984. <div class="task-group">
  1985. <ul class="item-container">
  1986. <li class="item">
  1987. <div>
  1988. <code>
  1989. <a name="/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ"></a>
  1990. <a name="//apple_ref/swift/Variable/didResumeNotification" class="dashAnchor"></a>
  1991. <a class="token" href="#/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ">didResumeNotification</a>
  1992. </code>
  1993. </div>
  1994. <div class="height-container">
  1995. <div class="pointer-container"></div>
  1996. <section class="section">
  1997. <div class="pointer"></div>
  1998. <div class="abstract">
  1999. <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  2000. </div>
  2001. <div class="declaration">
  2002. <h4>Declaration</h4>
  2003. <div class="language">
  2004. <p class="aside-title">Swift</p>
  2005. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResumeNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2006. </div>
  2007. </div>
  2008. </section>
  2009. </div>
  2010. </li>
  2011. <li class="item">
  2012. <div>
  2013. <code>
  2014. <a name="/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ"></a>
  2015. <a name="//apple_ref/swift/Variable/didSuspendNotification" class="dashAnchor"></a>
  2016. <a class="token" href="#/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ">didSuspendNotification</a>
  2017. </code>
  2018. </div>
  2019. <div class="height-container">
  2020. <div class="pointer-container"></div>
  2021. <section class="section">
  2022. <div class="pointer"></div>
  2023. <div class="abstract">
  2024. <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  2025. </div>
  2026. <div class="declaration">
  2027. <h4>Declaration</h4>
  2028. <div class="language">
  2029. <p class="aside-title">Swift</p>
  2030. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didSuspendNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2031. </div>
  2032. </div>
  2033. </section>
  2034. </div>
  2035. </li>
  2036. <li class="item">
  2037. <div>
  2038. <code>
  2039. <a name="/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ"></a>
  2040. <a name="//apple_ref/swift/Variable/didCancelNotification" class="dashAnchor"></a>
  2041. <a class="token" href="#/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ">didCancelNotification</a>
  2042. </code>
  2043. </div>
  2044. <div class="height-container">
  2045. <div class="pointer-container"></div>
  2046. <section class="section">
  2047. <div class="pointer"></div>
  2048. <div class="abstract">
  2049. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  2050. </div>
  2051. <div class="declaration">
  2052. <h4>Declaration</h4>
  2053. <div class="language">
  2054. <p class="aside-title">Swift</p>
  2055. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancelNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2056. </div>
  2057. </div>
  2058. </section>
  2059. </div>
  2060. </li>
  2061. <li class="item">
  2062. <div>
  2063. <code>
  2064. <a name="/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ"></a>
  2065. <a name="//apple_ref/swift/Variable/didFinishNotification" class="dashAnchor"></a>
  2066. <a class="token" href="#/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ">didFinishNotification</a>
  2067. </code>
  2068. </div>
  2069. <div class="height-container">
  2070. <div class="pointer-container"></div>
  2071. <section class="section">
  2072. <div class="pointer"></div>
  2073. <div class="abstract">
  2074. <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  2075. </div>
  2076. <div class="declaration">
  2077. <h4>Declaration</h4>
  2078. <div class="language">
  2079. <p class="aside-title">Swift</p>
  2080. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didFinishNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2081. </div>
  2082. </div>
  2083. </section>
  2084. </div>
  2085. </li>
  2086. <li class="item">
  2087. <div>
  2088. <code>
  2089. <a name="/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ"></a>
  2090. <a name="//apple_ref/swift/Variable/didResumeTaskNotification" class="dashAnchor"></a>
  2091. <a class="token" href="#/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ">didResumeTaskNotification</a>
  2092. </code>
  2093. </div>
  2094. <div class="height-container">
  2095. <div class="pointer-container"></div>
  2096. <section class="section">
  2097. <div class="pointer"></div>
  2098. <div class="abstract">
  2099. <p>Posted when a <code>URLSessionTask</code> is resumed. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2100. </div>
  2101. <div class="declaration">
  2102. <h4>Declaration</h4>
  2103. <div class="language">
  2104. <p class="aside-title">Swift</p>
  2105. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResumeTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2106. </div>
  2107. </div>
  2108. </section>
  2109. </div>
  2110. </li>
  2111. <li class="item">
  2112. <div>
  2113. <code>
  2114. <a name="/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ"></a>
  2115. <a name="//apple_ref/swift/Variable/didSuspendTaskNotification" class="dashAnchor"></a>
  2116. <a class="token" href="#/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ">didSuspendTaskNotification</a>
  2117. </code>
  2118. </div>
  2119. <div class="height-container">
  2120. <div class="pointer-container"></div>
  2121. <section class="section">
  2122. <div class="pointer"></div>
  2123. <div class="abstract">
  2124. <p>Posted when a <code>URLSessionTask</code> is suspended. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</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">static</span> <span class="k">let</span> <span class="nv">didSuspendTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2131. </div>
  2132. </div>
  2133. </section>
  2134. </div>
  2135. </li>
  2136. <li class="item">
  2137. <div>
  2138. <code>
  2139. <a name="/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ"></a>
  2140. <a name="//apple_ref/swift/Variable/didCancelTaskNotification" class="dashAnchor"></a>
  2141. <a class="token" href="#/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ">didCancelTaskNotification</a>
  2142. </code>
  2143. </div>
  2144. <div class="height-container">
  2145. <div class="pointer-container"></div>
  2146. <section class="section">
  2147. <div class="pointer"></div>
  2148. <div class="abstract">
  2149. <p>Posted when a <code>URLSessionTask</code> is cancelled. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2150. </div>
  2151. <div class="declaration">
  2152. <h4>Declaration</h4>
  2153. <div class="language">
  2154. <p class="aside-title">Swift</p>
  2155. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancelTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2156. </div>
  2157. </div>
  2158. </section>
  2159. </div>
  2160. </li>
  2161. <li class="item">
  2162. <div>
  2163. <code>
  2164. <a name="/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ"></a>
  2165. <a name="//apple_ref/swift/Variable/didCompleteTaskNotification" class="dashAnchor"></a>
  2166. <a class="token" href="#/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ">didCompleteTaskNotification</a>
  2167. </code>
  2168. </div>
  2169. <div class="height-container">
  2170. <div class="pointer-container"></div>
  2171. <section class="section">
  2172. <div class="pointer"></div>
  2173. <div class="abstract">
  2174. <p>Posted when a <code>URLSessionTask</code> is completed. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2175. </div>
  2176. <div class="declaration">
  2177. <h4>Declaration</h4>
  2178. <div class="language">
  2179. <p class="aside-title">Swift</p>
  2180. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCompleteTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2181. </div>
  2182. </div>
  2183. </section>
  2184. </div>
  2185. </li>
  2186. </ul>
  2187. </div>
  2188. <div class="task-group">
  2189. <div class="task-name-container">
  2190. <a name="/Protocol%20Conformances"></a>
  2191. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2192. <a href="#/Protocol%20Conformances">
  2193. <h3 class="section-name">Protocol Conformances</h3>
  2194. </a>
  2195. </div>
  2196. <ul class="item-container">
  2197. <li class="item">
  2198. <div>
  2199. <code>
  2200. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  2201. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  2202. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:_:)</a>
  2203. </code>
  2204. </div>
  2205. <div class="height-container">
  2206. <div class="pointer-container"></div>
  2207. <section class="section">
  2208. <div class="pointer"></div>
  2209. <div class="abstract">
  2210. </div>
  2211. <div class="declaration">
  2212. <h4>Declaration</h4>
  2213. <div class="language">
  2214. <p class="aside-title">Swift</p>
  2215. <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>
  2216. </div>
  2217. </div>
  2218. </section>
  2219. </div>
  2220. </li>
  2221. </ul>
  2222. </div>
  2223. <div class="task-group">
  2224. <div class="task-name-container">
  2225. <a name="/Protocol%20Conformances2"></a>
  2226. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2227. <a href="#/Protocol%20Conformances2">
  2228. <h3 class="section-name">Protocol Conformances</h3>
  2229. </a>
  2230. </div>
  2231. <ul class="item-container">
  2232. <li class="item">
  2233. <div>
  2234. <code>
  2235. <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
  2236. <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
  2237. <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:)</a>
  2238. </code>
  2239. </div>
  2240. <div class="height-container">
  2241. <div class="pointer-container"></div>
  2242. <section class="section">
  2243. <div class="pointer"></div>
  2244. <div class="abstract">
  2245. </div>
  2246. <div class="declaration">
  2247. <h4>Declaration</h4>
  2248. <div class="language">
  2249. <p class="aside-title">Swift</p>
  2250. <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>
  2251. </div>
  2252. </div>
  2253. </section>
  2254. </div>
  2255. </li>
  2256. </ul>
  2257. </div>
  2258. <div class="task-group">
  2259. <div class="task-name-container">
  2260. <a name="/Protocol%20Conformances3"></a>
  2261. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2262. <a href="#/Protocol%20Conformances3">
  2263. <h3 class="section-name">Protocol Conformances</h3>
  2264. </a>
  2265. </div>
  2266. <ul class="item-container">
  2267. <li class="item">
  2268. <div>
  2269. <code>
  2270. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  2271. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  2272. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  2273. </code>
  2274. </div>
  2275. <div class="height-container">
  2276. <div class="pointer-container"></div>
  2277. <section class="section">
  2278. <div class="pointer"></div>
  2279. <div class="abstract">
  2280. <p>A textual representation of this instance, including the <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> and <code>URL</code> if the <code>URLRequest</code> has been
  2281. created, as well as the response status code, if a response has been received.</p>
  2282. </div>
  2283. <div class="declaration">
  2284. <h4>Declaration</h4>
  2285. <div class="language">
  2286. <p class="aside-title">Swift</p>
  2287. <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>
  2288. </div>
  2289. </div>
  2290. </section>
  2291. </div>
  2292. </li>
  2293. </ul>
  2294. </div>
  2295. <div class="task-group">
  2296. <div class="task-name-container">
  2297. <a name="/Protocol%20Conformances4"></a>
  2298. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2299. <a href="#/Protocol%20Conformances4">
  2300. <h3 class="section-name">Protocol Conformances</h3>
  2301. </a>
  2302. </div>
  2303. <ul class="item-container">
  2304. <li class="item">
  2305. <div>
  2306. <code>
  2307. <a name="/s:9Alamofire7RequestC15cURLDescriptionSSyF"></a>
  2308. <a name="//apple_ref/swift/Method/cURLDescription()" class="dashAnchor"></a>
  2309. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescriptionSSyF">cURLDescription()</a>
  2310. </code>
  2311. </div>
  2312. <div class="height-container">
  2313. <div class="pointer-container"></div>
  2314. <section class="section">
  2315. <div class="pointer"></div>
  2316. <div class="abstract">
  2317. <p>cURL representation of the instance.</p>
  2318. </div>
  2319. <div class="declaration">
  2320. <h4>Declaration</h4>
  2321. <div class="language">
  2322. <p class="aside-title">Swift</p>
  2323. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
  2324. </div>
  2325. </div>
  2326. <div>
  2327. <h4>Return Value</h4>
  2328. <p>The cURL equivalent of the instance.</p>
  2329. </div>
  2330. </section>
  2331. </div>
  2332. </li>
  2333. </ul>
  2334. </div>
  2335. <div class="task-group">
  2336. <div class="task-name-container">
  2337. <a name="/Helper%20Types"></a>
  2338. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  2339. <a href="#/Helper%20Types">
  2340. <h3 class="section-name">Helper Types</h3>
  2341. </a>
  2342. </div>
  2343. <ul class="item-container">
  2344. <li class="item">
  2345. <div>
  2346. <code>
  2347. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  2348. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  2349. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  2350. </code>
  2351. </div>
  2352. <div class="height-container">
  2353. <div class="pointer-container"></div>
  2354. <section class="section">
  2355. <div class="pointer"></div>
  2356. <div class="abstract">
  2357. <p>Used to represent whether a validation succeeded or failed.</p>
  2358. </div>
  2359. <div class="declaration">
  2360. <h4>Declaration</h4>
  2361. <div class="language">
  2362. <p class="aside-title">Swift</p>
  2363. <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">Result</span><span class="o">&lt;</span><span class="kt">Void</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span></code></pre>
  2364. </div>
  2365. </div>
  2366. </section>
  2367. </div>
  2368. </li>
  2369. </ul>
  2370. </div>
  2371. </div>
  2372. </section>
  2373. </article>
  2374. </div>
  2375. <section class="footer">
  2376. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-26)</p>
  2377. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  2378. </section>
  2379. </body>
  2380. </div>
  2381. </html>