Request.html 132 KB

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