Request.html 149 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822
  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 5.3.0 Docs
  21. </a>
  22. (97% 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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  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/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. </ul>
  463. </li>
  464. <li class="nav-group-name">
  465. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  466. <ul class="nav-group-tasks">
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  487. </li>
  488. </ul>
  489. </li>
  490. </ul>
  491. </nav>
  492. <article class="main-content">
  493. <section class="section">
  494. <div class="section-content top-matter">
  495. <h1>Request</h1>
  496. <div class="declaration">
  497. <div class="language">
  498. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  499. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
  500. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">Hashable</span></code></pre>
  501. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  502. </div>
  503. </div>
  504. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  505. handling.</p>
  506. </div>
  507. </section>
  508. <section class="section">
  509. <div class="section-content">
  510. <div class="task-group">
  511. <ul class="item-container">
  512. <li class="item">
  513. <div>
  514. <code>
  515. <a name="/s:9Alamofire7RequestC5StateO"></a>
  516. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  517. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  518. </code>
  519. </div>
  520. <div class="height-container">
  521. <div class="pointer-container"></div>
  522. <section class="section">
  523. <div class="pointer"></div>
  524. <div class="abstract">
  525. <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
  526. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  527. <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
  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="kd">enum</span> <span class="kt">State</span></code></pre>
  534. </div>
  535. </div>
  536. </section>
  537. </div>
  538. </li>
  539. </ul>
  540. </div>
  541. <div class="task-group">
  542. <div class="task-name-container">
  543. <a name="/Initial%20State"></a>
  544. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  545. <div class="section-name-container">
  546. <a class="section-name-link" href="#/Initial%20State"></a>
  547. <h3 class="section-name"><p>Initial State</p>
  548. </h3>
  549. </div>
  550. </div>
  551. <ul class="item-container">
  552. <li class="item">
  553. <div>
  554. <code>
  555. <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
  556. <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
  557. <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
  558. </code>
  559. </div>
  560. <div class="height-container">
  561. <div class="pointer-container"></div>
  562. <section class="section">
  563. <div class="pointer"></div>
  564. <div class="abstract">
  565. <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>
  566. </div>
  567. <div class="declaration">
  568. <h4>Declaration</h4>
  569. <div class="language">
  570. <p class="aside-title">Swift</p>
  571. <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>
  572. </div>
  573. </div>
  574. </section>
  575. </div>
  576. </li>
  577. <li class="item">
  578. <div>
  579. <code>
  580. <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
  581. <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
  582. <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
  583. </code>
  584. </div>
  585. <div class="height-container">
  586. <div class="pointer-container"></div>
  587. <section class="section">
  588. <div class="pointer"></div>
  589. <div class="abstract">
  590. <p>The serial queue for all internal async actions.</p>
  591. </div>
  592. <div class="declaration">
  593. <h4>Declaration</h4>
  594. <div class="language">
  595. <p class="aside-title">Swift</p>
  596. <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>
  597. </div>
  598. </div>
  599. </section>
  600. </div>
  601. </li>
  602. <li class="item">
  603. <div>
  604. <code>
  605. <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  606. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  607. <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  608. </code>
  609. </div>
  610. <div class="height-container">
  611. <div class="pointer-container"></div>
  612. <section class="section">
  613. <div class="pointer"></div>
  614. <div class="abstract">
  615. <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>
  616. </div>
  617. <div class="declaration">
  618. <h4>Declaration</h4>
  619. <div class="language">
  620. <p class="aside-title">Swift</p>
  621. <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>
  622. </div>
  623. </div>
  624. </section>
  625. </div>
  626. </li>
  627. <li class="item">
  628. <div>
  629. <code>
  630. <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
  631. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  632. <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
  633. </code>
  634. </div>
  635. <div class="height-container">
  636. <div class="pointer-container"></div>
  637. <section class="section">
  638. <div class="pointer"></div>
  639. <div class="abstract">
  640. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
  641. </div>
  642. <div class="declaration">
  643. <h4>Declaration</h4>
  644. <div class="language">
  645. <p class="aside-title">Swift</p>
  646. <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>
  647. </div>
  648. </div>
  649. </section>
  650. </div>
  651. </li>
  652. <li class="item">
  653. <div>
  654. <code>
  655. <a name="/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp"></a>
  656. <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
  657. <a class="token" href="#/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp">interceptor</a>
  658. </code>
  659. </div>
  660. <div class="height-container">
  661. <div class="pointer-container"></div>
  662. <section class="section">
  663. <div class="pointer"></div>
  664. <div class="abstract">
  665. <p>The <code>Request</code>&lsquo;s interceptor.</p>
  666. </div>
  667. <div class="declaration">
  668. <h4>Declaration</h4>
  669. <div class="language">
  670. <p class="aside-title">Swift</p>
  671. <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>
  672. </div>
  673. </div>
  674. </section>
  675. </div>
  676. </li>
  677. <li class="item">
  678. <div>
  679. <code>
  680. <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp"></a>
  681. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  682. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp">delegate</a>
  683. </code>
  684. </div>
  685. <div class="height-container">
  686. <div class="pointer-container"></div>
  687. <section class="section">
  688. <div class="pointer"></div>
  689. <div class="abstract">
  690. <p>The <code>Request</code>&lsquo;s delegate.</p>
  691. </div>
  692. <div class="declaration">
  693. <h4>Declaration</h4>
  694. <div class="language">
  695. <p class="aside-title">Swift</p>
  696. <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> <span class="k">get</span> <span class="p">}</span></code></pre>
  697. </div>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. </ul>
  703. </div>
  704. <div class="task-group">
  705. <div class="task-name-container">
  706. <a name="/Mutable%20State"></a>
  707. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  708. <div class="section-name-container">
  709. <a class="section-name-link" href="#/Mutable%20State"></a>
  710. <h3 class="section-name"><p>Mutable State</p>
  711. </h3>
  712. </div>
  713. </div>
  714. <ul class="item-container">
  715. <li class="item">
  716. <div>
  717. <code>
  718. <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
  719. <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
  720. <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
  721. </code>
  722. </div>
  723. <div class="height-container">
  724. <div class="pointer-container"></div>
  725. <section class="section">
  726. <div class="pointer"></div>
  727. <div class="abstract">
  728. <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
  729. </div>
  730. <div class="declaration">
  731. <h4>Declaration</h4>
  732. <div class="language">
  733. <p class="aside-title">Swift</p>
  734. <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>
  735. </div>
  736. </div>
  737. </section>
  738. </div>
  739. </li>
  740. <li class="item">
  741. <div>
  742. <code>
  743. <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
  744. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  745. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
  746. </code>
  747. </div>
  748. <div class="height-container">
  749. <div class="pointer-container"></div>
  750. <section class="section">
  751. <div class="pointer"></div>
  752. <div class="abstract">
  753. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
  754. </div>
  755. <div class="declaration">
  756. <h4>Declaration</h4>
  757. <div class="language">
  758. <p class="aside-title">Swift</p>
  759. <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>
  760. </div>
  761. </div>
  762. </section>
  763. </div>
  764. </li>
  765. <li class="item">
  766. <div>
  767. <code>
  768. <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
  769. <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
  770. <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
  771. </code>
  772. </div>
  773. <div class="height-container">
  774. <div class="pointer-container"></div>
  775. <section class="section">
  776. <div class="pointer"></div>
  777. <div class="abstract">
  778. <p>Returns whether <code>state is</code>.resumed`.</p>
  779. </div>
  780. <div class="declaration">
  781. <h4>Declaration</h4>
  782. <div class="language">
  783. <p class="aside-title">Swift</p>
  784. <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>
  785. </div>
  786. </div>
  787. </section>
  788. </div>
  789. </li>
  790. <li class="item">
  791. <div>
  792. <code>
  793. <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
  794. <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
  795. <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
  796. </code>
  797. </div>
  798. <div class="height-container">
  799. <div class="pointer-container"></div>
  800. <section class="section">
  801. <div class="pointer"></div>
  802. <div class="abstract">
  803. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
  804. </div>
  805. <div class="declaration">
  806. <h4>Declaration</h4>
  807. <div class="language">
  808. <p class="aside-title">Swift</p>
  809. <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>
  810. </div>
  811. </div>
  812. </section>
  813. </div>
  814. </li>
  815. <li class="item">
  816. <div>
  817. <code>
  818. <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
  819. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  820. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
  821. </code>
  822. </div>
  823. <div class="height-container">
  824. <div class="pointer-container"></div>
  825. <section class="section">
  826. <div class="pointer"></div>
  827. <div class="abstract">
  828. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
  829. </div>
  830. <div class="declaration">
  831. <h4>Declaration</h4>
  832. <div class="language">
  833. <p class="aside-title">Swift</p>
  834. <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>
  835. </div>
  836. </div>
  837. </section>
  838. </div>
  839. </li>
  840. <li class="item">
  841. <div>
  842. <code>
  843. <a name="/s:9Alamofire7RequestC10isFinishedSbvp"></a>
  844. <a name="//apple_ref/swift/Property/isFinished" class="dashAnchor"></a>
  845. <a class="token" href="#/s:9Alamofire7RequestC10isFinishedSbvp">isFinished</a>
  846. </code>
  847. </div>
  848. <div class="height-container">
  849. <div class="pointer-container"></div>
  850. <section class="section">
  851. <div class="pointer"></div>
  852. <div class="abstract">
  853. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.finished</code>.</p>
  854. </div>
  855. <div class="declaration">
  856. <h4>Declaration</h4>
  857. <div class="language">
  858. <p class="aside-title">Swift</p>
  859. <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>
  860. </div>
  861. </div>
  862. </section>
  863. </div>
  864. </li>
  865. </ul>
  866. </div>
  867. <div class="task-group">
  868. <div class="task-name-container">
  869. <a name="/Progress"></a>
  870. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  871. <div class="section-name-container">
  872. <a class="section-name-link" href="#/Progress"></a>
  873. <h3 class="section-name"><p>Progress</p>
  874. </h3>
  875. </div>
  876. </div>
  877. <ul class="item-container">
  878. <li class="item">
  879. <div>
  880. <code>
  881. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  882. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  883. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  884. </code>
  885. </div>
  886. <div class="height-container">
  887. <div class="pointer-container"></div>
  888. <section class="section">
  889. <div class="pointer"></div>
  890. <div class="abstract">
  891. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  892. </div>
  893. <div class="declaration">
  894. <h4>Declaration</h4>
  895. <div class="language">
  896. <p class="aside-title">Swift</p>
  897. <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>
  898. </div>
  899. </div>
  900. </section>
  901. </div>
  902. </li>
  903. <li class="item">
  904. <div>
  905. <code>
  906. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  907. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  908. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  909. </code>
  910. </div>
  911. <div class="height-container">
  912. <div class="pointer-container"></div>
  913. <section class="section">
  914. <div class="pointer"></div>
  915. <div class="abstract">
  916. <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>
  917. </div>
  918. <div class="declaration">
  919. <h4>Declaration</h4>
  920. <div class="language">
  921. <p class="aside-title">Swift</p>
  922. <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>
  923. </div>
  924. </div>
  925. </section>
  926. </div>
  927. </li>
  928. <li class="item">
  929. <div>
  930. <code>
  931. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  932. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  933. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  934. </code>
  935. </div>
  936. <div class="height-container">
  937. <div class="pointer-container"></div>
  938. <section class="section">
  939. <div class="pointer"></div>
  940. <div class="abstract">
  941. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  942. </div>
  943. <div class="declaration">
  944. <h4>Declaration</h4>
  945. <div class="language">
  946. <p class="aside-title">Swift</p>
  947. <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>
  948. </div>
  949. </div>
  950. </section>
  951. </div>
  952. </li>
  953. </ul>
  954. </div>
  955. <div class="task-group">
  956. <div class="task-name-container">
  957. <a name="/Redirect%20Handling"></a>
  958. <a name="//apple_ref/swift/Section/Redirect Handling" class="dashAnchor"></a>
  959. <div class="section-name-container">
  960. <a class="section-name-link" href="#/Redirect%20Handling"></a>
  961. <h3 class="section-name"><p>Redirect Handling</p>
  962. </h3>
  963. </div>
  964. </div>
  965. <ul class="item-container">
  966. <li class="item">
  967. <div>
  968. <code>
  969. <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  970. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  971. <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  972. </code>
  973. </div>
  974. <div class="height-container">
  975. <div class="pointer-container"></div>
  976. <section class="section">
  977. <div class="pointer"></div>
  978. <div class="abstract">
  979. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> set on the instance.</p>
  980. </div>
  981. <div class="declaration">
  982. <h4>Declaration</h4>
  983. <div class="language">
  984. <p class="aside-title">Swift</p>
  985. <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>
  986. </div>
  987. </div>
  988. </section>
  989. </div>
  990. </li>
  991. </ul>
  992. </div>
  993. <div class="task-group">
  994. <div class="task-name-container">
  995. <a name="/Cached%20Response%20Handling"></a>
  996. <a name="//apple_ref/swift/Section/Cached Response Handling" class="dashAnchor"></a>
  997. <div class="section-name-container">
  998. <a class="section-name-link" href="#/Cached%20Response%20Handling"></a>
  999. <h3 class="section-name"><p>Cached Response Handling</p>
  1000. </h3>
  1001. </div>
  1002. </div>
  1003. <ul class="item-container">
  1004. <li class="item">
  1005. <div>
  1006. <code>
  1007. <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  1008. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  1009. <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  1010. </code>
  1011. </div>
  1012. <div class="height-container">
  1013. <div class="pointer-container"></div>
  1014. <section class="section">
  1015. <div class="pointer"></div>
  1016. <div class="abstract">
  1017. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> set on the instance.</p>
  1018. </div>
  1019. <div class="declaration">
  1020. <h4>Declaration</h4>
  1021. <div class="language">
  1022. <p class="aside-title">Swift</p>
  1023. <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>
  1024. </div>
  1025. </div>
  1026. </section>
  1027. </div>
  1028. </li>
  1029. </ul>
  1030. </div>
  1031. <div class="task-group">
  1032. <div class="task-name-container">
  1033. <a name="/URLCredential"></a>
  1034. <a name="//apple_ref/swift/Section/URLCredential" class="dashAnchor"></a>
  1035. <div class="section-name-container">
  1036. <a class="section-name-link" href="#/URLCredential"></a>
  1037. <h3 class="section-name"><p>URLCredential</p>
  1038. </h3>
  1039. </div>
  1040. </div>
  1041. <ul class="item-container">
  1042. <li class="item">
  1043. <div>
  1044. <code>
  1045. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  1046. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  1047. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  1048. </code>
  1049. </div>
  1050. <div class="height-container">
  1051. <div class="pointer-container"></div>
  1052. <section class="section">
  1053. <div class="pointer"></div>
  1054. <div class="abstract">
  1055. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  1056. </div>
  1057. <div class="declaration">
  1058. <h4>Declaration</h4>
  1059. <div class="language">
  1060. <p class="aside-title">Swift</p>
  1061. <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>
  1062. </div>
  1063. </div>
  1064. </section>
  1065. </div>
  1066. </li>
  1067. </ul>
  1068. </div>
  1069. <div class="task-group">
  1070. <div class="task-name-container">
  1071. <a name="/URLRequests"></a>
  1072. <a name="//apple_ref/swift/Section/URLRequests" class="dashAnchor"></a>
  1073. <div class="section-name-container">
  1074. <a class="section-name-link" href="#/URLRequests"></a>
  1075. <h3 class="section-name"><p>URLRequests</p>
  1076. </h3>
  1077. </div>
  1078. </div>
  1079. <ul class="item-container">
  1080. <li class="item">
  1081. <div>
  1082. <code>
  1083. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  1084. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  1085. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</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>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  1094. </div>
  1095. <div class="declaration">
  1096. <h4>Declaration</h4>
  1097. <div class="language">
  1098. <p class="aside-title">Swift</p>
  1099. <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>
  1100. </div>
  1101. </div>
  1102. </section>
  1103. </div>
  1104. </li>
  1105. <li class="item">
  1106. <div>
  1107. <code>
  1108. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  1109. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  1110. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  1111. </code>
  1112. </div>
  1113. <div class="height-container">
  1114. <div class="pointer-container"></div>
  1115. <section class="section">
  1116. <div class="pointer"></div>
  1117. <div class="abstract">
  1118. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  1119. </div>
  1120. <div class="declaration">
  1121. <h4>Declaration</h4>
  1122. <div class="language">
  1123. <p class="aside-title">Swift</p>
  1124. <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>
  1125. </div>
  1126. </div>
  1127. </section>
  1128. </div>
  1129. </li>
  1130. <li class="item">
  1131. <div>
  1132. <code>
  1133. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  1134. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  1135. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  1136. </code>
  1137. </div>
  1138. <div class="height-container">
  1139. <div class="pointer-container"></div>
  1140. <section class="section">
  1141. <div class="pointer"></div>
  1142. <div class="abstract">
  1143. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1144. </div>
  1145. <div class="declaration">
  1146. <h4>Declaration</h4>
  1147. <div class="language">
  1148. <p class="aside-title">Swift</p>
  1149. <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>
  1150. </div>
  1151. </div>
  1152. </section>
  1153. </div>
  1154. </li>
  1155. <li class="item">
  1156. <div>
  1157. <code>
  1158. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  1159. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  1160. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  1161. </code>
  1162. </div>
  1163. <div class="height-container">
  1164. <div class="pointer-container"></div>
  1165. <section class="section">
  1166. <div class="pointer"></div>
  1167. <div class="abstract">
  1168. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1169. </div>
  1170. <div class="declaration">
  1171. <h4>Declaration</h4>
  1172. <div class="language">
  1173. <p class="aside-title">Swift</p>
  1174. <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>
  1175. </div>
  1176. </div>
  1177. </section>
  1178. </div>
  1179. </li>
  1180. <li class="item">
  1181. <div>
  1182. <code>
  1183. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  1184. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  1185. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  1186. </code>
  1187. </div>
  1188. <div class="height-container">
  1189. <div class="pointer-container"></div>
  1190. <section class="section">
  1191. <div class="pointer"></div>
  1192. <div class="abstract">
  1193. <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
  1194. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a></code> due to <code>URLSession</code> manipulation.</p>
  1195. </div>
  1196. <div class="declaration">
  1197. <h4>Declaration</h4>
  1198. <div class="language">
  1199. <p class="aside-title">Swift</p>
  1200. <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>
  1201. </div>
  1202. </div>
  1203. </section>
  1204. </div>
  1205. </li>
  1206. </ul>
  1207. </div>
  1208. <div class="task-group">
  1209. <div class="task-name-container">
  1210. <a name="/HTTPURLResponse"></a>
  1211. <a name="//apple_ref/swift/Section/HTTPURLResponse" class="dashAnchor"></a>
  1212. <div class="section-name-container">
  1213. <a class="section-name-link" href="#/HTTPURLResponse"></a>
  1214. <h3 class="section-name"><p>HTTPURLResponse</p>
  1215. </h3>
  1216. </div>
  1217. </div>
  1218. <ul class="item-container">
  1219. <li class="item">
  1220. <div>
  1221. <code>
  1222. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  1223. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  1224. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  1225. </code>
  1226. </div>
  1227. <div class="height-container">
  1228. <div class="pointer-container"></div>
  1229. <section class="section">
  1230. <div class="pointer"></div>
  1231. <div class="abstract">
  1232. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  1233. last <code>URLSessionTask</code>.</p>
  1234. </div>
  1235. <div class="declaration">
  1236. <h4>Declaration</h4>
  1237. <div class="language">
  1238. <p class="aside-title">Swift</p>
  1239. <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>
  1240. </div>
  1241. </div>
  1242. </section>
  1243. </div>
  1244. </li>
  1245. </ul>
  1246. </div>
  1247. <div class="task-group">
  1248. <div class="task-name-container">
  1249. <a name="/Tasks"></a>
  1250. <a name="//apple_ref/swift/Section/Tasks" class="dashAnchor"></a>
  1251. <div class="section-name-container">
  1252. <a class="section-name-link" href="#/Tasks"></a>
  1253. <h3 class="section-name"><p>Tasks</p>
  1254. </h3>
  1255. </div>
  1256. </div>
  1257. <ul class="item-container">
  1258. <li class="item">
  1259. <div>
  1260. <code>
  1261. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  1262. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  1263. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  1264. </code>
  1265. </div>
  1266. <div class="height-container">
  1267. <div class="pointer-container"></div>
  1268. <section class="section">
  1269. <div class="pointer"></div>
  1270. <div class="abstract">
  1271. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  1272. </div>
  1273. <div class="declaration">
  1274. <h4>Declaration</h4>
  1275. <div class="language">
  1276. <p class="aside-title">Swift</p>
  1277. <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>
  1278. </div>
  1279. </div>
  1280. </section>
  1281. </div>
  1282. </li>
  1283. <li class="item">
  1284. <div>
  1285. <code>
  1286. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  1287. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  1288. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  1289. </code>
  1290. </div>
  1291. <div class="height-container">
  1292. <div class="pointer-container"></div>
  1293. <section class="section">
  1294. <div class="pointer"></div>
  1295. <div class="abstract">
  1296. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1297. </div>
  1298. <div class="declaration">
  1299. <h4>Declaration</h4>
  1300. <div class="language">
  1301. <p class="aside-title">Swift</p>
  1302. <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>
  1303. </div>
  1304. </div>
  1305. </section>
  1306. </div>
  1307. </li>
  1308. <li class="item">
  1309. <div>
  1310. <code>
  1311. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  1312. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  1313. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  1314. </code>
  1315. </div>
  1316. <div class="height-container">
  1317. <div class="pointer-container"></div>
  1318. <section class="section">
  1319. <div class="pointer"></div>
  1320. <div class="abstract">
  1321. <p>Last <code>URLSessionTask</code> crated on behalf of the <code>Request</code>.</p>
  1322. </div>
  1323. <div class="declaration">
  1324. <h4>Declaration</h4>
  1325. <div class="language">
  1326. <p class="aside-title">Swift</p>
  1327. <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>
  1328. </div>
  1329. </div>
  1330. </section>
  1331. </div>
  1332. </li>
  1333. <li class="item">
  1334. <div>
  1335. <code>
  1336. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1337. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1338. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1339. </code>
  1340. </div>
  1341. <div class="height-container">
  1342. <div class="pointer-container"></div>
  1343. <section class="section">
  1344. <div class="pointer"></div>
  1345. <div class="abstract">
  1346. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1347. </div>
  1348. <div class="declaration">
  1349. <h4>Declaration</h4>
  1350. <div class="language">
  1351. <p class="aside-title">Swift</p>
  1352. <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>
  1353. </div>
  1354. </div>
  1355. </section>
  1356. </div>
  1357. </li>
  1358. </ul>
  1359. </div>
  1360. <div class="task-group">
  1361. <div class="task-name-container">
  1362. <a name="/Metrics"></a>
  1363. <a name="//apple_ref/swift/Section/Metrics" class="dashAnchor"></a>
  1364. <div class="section-name-container">
  1365. <a class="section-name-link" href="#/Metrics"></a>
  1366. <h3 class="section-name"><p>Metrics</p>
  1367. </h3>
  1368. </div>
  1369. </div>
  1370. <ul class="item-container">
  1371. <li class="item">
  1372. <div>
  1373. <code>
  1374. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1375. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1376. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1377. </code>
  1378. </div>
  1379. <div class="height-container">
  1380. <div class="pointer-container"></div>
  1381. <section class="section">
  1382. <div class="pointer"></div>
  1383. <div class="abstract">
  1384. <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>
  1385. </div>
  1386. <div class="declaration">
  1387. <h4>Declaration</h4>
  1388. <div class="language">
  1389. <p class="aside-title">Swift</p>
  1390. <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>
  1391. </div>
  1392. </div>
  1393. </section>
  1394. </div>
  1395. </li>
  1396. <li class="item">
  1397. <div>
  1398. <code>
  1399. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1400. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1401. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1402. </code>
  1403. </div>
  1404. <div class="height-container">
  1405. <div class="pointer-container"></div>
  1406. <section class="section">
  1407. <div class="pointer"></div>
  1408. <div class="abstract">
  1409. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1410. </div>
  1411. <div class="declaration">
  1412. <h4>Declaration</h4>
  1413. <div class="language">
  1414. <p class="aside-title">Swift</p>
  1415. <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>
  1416. </div>
  1417. </div>
  1418. </section>
  1419. </div>
  1420. </li>
  1421. <li class="item">
  1422. <div>
  1423. <code>
  1424. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1425. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1426. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1427. </code>
  1428. </div>
  1429. <div class="height-container">
  1430. <div class="pointer-container"></div>
  1431. <section class="section">
  1432. <div class="pointer"></div>
  1433. <div class="abstract">
  1434. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1435. </div>
  1436. <div class="declaration">
  1437. <h4>Declaration</h4>
  1438. <div class="language">
  1439. <p class="aside-title">Swift</p>
  1440. <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>
  1441. </div>
  1442. </div>
  1443. </section>
  1444. </div>
  1445. </li>
  1446. <li class="item">
  1447. <div>
  1448. <code>
  1449. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1450. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1451. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1452. </code>
  1453. </div>
  1454. <div class="height-container">
  1455. <div class="pointer-container"></div>
  1456. <section class="section">
  1457. <div class="pointer"></div>
  1458. <div class="abstract">
  1459. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1460. </div>
  1461. <div class="declaration">
  1462. <h4>Declaration</h4>
  1463. <div class="language">
  1464. <p class="aside-title">Swift</p>
  1465. <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>
  1466. </div>
  1467. </div>
  1468. </section>
  1469. </div>
  1470. </li>
  1471. </ul>
  1472. </div>
  1473. <div class="task-group">
  1474. <div class="task-name-container">
  1475. <a name="/Retry%20Count"></a>
  1476. <a name="//apple_ref/swift/Section/Retry Count" class="dashAnchor"></a>
  1477. <div class="section-name-container">
  1478. <a class="section-name-link" href="#/Retry%20Count"></a>
  1479. <h3 class="section-name"><p>Retry Count</p>
  1480. </h3>
  1481. </div>
  1482. </div>
  1483. <ul class="item-container">
  1484. <li class="item">
  1485. <div>
  1486. <code>
  1487. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1488. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1489. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1490. </code>
  1491. </div>
  1492. <div class="height-container">
  1493. <div class="pointer-container"></div>
  1494. <section class="section">
  1495. <div class="pointer"></div>
  1496. <div class="abstract">
  1497. <p>Number of times the <code>Request</code> has been retried.</p>
  1498. </div>
  1499. <div class="declaration">
  1500. <h4>Declaration</h4>
  1501. <div class="language">
  1502. <p class="aside-title">Swift</p>
  1503. <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>
  1504. </div>
  1505. </div>
  1506. </section>
  1507. </div>
  1508. </li>
  1509. </ul>
  1510. </div>
  1511. <div class="task-group">
  1512. <div class="task-name-container">
  1513. <a name="/Error"></a>
  1514. <a name="//apple_ref/swift/Section/Error" class="dashAnchor"></a>
  1515. <div class="section-name-container">
  1516. <a class="section-name-link" href="#/Error"></a>
  1517. <h3 class="section-name"><p>Error</p>
  1518. </h3>
  1519. </div>
  1520. </div>
  1521. <ul class="item-container">
  1522. <li class="item">
  1523. <div>
  1524. <code>
  1525. <a name="/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp"></a>
  1526. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1527. <a class="token" href="#/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp">error</a>
  1528. </code>
  1529. </div>
  1530. <div class="height-container">
  1531. <div class="pointer-container"></div>
  1532. <section class="section">
  1533. <div class="pointer"></div>
  1534. <div class="abstract">
  1535. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1536. </div>
  1537. <div class="declaration">
  1538. <h4>Declaration</h4>
  1539. <div class="language">
  1540. <p class="aside-title">Swift</p>
  1541. <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>
  1542. </div>
  1543. </div>
  1544. </section>
  1545. </div>
  1546. </li>
  1547. </ul>
  1548. </div>
  1549. <div class="task-group">
  1550. <div class="task-name-container">
  1551. <a name="/State"></a>
  1552. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1553. <div class="section-name-container">
  1554. <a class="section-name-link" href="#/State"></a>
  1555. <h3 class="section-name"><p>State</p>
  1556. </h3>
  1557. </div>
  1558. </div>
  1559. <ul class="item-container">
  1560. <li class="item">
  1561. <div>
  1562. <code>
  1563. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1564. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1565. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1566. </code>
  1567. </div>
  1568. <div class="height-container">
  1569. <div class="pointer-container"></div>
  1570. <section class="section">
  1571. <div class="pointer"></div>
  1572. <div class="abstract">
  1573. <p>Cancels the instance. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1574. </div>
  1575. <div class="declaration">
  1576. <h4>Declaration</h4>
  1577. <div class="language">
  1578. <p class="aside-title">Swift</p>
  1579. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1580. <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>
  1581. </div>
  1582. </div>
  1583. <div>
  1584. <h4>Return Value</h4>
  1585. <p>The instance.</p>
  1586. </div>
  1587. </section>
  1588. </div>
  1589. </li>
  1590. <li class="item">
  1591. <div>
  1592. <code>
  1593. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1594. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1595. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1596. </code>
  1597. </div>
  1598. <div class="height-container">
  1599. <div class="pointer-container"></div>
  1600. <section class="section">
  1601. <div class="pointer"></div>
  1602. <div class="abstract">
  1603. <p>Suspends the instance.</p>
  1604. </div>
  1605. <div class="declaration">
  1606. <h4>Declaration</h4>
  1607. <div class="language">
  1608. <p class="aside-title">Swift</p>
  1609. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1610. <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>
  1611. </div>
  1612. </div>
  1613. <div>
  1614. <h4>Return Value</h4>
  1615. <p>The instance.</p>
  1616. </div>
  1617. </section>
  1618. </div>
  1619. </li>
  1620. <li class="item">
  1621. <div>
  1622. <code>
  1623. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1624. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1625. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1626. </code>
  1627. </div>
  1628. <div class="height-container">
  1629. <div class="pointer-container"></div>
  1630. <section class="section">
  1631. <div class="pointer"></div>
  1632. <div class="abstract">
  1633. <p>Resumes the instance.</p>
  1634. </div>
  1635. <div class="declaration">
  1636. <h4>Declaration</h4>
  1637. <div class="language">
  1638. <p class="aside-title">Swift</p>
  1639. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1640. <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>
  1641. </div>
  1642. </div>
  1643. <div>
  1644. <h4>Return Value</h4>
  1645. <p>The instance.</p>
  1646. </div>
  1647. </section>
  1648. </div>
  1649. </li>
  1650. </ul>
  1651. </div>
  1652. <div class="task-group">
  1653. <div class="task-name-container">
  1654. <a name="/Closure%20API"></a>
  1655. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1656. <div class="section-name-container">
  1657. <a class="section-name-link" href="#/Closure%20API"></a>
  1658. <h3 class="section-name"><p>Closure API</p>
  1659. </h3>
  1660. </div>
  1661. </div>
  1662. <ul class="item-container">
  1663. <li class="item">
  1664. <div>
  1665. <code>
  1666. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1667. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1668. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:<wbr>password:<wbr>persistence:<wbr>)</a>
  1669. </code>
  1670. </div>
  1671. <div class="height-container">
  1672. <div class="pointer-container"></div>
  1673. <section class="section">
  1674. <div class="pointer"></div>
  1675. <div class="abstract">
  1676. <p>Associates a credential using the provided values with the instance.</p>
  1677. </div>
  1678. <div class="declaration">
  1679. <h4>Declaration</h4>
  1680. <div class="language">
  1681. <p class="aside-title">Swift</p>
  1682. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1683. <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>
  1684. </div>
  1685. </div>
  1686. <div>
  1687. <h4>Parameters</h4>
  1688. <table class="graybox">
  1689. <tbody>
  1690. <tr>
  1691. <td>
  1692. <code>
  1693. <em>username</em>
  1694. </code>
  1695. </td>
  1696. <td>
  1697. <div>
  1698. <p>The username.</p>
  1699. </div>
  1700. </td>
  1701. </tr>
  1702. <tr>
  1703. <td>
  1704. <code>
  1705. <em>password</em>
  1706. </code>
  1707. </td>
  1708. <td>
  1709. <div>
  1710. <p>The password.</p>
  1711. </div>
  1712. </td>
  1713. </tr>
  1714. <tr>
  1715. <td>
  1716. <code>
  1717. <em>persistence</em>
  1718. </code>
  1719. </td>
  1720. <td>
  1721. <div>
  1722. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>. <code>.forSession</code> by default.</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:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1740. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1741. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:<wbr>)</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>Associates the provided credential with the instance.</p>
  1750. </div>
  1751. <div class="declaration">
  1752. <h4>Declaration</h4>
  1753. <div class="language">
  1754. <p class="aside-title">Swift</p>
  1755. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1756. <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>
  1757. </div>
  1758. </div>
  1759. <div>
  1760. <h4>Parameters</h4>
  1761. <table class="graybox">
  1762. <tbody>
  1763. <tr>
  1764. <td>
  1765. <code>
  1766. <em>credential</em>
  1767. </code>
  1768. </td>
  1769. <td>
  1770. <div>
  1771. <p>The <code>URLCredential</code>.</p>
  1772. </div>
  1773. </td>
  1774. </tr>
  1775. </tbody>
  1776. </table>
  1777. </div>
  1778. <div>
  1779. <h4>Return Value</h4>
  1780. <p>The instance.</p>
  1781. </div>
  1782. </section>
  1783. </div>
  1784. </li>
  1785. <li class="item">
  1786. <div>
  1787. <code>
  1788. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1789. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1790. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:<wbr>closure:<wbr>)</a>
  1791. </code>
  1792. </div>
  1793. <div class="height-container">
  1794. <div class="pointer-container"></div>
  1795. <section class="section">
  1796. <div class="pointer"></div>
  1797. <div class="abstract">
  1798. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is read from the server.</p>
  1799. <div class="aside aside-note">
  1800. <p class="aside-title">Note</p>
  1801. <p>Only the last closure provided is used.</p>
  1802. </div>
  1803. </div>
  1804. <div class="declaration">
  1805. <h4>Declaration</h4>
  1806. <div class="language">
  1807. <p class="aside-title">Swift</p>
  1808. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1809. <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>
  1810. </div>
  1811. </div>
  1812. <div>
  1813. <h4>Parameters</h4>
  1814. <table class="graybox">
  1815. <tbody>
  1816. <tr>
  1817. <td>
  1818. <code>
  1819. <em>queue</em>
  1820. </code>
  1821. </td>
  1822. <td>
  1823. <div>
  1824. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1825. </div>
  1826. </td>
  1827. </tr>
  1828. <tr>
  1829. <td>
  1830. <code>
  1831. <em>closure</em>
  1832. </code>
  1833. </td>
  1834. <td>
  1835. <div>
  1836. <p>The closure to be executed periodically as data is read from the server.</p>
  1837. </div>
  1838. </td>
  1839. </tr>
  1840. </tbody>
  1841. </table>
  1842. </div>
  1843. <div>
  1844. <h4>Return Value</h4>
  1845. <p>The instance.</p>
  1846. </div>
  1847. </section>
  1848. </div>
  1849. </li>
  1850. <li class="item">
  1851. <div>
  1852. <code>
  1853. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1854. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1855. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:<wbr>closure:<wbr>)</a>
  1856. </code>
  1857. </div>
  1858. <div class="height-container">
  1859. <div class="pointer-container"></div>
  1860. <section class="section">
  1861. <div class="pointer"></div>
  1862. <div class="abstract">
  1863. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is sent to the server.</p>
  1864. <div class="aside aside-note">
  1865. <p class="aside-title">Note</p>
  1866. <p>Only the last closure provided is used.</p>
  1867. </div>
  1868. </div>
  1869. <div class="declaration">
  1870. <h4>Declaration</h4>
  1871. <div class="language">
  1872. <p class="aside-title">Swift</p>
  1873. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1874. <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>
  1875. </div>
  1876. </div>
  1877. <div>
  1878. <h4>Parameters</h4>
  1879. <table class="graybox">
  1880. <tbody>
  1881. <tr>
  1882. <td>
  1883. <code>
  1884. <em>queue</em>
  1885. </code>
  1886. </td>
  1887. <td>
  1888. <div>
  1889. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1890. </div>
  1891. </td>
  1892. </tr>
  1893. <tr>
  1894. <td>
  1895. <code>
  1896. <em>closure</em>
  1897. </code>
  1898. </td>
  1899. <td>
  1900. <div>
  1901. <p>The closure to be executed periodically as data is sent to the server.</p>
  1902. </div>
  1903. </td>
  1904. </tr>
  1905. </tbody>
  1906. </table>
  1907. </div>
  1908. <div>
  1909. <h4>Return Value</h4>
  1910. <p>The instance.</p>
  1911. </div>
  1912. </section>
  1913. </div>
  1914. </li>
  1915. </ul>
  1916. </div>
  1917. <div class="task-group">
  1918. <div class="task-name-container">
  1919. <a name="/Redirects"></a>
  1920. <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
  1921. <div class="section-name-container">
  1922. <a class="section-name-link" href="#/Redirects"></a>
  1923. <h3 class="section-name"><p>Redirects</p>
  1924. </h3>
  1925. </div>
  1926. </div>
  1927. <ul class="item-container">
  1928. <li class="item">
  1929. <div>
  1930. <code>
  1931. <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
  1932. <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
  1933. <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:<wbr>)</a>
  1934. </code>
  1935. </div>
  1936. <div class="height-container">
  1937. <div class="pointer-container"></div>
  1938. <section class="section">
  1939. <div class="pointer"></div>
  1940. <div class="abstract">
  1941. <p>Sets the redirect handler for the instance which will be used if a redirect response is encountered.</p>
  1942. <div class="aside aside-note">
  1943. <p class="aside-title">Note</p>
  1944. <p>Attempting to set the redirect handler more than once is a logic error and will crash.</p>
  1945. </div>
  1946. </div>
  1947. <div class="declaration">
  1948. <h4>Declaration</h4>
  1949. <div class="language">
  1950. <p class="aside-title">Swift</p>
  1951. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1952. <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>
  1953. </div>
  1954. </div>
  1955. <div>
  1956. <h4>Parameters</h4>
  1957. <table class="graybox">
  1958. <tbody>
  1959. <tr>
  1960. <td>
  1961. <code>
  1962. <em>handler</em>
  1963. </code>
  1964. </td>
  1965. <td>
  1966. <div>
  1967. <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
  1968. </div>
  1969. </td>
  1970. </tr>
  1971. </tbody>
  1972. </table>
  1973. </div>
  1974. <div>
  1975. <h4>Return Value</h4>
  1976. <p>The instance.</p>
  1977. </div>
  1978. </section>
  1979. </div>
  1980. </li>
  1981. </ul>
  1982. </div>
  1983. <div class="task-group">
  1984. <div class="task-name-container">
  1985. <a name="/Cached%20Responses"></a>
  1986. <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
  1987. <div class="section-name-container">
  1988. <a class="section-name-link" href="#/Cached%20Responses"></a>
  1989. <h3 class="section-name"><p>Cached Responses</p>
  1990. </h3>
  1991. </div>
  1992. </div>
  1993. <ul class="item-container">
  1994. <li class="item">
  1995. <div>
  1996. <code>
  1997. <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
  1998. <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
  1999. <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:<wbr>)</a>
  2000. </code>
  2001. </div>
  2002. <div class="height-container">
  2003. <div class="pointer-container"></div>
  2004. <section class="section">
  2005. <div class="pointer"></div>
  2006. <div class="abstract">
  2007. <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
  2008. <div class="aside aside-note">
  2009. <p class="aside-title">Note</p>
  2010. <p>Attempting to set the cache handler more than once is a logic error and will crash.</p>
  2011. </div>
  2012. </div>
  2013. <div class="declaration">
  2014. <h4>Declaration</h4>
  2015. <div class="language">
  2016. <p class="aside-title">Swift</p>
  2017. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2018. <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>
  2019. </div>
  2020. </div>
  2021. <div>
  2022. <h4>Parameters</h4>
  2023. <table class="graybox">
  2024. <tbody>
  2025. <tr>
  2026. <td>
  2027. <code>
  2028. <em>handler</em>
  2029. </code>
  2030. </td>
  2031. <td>
  2032. <div>
  2033. <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
  2034. </div>
  2035. </td>
  2036. </tr>
  2037. </tbody>
  2038. </table>
  2039. </div>
  2040. <div>
  2041. <h4>Return Value</h4>
  2042. <p>The instance.</p>
  2043. </div>
  2044. </section>
  2045. </div>
  2046. </li>
  2047. </ul>
  2048. </div>
  2049. <div class="task-group">
  2050. <div class="task-name-container">
  2051. <a name="/Lifetime%20APIs"></a>
  2052. <a name="//apple_ref/swift/Section/Lifetime APIs" class="dashAnchor"></a>
  2053. <div class="section-name-container">
  2054. <a class="section-name-link" href="#/Lifetime%20APIs"></a>
  2055. <h3 class="section-name"><p>Lifetime APIs</p>
  2056. </h3>
  2057. </div>
  2058. </div>
  2059. <ul class="item-container">
  2060. <li class="item">
  2061. <div>
  2062. <code>
  2063. <a name="/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF"></a>
  2064. <a name="//apple_ref/swift/Method/cURLDescription(on:calling:)" class="dashAnchor"></a>
  2065. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF">cURLDescription(on:<wbr>calling:<wbr>)</a>
  2066. </code>
  2067. </div>
  2068. <div class="height-container">
  2069. <div class="pointer-container"></div>
  2070. <section class="section">
  2071. <div class="pointer"></div>
  2072. <div class="abstract">
  2073. <p>Sets a handler to be called when the cURL description of the request is available.</p>
  2074. <div class="aside aside-note">
  2075. <p class="aside-title">Note</p>
  2076. <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>
  2077. </div>
  2078. </div>
  2079. <div class="declaration">
  2080. <h4>Declaration</h4>
  2081. <div class="language">
  2082. <p class="aside-title">Swift</p>
  2083. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2084. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</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>
  2085. </div>
  2086. </div>
  2087. <div>
  2088. <h4>Parameters</h4>
  2089. <table class="graybox">
  2090. <tbody>
  2091. <tr>
  2092. <td>
  2093. <code>
  2094. <em>queue</em>
  2095. </code>
  2096. </td>
  2097. <td>
  2098. <div>
  2099. <p><code>DispatchQueue</code> on which <code>handler</code> will be called.</p>
  2100. </div>
  2101. </td>
  2102. </tr>
  2103. <tr>
  2104. <td>
  2105. <code>
  2106. <em>handler</em>
  2107. </code>
  2108. </td>
  2109. <td>
  2110. <div>
  2111. <p>Closure to be called when the cURL description is available.</p>
  2112. </div>
  2113. </td>
  2114. </tr>
  2115. </tbody>
  2116. </table>
  2117. </div>
  2118. <div>
  2119. <h4>Return Value</h4>
  2120. <p>The instance.</p>
  2121. </div>
  2122. </section>
  2123. </div>
  2124. </li>
  2125. <li class="item">
  2126. <div>
  2127. <code>
  2128. <a name="/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF"></a>
  2129. <a name="//apple_ref/swift/Method/cURLDescription(calling:)" class="dashAnchor"></a>
  2130. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF">cURLDescription(calling:<wbr>)</a>
  2131. </code>
  2132. </div>
  2133. <div class="height-container">
  2134. <div class="pointer-container"></div>
  2135. <section class="section">
  2136. <div class="pointer"></div>
  2137. <div class="abstract">
  2138. <p>Sets a handler to be called when the cURL description of the request is available.</p>
  2139. <div class="aside aside-note">
  2140. <p class="aside-title">Note</p>
  2141. <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>
  2142. </div>
  2143. </div>
  2144. <div class="declaration">
  2145. <h4>Declaration</h4>
  2146. <div class="language">
  2147. <p class="aside-title">Swift</p>
  2148. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2149. <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>
  2150. </div>
  2151. </div>
  2152. <div>
  2153. <h4>Parameters</h4>
  2154. <table class="graybox">
  2155. <tbody>
  2156. <tr>
  2157. <td>
  2158. <code>
  2159. <em>handler</em>
  2160. </code>
  2161. </td>
  2162. <td>
  2163. <div>
  2164. <p>Closure to be called when the cURL description is available. Called on the instance&rsquo;s
  2165. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> by default.</p>
  2166. </div>
  2167. </td>
  2168. </tr>
  2169. </tbody>
  2170. </table>
  2171. </div>
  2172. <div>
  2173. <h4>Return Value</h4>
  2174. <p>The instance.</p>
  2175. </div>
  2176. </section>
  2177. </div>
  2178. </li>
  2179. <li class="item">
  2180. <div>
  2181. <code>
  2182. <a name="/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF"></a>
  2183. <a name="//apple_ref/swift/Method/onURLRequestCreation(on:perform:)" class="dashAnchor"></a>
  2184. <a class="token" href="#/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF">onURLRequestCreation(on:<wbr>perform:<wbr>)</a>
  2185. </code>
  2186. </div>
  2187. <div class="height-container">
  2188. <div class="pointer-container"></div>
  2189. <section class="section">
  2190. <div class="pointer"></div>
  2191. <div class="abstract">
  2192. <p>Sets a closure to called whenever Alamofire creates a <code>URLRequest</code> for this instance.</p>
  2193. <div class="aside aside-note">
  2194. <p class="aside-title">Note</p>
  2195. <p>This closure will be called multiple times if the instance adapts incoming <code>URLRequest</code>s or is retried.</p>
  2196. </div>
  2197. </div>
  2198. <div class="declaration">
  2199. <h4>Declaration</h4>
  2200. <div class="language">
  2201. <p class="aside-title">Swift</p>
  2202. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2203. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLRequestCreation</span><span class="p">(</span><span class="n">on</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="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">URLRequest</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>
  2204. </div>
  2205. </div>
  2206. <div>
  2207. <h4>Parameters</h4>
  2208. <table class="graybox">
  2209. <tbody>
  2210. <tr>
  2211. <td>
  2212. <code>
  2213. <em>queue</em>
  2214. </code>
  2215. </td>
  2216. <td>
  2217. <div>
  2218. <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
  2219. </div>
  2220. </td>
  2221. </tr>
  2222. <tr>
  2223. <td>
  2224. <code>
  2225. <em>handler</em>
  2226. </code>
  2227. </td>
  2228. <td>
  2229. <div>
  2230. <p>Closure to be called when a <code>URLRequest</code> is available.</p>
  2231. </div>
  2232. </td>
  2233. </tr>
  2234. </tbody>
  2235. </table>
  2236. </div>
  2237. <div>
  2238. <h4>Return Value</h4>
  2239. <p>The instance.</p>
  2240. </div>
  2241. </section>
  2242. </div>
  2243. </li>
  2244. <li class="item">
  2245. <div>
  2246. <code>
  2247. <a name="/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF"></a>
  2248. <a name="//apple_ref/swift/Method/onURLSessionTaskCreation(on:perform:)" class="dashAnchor"></a>
  2249. <a class="token" href="#/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF">onURLSessionTaskCreation(on:<wbr>perform:<wbr>)</a>
  2250. </code>
  2251. </div>
  2252. <div class="height-container">
  2253. <div class="pointer-container"></div>
  2254. <section class="section">
  2255. <div class="pointer"></div>
  2256. <div class="abstract">
  2257. <p>Sets a closure to be called whenever the instance creates a <code>URLSessionTask</code>.</p>
  2258. <div class="aside aside-note">
  2259. <p class="aside-title">Note</p>
  2260. <p>This API should only be used to provide <code>URLSessionTask</code>s to existing API, like <code>NSFileProvider</code>. It
  2261. <strong>SHOULD NOT</strong> be used to interact with tasks directly, as that may be break Alamofire features.
  2262. Additionally, this closure may be called multiple times if the instance is retried.</p>
  2263. </div>
  2264. </div>
  2265. <div class="declaration">
  2266. <h4>Declaration</h4>
  2267. <div class="language">
  2268. <p class="aside-title">Swift</p>
  2269. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2270. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLSessionTaskCreation</span><span class="p">(</span><span class="n">on</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="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">URLSessionTask</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>
  2271. </div>
  2272. </div>
  2273. <div>
  2274. <h4>Parameters</h4>
  2275. <table class="graybox">
  2276. <tbody>
  2277. <tr>
  2278. <td>
  2279. <code>
  2280. <em>queue</em>
  2281. </code>
  2282. </td>
  2283. <td>
  2284. <div>
  2285. <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
  2286. </div>
  2287. </td>
  2288. </tr>
  2289. <tr>
  2290. <td>
  2291. <code>
  2292. <em>handler</em>
  2293. </code>
  2294. </td>
  2295. <td>
  2296. <div>
  2297. <p>Closure to be called when the <code>URLSessionTask</code> is available.</p>
  2298. </div>
  2299. </td>
  2300. </tr>
  2301. </tbody>
  2302. </table>
  2303. </div>
  2304. <div>
  2305. <h4>Return Value</h4>
  2306. <p>The instance.</p>
  2307. </div>
  2308. </section>
  2309. </div>
  2310. </li>
  2311. <li class="item">
  2312. <div>
  2313. <code>
  2314. <a name="/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ"></a>
  2315. <a name="//apple_ref/swift/Variable/didResumeNotification" class="dashAnchor"></a>
  2316. <a class="token" href="#/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ">didResumeNotification</a>
  2317. </code>
  2318. </div>
  2319. <div class="height-container">
  2320. <div class="pointer-container"></div>
  2321. <section class="section">
  2322. <div class="pointer"></div>
  2323. <div class="abstract">
  2324. <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  2325. </div>
  2326. <div class="declaration">
  2327. <h4>Declaration</h4>
  2328. <div class="language">
  2329. <p class="aside-title">Swift</p>
  2330. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2331. </div>
  2332. </div>
  2333. </section>
  2334. </div>
  2335. </li>
  2336. <li class="item">
  2337. <div>
  2338. <code>
  2339. <a name="/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ"></a>
  2340. <a name="//apple_ref/swift/Variable/didSuspendNotification" class="dashAnchor"></a>
  2341. <a class="token" href="#/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ">didSuspendNotification</a>
  2342. </code>
  2343. </div>
  2344. <div class="height-container">
  2345. <div class="pointer-container"></div>
  2346. <section class="section">
  2347. <div class="pointer"></div>
  2348. <div class="abstract">
  2349. <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  2350. </div>
  2351. <div class="declaration">
  2352. <h4>Declaration</h4>
  2353. <div class="language">
  2354. <p class="aside-title">Swift</p>
  2355. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2356. </div>
  2357. </div>
  2358. </section>
  2359. </div>
  2360. </li>
  2361. <li class="item">
  2362. <div>
  2363. <code>
  2364. <a name="/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ"></a>
  2365. <a name="//apple_ref/swift/Variable/didCancelNotification" class="dashAnchor"></a>
  2366. <a class="token" href="#/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ">didCancelNotification</a>
  2367. </code>
  2368. </div>
  2369. <div class="height-container">
  2370. <div class="pointer-container"></div>
  2371. <section class="section">
  2372. <div class="pointer"></div>
  2373. <div class="abstract">
  2374. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  2375. </div>
  2376. <div class="declaration">
  2377. <h4>Declaration</h4>
  2378. <div class="language">
  2379. <p class="aside-title">Swift</p>
  2380. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2381. </div>
  2382. </div>
  2383. </section>
  2384. </div>
  2385. </li>
  2386. <li class="item">
  2387. <div>
  2388. <code>
  2389. <a name="/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ"></a>
  2390. <a name="//apple_ref/swift/Variable/didFinishNotification" class="dashAnchor"></a>
  2391. <a class="token" href="#/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ">didFinishNotification</a>
  2392. </code>
  2393. </div>
  2394. <div class="height-container">
  2395. <div class="pointer-container"></div>
  2396. <section class="section">
  2397. <div class="pointer"></div>
  2398. <div class="abstract">
  2399. <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  2400. </div>
  2401. <div class="declaration">
  2402. <h4>Declaration</h4>
  2403. <div class="language">
  2404. <p class="aside-title">Swift</p>
  2405. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2406. </div>
  2407. </div>
  2408. </section>
  2409. </div>
  2410. </li>
  2411. <li class="item">
  2412. <div>
  2413. <code>
  2414. <a name="/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ"></a>
  2415. <a name="//apple_ref/swift/Variable/didResumeTaskNotification" class="dashAnchor"></a>
  2416. <a class="token" href="#/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ">didResumeTaskNotification</a>
  2417. </code>
  2418. </div>
  2419. <div class="height-container">
  2420. <div class="pointer-container"></div>
  2421. <section class="section">
  2422. <div class="pointer"></div>
  2423. <div class="abstract">
  2424. <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>
  2425. </div>
  2426. <div class="declaration">
  2427. <h4>Declaration</h4>
  2428. <div class="language">
  2429. <p class="aside-title">Swift</p>
  2430. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2431. </div>
  2432. </div>
  2433. </section>
  2434. </div>
  2435. </li>
  2436. <li class="item">
  2437. <div>
  2438. <code>
  2439. <a name="/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ"></a>
  2440. <a name="//apple_ref/swift/Variable/didSuspendTaskNotification" class="dashAnchor"></a>
  2441. <a class="token" href="#/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ">didSuspendTaskNotification</a>
  2442. </code>
  2443. </div>
  2444. <div class="height-container">
  2445. <div class="pointer-container"></div>
  2446. <section class="section">
  2447. <div class="pointer"></div>
  2448. <div class="abstract">
  2449. <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>
  2450. </div>
  2451. <div class="declaration">
  2452. <h4>Declaration</h4>
  2453. <div class="language">
  2454. <p class="aside-title">Swift</p>
  2455. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2456. </div>
  2457. </div>
  2458. </section>
  2459. </div>
  2460. </li>
  2461. <li class="item">
  2462. <div>
  2463. <code>
  2464. <a name="/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ"></a>
  2465. <a name="//apple_ref/swift/Variable/didCancelTaskNotification" class="dashAnchor"></a>
  2466. <a class="token" href="#/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ">didCancelTaskNotification</a>
  2467. </code>
  2468. </div>
  2469. <div class="height-container">
  2470. <div class="pointer-container"></div>
  2471. <section class="section">
  2472. <div class="pointer"></div>
  2473. <div class="abstract">
  2474. <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>
  2475. </div>
  2476. <div class="declaration">
  2477. <h4>Declaration</h4>
  2478. <div class="language">
  2479. <p class="aside-title">Swift</p>
  2480. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2481. </div>
  2482. </div>
  2483. </section>
  2484. </div>
  2485. </li>
  2486. <li class="item">
  2487. <div>
  2488. <code>
  2489. <a name="/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ"></a>
  2490. <a name="//apple_ref/swift/Variable/didCompleteTaskNotification" class="dashAnchor"></a>
  2491. <a class="token" href="#/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ">didCompleteTaskNotification</a>
  2492. </code>
  2493. </div>
  2494. <div class="height-container">
  2495. <div class="pointer-container"></div>
  2496. <section class="section">
  2497. <div class="pointer"></div>
  2498. <div class="abstract">
  2499. <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>
  2500. </div>
  2501. <div class="declaration">
  2502. <h4>Declaration</h4>
  2503. <div class="language">
  2504. <p class="aside-title">Swift</p>
  2505. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2506. </div>
  2507. </div>
  2508. </section>
  2509. </div>
  2510. </li>
  2511. </ul>
  2512. </div>
  2513. <div class="task-group">
  2514. <div class="task-name-container">
  2515. <a name="/Protocol%20Conformances"></a>
  2516. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2517. <div class="section-name-container">
  2518. <a class="section-name-link" href="#/Protocol%20Conformances"></a>
  2519. <h3 class="section-name"><p>Protocol Conformances</p>
  2520. </h3>
  2521. </div>
  2522. </div>
  2523. <ul class="item-container">
  2524. <li class="item">
  2525. <div>
  2526. <code>
  2527. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  2528. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  2529. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:<wbr>_:<wbr>)</a>
  2530. </code>
  2531. </div>
  2532. <div class="height-container">
  2533. <div class="pointer-container"></div>
  2534. <section class="section">
  2535. <div class="pointer"></div>
  2536. <div class="abstract">
  2537. </div>
  2538. <div class="declaration">
  2539. <h4>Declaration</h4>
  2540. <div class="language">
  2541. <p class="aside-title">Swift</p>
  2542. <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>
  2543. </div>
  2544. </div>
  2545. </section>
  2546. </div>
  2547. </li>
  2548. <li class="item">
  2549. <div>
  2550. <code>
  2551. <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
  2552. <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
  2553. <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:<wbr>)</a>
  2554. </code>
  2555. </div>
  2556. <div class="height-container">
  2557. <div class="pointer-container"></div>
  2558. <section class="section">
  2559. <div class="pointer"></div>
  2560. <div class="abstract">
  2561. </div>
  2562. <div class="declaration">
  2563. <h4>Declaration</h4>
  2564. <div class="language">
  2565. <p class="aside-title">Swift</p>
  2566. <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>
  2567. </div>
  2568. </div>
  2569. </section>
  2570. </div>
  2571. </li>
  2572. <li class="item">
  2573. <div>
  2574. <code>
  2575. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  2576. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  2577. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  2578. </code>
  2579. </div>
  2580. <div class="height-container">
  2581. <div class="pointer-container"></div>
  2582. <section class="section">
  2583. <div class="pointer"></div>
  2584. <div class="abstract">
  2585. <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
  2586. created, as well as the response status code, if a response has been received.</p>
  2587. </div>
  2588. <div class="declaration">
  2589. <h4>Declaration</h4>
  2590. <div class="language">
  2591. <p class="aside-title">Swift</p>
  2592. <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>
  2593. </div>
  2594. </div>
  2595. </section>
  2596. </div>
  2597. </li>
  2598. <li class="item">
  2599. <div>
  2600. <code>
  2601. <a name="/s:9Alamofire7RequestC15cURLDescriptionSSyF"></a>
  2602. <a name="//apple_ref/swift/Method/cURLDescription()" class="dashAnchor"></a>
  2603. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescriptionSSyF">cURLDescription()</a>
  2604. </code>
  2605. </div>
  2606. <div class="height-container">
  2607. <div class="pointer-container"></div>
  2608. <section class="section">
  2609. <div class="pointer"></div>
  2610. <div class="abstract">
  2611. <p>cURL representation of the instance.</p>
  2612. </div>
  2613. <div class="declaration">
  2614. <h4>Declaration</h4>
  2615. <div class="language">
  2616. <p class="aside-title">Swift</p>
  2617. <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>
  2618. </div>
  2619. </div>
  2620. <div>
  2621. <h4>Return Value</h4>
  2622. <p>The cURL equivalent of the instance.</p>
  2623. </div>
  2624. </section>
  2625. </div>
  2626. </li>
  2627. </ul>
  2628. </div>
  2629. <div class="task-group">
  2630. <div class="task-name-container">
  2631. <a name="/Helper%20Types"></a>
  2632. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  2633. <div class="section-name-container">
  2634. <a class="section-name-link" href="#/Helper%20Types"></a>
  2635. <h3 class="section-name"><p>Helper Types</p>
  2636. </h3>
  2637. </div>
  2638. </div>
  2639. <ul class="item-container">
  2640. <li class="item">
  2641. <div>
  2642. <code>
  2643. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  2644. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  2645. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  2646. </code>
  2647. </div>
  2648. <div class="height-container">
  2649. <div class="pointer-container"></div>
  2650. <section class="section">
  2651. <div class="pointer"></div>
  2652. <div class="abstract">
  2653. <p>Used to represent whether a validation succeeded or failed.</p>
  2654. </div>
  2655. <div class="declaration">
  2656. <h4>Declaration</h4>
  2657. <div class="language">
  2658. <p class="aside-title">Swift</p>
  2659. <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>
  2660. </div>
  2661. </div>
  2662. </section>
  2663. </div>
  2664. </li>
  2665. </ul>
  2666. </div>
  2667. </div>
  2668. </section>
  2669. </article>
  2670. </div>
  2671. <section class="footer">
  2672. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-10-17)</p>
  2673. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  2674. </section>
  2675. </body>
  2676. </div>
  2677. </html>