Request.html 134 KB

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