Request.html 133 KB

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