RequestInterceptor.html 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>RequestInterceptor Protocol 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/Protocol/RequestInterceptor" class="dashAnchor"></a>
  16. <a title="RequestInterceptor Protocol Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.7.1 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  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" alt=""/>
  45. RequestInterceptor Protocol Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  211. </li>
  212. </ul>
  213. </li>
  214. <li class="nav-group-name">
  215. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  216. <ul class="nav-group-tasks">
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  257. </li>
  258. </ul>
  259. </li>
  260. <li class="nav-group-name">
  261. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  262. <ul class="nav-group-tasks">
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  316. </li>
  317. </ul>
  318. </li>
  319. <li class="nav-group-name">
  320. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  321. <ul class="nav-group-tasks">
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  393. </li>
  394. </ul>
  395. </li>
  396. <li class="nav-group-name">
  397. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  398. <ul class="nav-group-tasks">
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  503. </li>
  504. </ul>
  505. </li>
  506. <li class="nav-group-name">
  507. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  508. <ul class="nav-group-tasks">
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  529. </li>
  530. </ul>
  531. </li>
  532. </ul>
  533. </nav>
  534. <article class="main-content">
  535. <section class="section">
  536. <div class="section-content top-matter">
  537. <h1>RequestInterceptor</h1>
  538. <div class="declaration">
  539. <div class="language">
  540. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestInterceptor</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></span></code></pre>
  541. </div>
  542. </div>
  543. <p>Type that provides both <code><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></code> and <code><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></code> functionality.</p>
  544. </div>
  545. </section>
  546. <section class="section">
  547. <div class="section-content">
  548. <div class="task-group">
  549. <ul class="item-container">
  550. <li class="item">
  551. <div>
  552. <code>
  553. <a name="/s:9Alamofire14RequestAdapterP5adapt_3for10completiony10Foundation10URLRequestV_AA7SessionCys6ResultOyAIs5Error_pGctF"></a>
  554. <a name="//apple_ref/swift/Method/adapt(_:for:completion:)" class="dashAnchor"></a>
  555. <a class="token" href="#/s:9Alamofire14RequestAdapterP5adapt_3for10completiony10Foundation10URLRequestV_AA7SessionCys6ResultOyAIs5Error_pGctF">adapt(_:<wbr>for:<wbr>completion:<wbr>)</a>
  556. </code>
  557. <span class="declaration-note">
  558. Extension method
  559. </span>
  560. </div>
  561. <div class="height-container">
  562. <div class="pointer-container"></div>
  563. <section class="section">
  564. <div class="pointer"></div>
  565. <div class="abstract">
  566. </div>
  567. <div class="declaration">
  568. <h4>Declaration</h4>
  569. <div class="language">
  570. <p class="aside-title">Swift</p>
  571. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">adapt</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">,</span> <span class="k">for</span> <span class="nv">session</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html">Session</a></span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Result</span><span class="o">&lt;</span><span class="kt">URLRequest</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  572. </div>
  573. </div>
  574. </section>
  575. </div>
  576. </li>
  577. <li class="item">
  578. <div>
  579. <code>
  580. <a name="/s:9Alamofire14RequestRetrierP5retry_3for5dueTo10completionyAA0B0C_AA7SessionCs5Error_pyAA11RetryResultOctF"></a>
  581. <a name="//apple_ref/swift/Method/retry(_:for:dueTo:completion:)" class="dashAnchor"></a>
  582. <a class="token" href="#/s:9Alamofire14RequestRetrierP5retry_3for5dueTo10completionyAA0B0C_AA7SessionCs5Error_pyAA11RetryResultOctF">retry(_:<wbr>for:<wbr>dueTo:<wbr>completion:<wbr>)</a>
  583. </code>
  584. <span class="declaration-note">
  585. Extension method
  586. </span>
  587. </div>
  588. <div class="height-container">
  589. <div class="pointer-container"></div>
  590. <section class="section">
  591. <div class="pointer"></div>
  592. <div class="abstract">
  593. </div>
  594. <div class="declaration">
  595. <h4>Declaration</h4>
  596. <div class="language">
  597. <p class="aside-title">Swift</p>
  598. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">retry</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">,</span>
  599. <span class="k">for</span> <span class="nv">session</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html">Session</a></span><span class="p">,</span>
  600. <span class="n">dueTo</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">,</span>
  601. <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Enums/RetryResult.html">RetryResult</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  602. </div>
  603. </div>
  604. </section>
  605. </div>
  606. </li>
  607. </ul>
  608. </div>
  609. <div class="task-group">
  610. <div class="task-name-container">
  611. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60DeflateRequestCompressor%60"></a>
  612. <a name="//apple_ref/swift/Section/Available where `Self` == `DeflateRequestCompressor`" class="dashAnchor"></a>
  613. <div class="section-name-container">
  614. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60DeflateRequestCompressor%60"></a>
  615. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></code></span>
  616. </h3>
  617. </div>
  618. </div>
  619. <ul class="item-container">
  620. <li class="item">
  621. <div>
  622. <code>
  623. <a name="/s:9Alamofire18RequestInterceptorPA2A07DeflateB10CompressorVRszrlE07deflateE0AEvpZ"></a>
  624. <a name="//apple_ref/swift/Variable/deflateCompressor" class="dashAnchor"></a>
  625. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A07DeflateB10CompressorVRszrlE07deflateE0AEvpZ">deflateCompressor</a>
  626. </code>
  627. <span class="declaration-note">
  628. Extension method
  629. </span>
  630. </div>
  631. <div class="height-container">
  632. <div class="pointer-container"></div>
  633. <section class="section">
  634. <div class="pointer"></div>
  635. <div class="abstract">
  636. <p>Create a <code><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></code> with default <code>duplicateHeaderBehavior</code> and <code>shouldCompressBodyData</code> values.</p>
  637. </div>
  638. <div class="declaration">
  639. <h4>Declaration</h4>
  640. <div class="language">
  641. <p class="aside-title">Swift</p>
  642. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">deflateCompressor</span><span class="p">:</span> <span class="kt"><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  643. </div>
  644. </div>
  645. </section>
  646. </div>
  647. </li>
  648. <li class="item">
  649. <div>
  650. <code>
  651. <a name="/s:9Alamofire18RequestInterceptorPA2A07DeflateB10CompressorVRszrlE07deflateE023duplicateHeaderBehavior22shouldCompressBodyDataA2E09DuplicatehI0O_Sb10Foundation0M0VctFZ"></a>
  652. <a name="//apple_ref/swift/Method/deflateCompressor(duplicateHeaderBehavior:shouldCompressBodyData:)" class="dashAnchor"></a>
  653. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A07DeflateB10CompressorVRszrlE07deflateE023duplicateHeaderBehavior22shouldCompressBodyDataA2E09DuplicatehI0O_Sb10Foundation0M0VctFZ">deflateCompressor(duplicateHeaderBehavior:<wbr>shouldCompressBodyData:<wbr>)</a>
  654. </code>
  655. <span class="declaration-note">
  656. Extension method
  657. </span>
  658. </div>
  659. <div class="height-container">
  660. <div class="pointer-container"></div>
  661. <section class="section">
  662. <div class="pointer"></div>
  663. <div class="abstract">
  664. <p>Creates a <code><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></code> with the provided <code>DuplicateHeaderBehavior</code> and <code>shouldCompressBodyData</code>
  665. closure.</p>
  666. </div>
  667. <div class="declaration">
  668. <h4>Declaration</h4>
  669. <div class="language">
  670. <p class="aside-title">Swift</p>
  671. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">deflateCompressor</span><span class="p">(</span>
  672. <span class="nv">duplicateHeaderBehavior</span><span class="p">:</span> <span class="kt"><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></span><span class="o">.</span><span class="kt">DuplicateHeaderBehavior</span> <span class="o">=</span> <span class="o">.</span><span class="n">error</span><span class="p">,</span>
  673. <span class="nv">shouldCompressBodyData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">bodyData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="p">{</span> <span class="n">_</span> <span class="k">in</span> <span class="kc">true</span> <span class="p">}</span>
  674. <span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></span></code></pre>
  675. </div>
  676. </div>
  677. <div>
  678. <h4>Parameters</h4>
  679. <table class="graybox">
  680. <tbody>
  681. <tr>
  682. <td>
  683. <code>
  684. <em>duplicateHeaderBehavior</em>
  685. </code>
  686. </td>
  687. <td>
  688. <div>
  689. <p><code>DuplicateHeaderBehavior</code> to use.</p>
  690. </div>
  691. </td>
  692. </tr>
  693. <tr>
  694. <td>
  695. <code>
  696. <em>shouldCompressBodyData</em>
  697. </code>
  698. </td>
  699. <td>
  700. <div>
  701. <p>Closure which determines whether the outgoing body data should be compressed. <code>true</code> by default.</p>
  702. </div>
  703. </td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. </div>
  708. <div>
  709. <h4>Return Value</h4>
  710. <p>The <code><a href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a></code>.</p>
  711. </div>
  712. </section>
  713. </div>
  714. </li>
  715. </ul>
  716. </div>
  717. <div class="task-group">
  718. <div class="task-name-container">
  719. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60Interceptor%60"></a>
  720. <a name="//apple_ref/swift/Section/Available where `Self` == `Interceptor`" class="dashAnchor"></a>
  721. <div class="section-name-container">
  722. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60Interceptor%60"></a>
  723. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Classes/Interceptor.html">Interceptor</a></code></span>
  724. </h3>
  725. </div>
  726. </div>
  727. <ul class="item-container">
  728. <li class="item">
  729. <div>
  730. <code>
  731. <a name="/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor7adapter7retrierAEy10Foundation10URLRequestV_AA7SessionCys6ResultOyAKs5Error_pGctc_yAA0B0C_AMsAP_pyAA05RetryJ0OctctFZ"></a>
  732. <a name="//apple_ref/swift/Method/interceptor(adapter:retrier:)" class="dashAnchor"></a>
  733. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor7adapter7retrierAEy10Foundation10URLRequestV_AA7SessionCys6ResultOyAKs5Error_pGctc_yAA0B0C_AMsAP_pyAA05RetryJ0OctctFZ">interceptor(adapter:<wbr>retrier:<wbr>)</a>
  734. </code>
  735. <span class="declaration-note">
  736. Extension method
  737. </span>
  738. </div>
  739. <div class="height-container">
  740. <div class="pointer-container"></div>
  741. <section class="section">
  742. <div class="pointer"></div>
  743. <div class="abstract">
  744. <p>Creates an <code><a href="../Classes/Interceptor.html">Interceptor</a></code> using the provided <code><a href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a></code> and <code><a href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a></code> closures.</p>
  745. </div>
  746. <div class="declaration">
  747. <h4>Declaration</h4>
  748. <div class="language">
  749. <p class="aside-title">Swift</p>
  750. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">interceptor</span><span class="p">(</span><span class="nv">adapter</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a></span><span class="p">,</span> <span class="nv">retrier</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/Interceptor.html">Interceptor</a></span></code></pre>
  751. </div>
  752. </div>
  753. <div>
  754. <h4>Parameters</h4>
  755. <table class="graybox">
  756. <tbody>
  757. <tr>
  758. <td>
  759. <code>
  760. <em>adapter</em>
  761. </code>
  762. </td>
  763. <td>
  764. <div>
  765. <p><code>AdapterHandler</code>to use to adapt the request.</p>
  766. </div>
  767. </td>
  768. </tr>
  769. <tr>
  770. <td>
  771. <code>
  772. <em>retrier</em>
  773. </code>
  774. </td>
  775. <td>
  776. <div>
  777. <p><code><a href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a></code> to use to retry the request.</p>
  778. </div>
  779. </td>
  780. </tr>
  781. </tbody>
  782. </table>
  783. </div>
  784. <div>
  785. <h4>Return Value</h4>
  786. <p>The <code><a href="../Classes/Interceptor.html">Interceptor</a></code>.</p>
  787. </div>
  788. </section>
  789. </div>
  790. </li>
  791. <li class="item">
  792. <div>
  793. <code>
  794. <a name="/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor7adapter7retrierAeA0B7Adapter_p_AA0B7Retrier_ptFZ"></a>
  795. <a name="//apple_ref/swift/Method/interceptor(adapter:retrier:)" class="dashAnchor"></a>
  796. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor7adapter7retrierAeA0B7Adapter_p_AA0B7Retrier_ptFZ">interceptor(adapter:<wbr>retrier:<wbr>)</a>
  797. </code>
  798. <span class="declaration-note">
  799. Extension method
  800. </span>
  801. </div>
  802. <div class="height-container">
  803. <div class="pointer-container"></div>
  804. <section class="section">
  805. <div class="pointer"></div>
  806. <div class="abstract">
  807. <p>Creates an <code><a href="../Classes/Interceptor.html">Interceptor</a></code> using the provided <code><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></code> and <code><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></code> instances.</p>
  808. </div>
  809. <div class="declaration">
  810. <h4>Declaration</h4>
  811. <div class="language">
  812. <p class="aside-title">Swift</p>
  813. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">interceptor</span><span class="p">(</span><span class="nv">adapter</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></span><span class="p">,</span> <span class="nv">retrier</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/Interceptor.html">Interceptor</a></span></code></pre>
  814. </div>
  815. </div>
  816. <div>
  817. <h4>Parameters</h4>
  818. <table class="graybox">
  819. <tbody>
  820. <tr>
  821. <td>
  822. <code>
  823. <em>adapter</em>
  824. </code>
  825. </td>
  826. <td>
  827. <div>
  828. <p><code><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></code> to use to adapt the request</p>
  829. </div>
  830. </td>
  831. </tr>
  832. <tr>
  833. <td>
  834. <code>
  835. <em>retrier</em>
  836. </code>
  837. </td>
  838. <td>
  839. <div>
  840. <p><code><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></code> to use to retry the request.</p>
  841. </div>
  842. </td>
  843. </tr>
  844. </tbody>
  845. </table>
  846. </div>
  847. <div>
  848. <h4>Return Value</h4>
  849. <p>The <code><a href="../Classes/Interceptor.html">Interceptor</a></code>.</p>
  850. </div>
  851. </section>
  852. </div>
  853. </li>
  854. <li class="item">
  855. <div>
  856. <code>
  857. <a name="/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor8adapters8retriers12interceptorsAESayAA0B7Adapter_pG_SayAA0B7Retrier_pGSayAaB_pGtFZ"></a>
  858. <a name="//apple_ref/swift/Method/interceptor(adapters:retriers:interceptors:)" class="dashAnchor"></a>
  859. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A0C0CRszrlE11interceptor8adapters8retriers12interceptorsAESayAA0B7Adapter_pG_SayAA0B7Retrier_pGSayAaB_pGtFZ">interceptor(adapters:<wbr>retriers:<wbr>interceptors:<wbr>)</a>
  860. </code>
  861. <span class="declaration-note">
  862. Extension method
  863. </span>
  864. </div>
  865. <div class="height-container">
  866. <div class="pointer-container"></div>
  867. <section class="section">
  868. <div class="pointer"></div>
  869. <div class="abstract">
  870. <p>Creates an <code><a href="../Classes/Interceptor.html">Interceptor</a></code> using the provided <code><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></code>s, <code><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></code>s, and <code>RequestInterceptor</code>s.</p>
  871. </div>
  872. <div class="declaration">
  873. <h4>Declaration</h4>
  874. <div class="language">
  875. <p class="aside-title">Swift</p>
  876. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">interceptor</span><span class="p">(</span><span class="nv">adapters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
  877. <span class="nv">retriers</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
  878. <span class="nv">interceptors</span><span class="p">:</span> <span class="p">[</span><span class="kt">RequestInterceptor</span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/Interceptor.html">Interceptor</a></span></code></pre>
  879. </div>
  880. </div>
  881. <div>
  882. <h4>Parameters</h4>
  883. <table class="graybox">
  884. <tbody>
  885. <tr>
  886. <td>
  887. <code>
  888. <em>adapters</em>
  889. </code>
  890. </td>
  891. <td>
  892. <div>
  893. <p><code><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></code>s to use to adapt the request. These adapters will be run until one fails.</p>
  894. </div>
  895. </td>
  896. </tr>
  897. <tr>
  898. <td>
  899. <code>
  900. <em>retriers</em>
  901. </code>
  902. </td>
  903. <td>
  904. <div>
  905. <p><code><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></code>s to use to retry the request. These retriers will be run one at a time until
  906. a retry is triggered.</p>
  907. </div>
  908. </td>
  909. </tr>
  910. <tr>
  911. <td>
  912. <code>
  913. <em>interceptors</em>
  914. </code>
  915. </td>
  916. <td>
  917. <div>
  918. <p><code>RequestInterceptor</code>s to use to intercept the request.</p>
  919. </div>
  920. </td>
  921. </tr>
  922. </tbody>
  923. </table>
  924. </div>
  925. <div>
  926. <h4>Return Value</h4>
  927. <p>The <code><a href="../Classes/Interceptor.html">Interceptor</a></code>.</p>
  928. </div>
  929. </section>
  930. </div>
  931. </li>
  932. </ul>
  933. </div>
  934. <div class="task-group">
  935. <div class="task-name-container">
  936. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60RetryPolicy%60"></a>
  937. <a name="//apple_ref/swift/Section/Available where `Self` == `RetryPolicy`" class="dashAnchor"></a>
  938. <div class="section-name-container">
  939. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60RetryPolicy%60"></a>
  940. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code></span>
  941. </h3>
  942. </div>
  943. </div>
  944. <ul class="item-container">
  945. <li class="item">
  946. <div>
  947. <code>
  948. <a name="/s:9Alamofire18RequestInterceptorPA2A11RetryPolicyCRszrlE05retryE0AEvpZ"></a>
  949. <a name="//apple_ref/swift/Variable/retryPolicy" class="dashAnchor"></a>
  950. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A11RetryPolicyCRszrlE05retryE0AEvpZ">retryPolicy</a>
  951. </code>
  952. <span class="declaration-note">
  953. Extension method
  954. </span>
  955. </div>
  956. <div class="height-container">
  957. <div class="pointer-container"></div>
  958. <section class="section">
  959. <div class="pointer"></div>
  960. <div class="abstract">
  961. <p>Provides a default <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code> instance.</p>
  962. </div>
  963. <div class="declaration">
  964. <h4>Declaration</h4>
  965. <div class="language">
  966. <p class="aside-title">Swift</p>
  967. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">retryPolicy</span><span class="p">:</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  968. </div>
  969. </div>
  970. </section>
  971. </div>
  972. </li>
  973. <li class="item">
  974. <div>
  975. <code>
  976. <a name="/s:9Alamofire18RequestInterceptorPA2A11RetryPolicyCRszrlE05retryE00F5Limit22exponentialBackoffBase0hI5Scale20retryableHTTPMethods0L15HTTPStatusCodes0l8URLErrorO0AESu_SuSdShyAA10HTTPMethodVGShySiGShy10Foundation0P0V4CodeVGtFZ"></a>
  977. <a name="//apple_ref/swift/Method/retryPolicy(retryLimit:exponentialBackoffBase:exponentialBackoffScale:retryableHTTPMethods:retryableHTTPStatusCodes:retryableURLErrorCodes:)" class="dashAnchor"></a>
  978. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A11RetryPolicyCRszrlE05retryE00F5Limit22exponentialBackoffBase0hI5Scale20retryableHTTPMethods0L15HTTPStatusCodes0l8URLErrorO0AESu_SuSdShyAA10HTTPMethodVGShySiGShy10Foundation0P0V4CodeVGtFZ">retryPolicy(retryLimit:<wbr>exponentialBackoffBase:<wbr>exponentialBackoffScale:<wbr>retryableHTTPMethods:<wbr>retryableHTTPStatusCodes:<wbr>retryableURLErrorCodes:<wbr>)</a>
  979. </code>
  980. <span class="declaration-note">
  981. Extension method
  982. </span>
  983. </div>
  984. <div class="height-container">
  985. <div class="pointer-container"></div>
  986. <section class="section">
  987. <div class="pointer"></div>
  988. <div class="abstract">
  989. <p>Creates an <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code> from the specified parameters.</p>
  990. </div>
  991. <div class="declaration">
  992. <h4>Declaration</h4>
  993. <div class="language">
  994. <p class="aside-title">Swift</p>
  995. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">retryPolicy</span><span class="p">(</span><span class="nv">retryLimit</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryLimit</span><span class="p">,</span>
  996. <span class="nv">exponentialBackoffBase</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultExponentialBackoffBase</span><span class="p">,</span>
  997. <span class="nv">exponentialBackoffScale</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultExponentialBackoffScale</span><span class="p">,</span>
  998. <span class="nv">retryableHTTPMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryableHTTPMethods</span><span class="p">,</span>
  999. <span class="nv">retryableHTTPStatusCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryableHTTPStatusCodes</span><span class="p">,</span>
  1000. <span class="nv">retryableURLErrorCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">URLError</span><span class="o">.</span><span class="kt">Code</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryableURLErrorCodes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span></code></pre>
  1001. </div>
  1002. </div>
  1003. <div>
  1004. <h4>Parameters</h4>
  1005. <table class="graybox">
  1006. <tbody>
  1007. <tr>
  1008. <td>
  1009. <code>
  1010. <em>retryLimit</em>
  1011. </code>
  1012. </td>
  1013. <td>
  1014. <div>
  1015. <p>The total number of times the request is allowed to be retried. <code>2</code> by default.</p>
  1016. </div>
  1017. </td>
  1018. </tr>
  1019. <tr>
  1020. <td>
  1021. <code>
  1022. <em>exponentialBackoffBase</em>
  1023. </code>
  1024. </td>
  1025. <td>
  1026. <div>
  1027. <p>The base of the exponential backoff policy. <code>2</code> by default.</p>
  1028. </div>
  1029. </td>
  1030. </tr>
  1031. <tr>
  1032. <td>
  1033. <code>
  1034. <em>exponentialBackoffScale</em>
  1035. </code>
  1036. </td>
  1037. <td>
  1038. <div>
  1039. <p>The scale of the exponential backoff. <code>0.5</code> by default.</p>
  1040. </div>
  1041. </td>
  1042. </tr>
  1043. <tr>
  1044. <td>
  1045. <code>
  1046. <em>retryableHTTPMethods</em>
  1047. </code>
  1048. </td>
  1049. <td>
  1050. <div>
  1051. <p>The HTTP methods that are allowed to be retried.
  1052. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC27defaultRetryableHTTPMethodsShyAA10HTTPMethodVGvpZ">RetryPolicy.defaultRetryableHTTPMethods</a></code> by default.</p>
  1053. </div>
  1054. </td>
  1055. </tr>
  1056. <tr>
  1057. <td>
  1058. <code>
  1059. <em>retryableHTTPStatusCodes</em>
  1060. </code>
  1061. </td>
  1062. <td>
  1063. <div>
  1064. <p>The HTTP status codes that are automatically retried by the policy.
  1065. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC31defaultRetryableHTTPStatusCodesShySiGvpZ">RetryPolicy.defaultRetryableHTTPStatusCodes</a></code> by default.</p>
  1066. </div>
  1067. </td>
  1068. </tr>
  1069. <tr>
  1070. <td>
  1071. <code>
  1072. <em>retryableURLErrorCodes</em>
  1073. </code>
  1074. </td>
  1075. <td>
  1076. <div>
  1077. <p>The URL error codes that are automatically retried by the policy.
  1078. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC29defaultRetryableURLErrorCodesShy10Foundation0F0V4CodeVGvpZ">RetryPolicy.defaultRetryableURLErrorCodes</a></code> by default.</p>
  1079. </div>
  1080. </td>
  1081. </tr>
  1082. </tbody>
  1083. </table>
  1084. </div>
  1085. <div>
  1086. <h4>Return Value</h4>
  1087. <p>The <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code></p>
  1088. </div>
  1089. </section>
  1090. </div>
  1091. </li>
  1092. </ul>
  1093. </div>
  1094. <div class="task-group">
  1095. <div class="task-name-container">
  1096. <a name="/Available%20where%20%60Self%60%20%3D%3D%20%60ConnectionLostRetryPolicy%60"></a>
  1097. <a name="//apple_ref/swift/Section/Available where `Self` == `ConnectionLostRetryPolicy`" class="dashAnchor"></a>
  1098. <div class="section-name-container">
  1099. <a class="section-name-link" href="#/Available%20where%20%60Self%60%20%3D%3D%20%60ConnectionLostRetryPolicy%60"></a>
  1100. <h3 class="section-name"><span>Available where <code>Self</code> == <code><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></code></span>
  1101. </h3>
  1102. </div>
  1103. </div>
  1104. <ul class="item-container">
  1105. <li class="item">
  1106. <div>
  1107. <code>
  1108. <a name="/s:9Alamofire18RequestInterceptorPA2A25ConnectionLostRetryPolicyCRszrlE010connectionefG0AEvpZ"></a>
  1109. <a name="//apple_ref/swift/Variable/connectionLostRetryPolicy" class="dashAnchor"></a>
  1110. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A25ConnectionLostRetryPolicyCRszrlE010connectionefG0AEvpZ">connectionLostRetryPolicy</a>
  1111. </code>
  1112. <span class="declaration-note">
  1113. Extension method
  1114. </span>
  1115. </div>
  1116. <div class="height-container">
  1117. <div class="pointer-container"></div>
  1118. <section class="section">
  1119. <div class="pointer"></div>
  1120. <div class="abstract">
  1121. <p>Provides a default <code><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></code> instance.</p>
  1122. </div>
  1123. <div class="declaration">
  1124. <h4>Declaration</h4>
  1125. <div class="language">
  1126. <p class="aside-title">Swift</p>
  1127. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">connectionLostRetryPolicy</span><span class="p">:</span> <span class="kt"><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1128. </div>
  1129. </div>
  1130. </section>
  1131. </div>
  1132. </li>
  1133. <li class="item">
  1134. <div>
  1135. <code>
  1136. <a name="/s:9Alamofire18RequestInterceptorPA2A25ConnectionLostRetryPolicyCRszrlE010connectionefG010retryLimit22exponentialBackoffBase0kL5Scale20retryableHTTPMethodsAESu_SuSdShyAA10HTTPMethodVGtFZ"></a>
  1137. <a name="//apple_ref/swift/Method/connectionLostRetryPolicy(retryLimit:exponentialBackoffBase:exponentialBackoffScale:retryableHTTPMethods:)" class="dashAnchor"></a>
  1138. <a class="token" href="#/s:9Alamofire18RequestInterceptorPA2A25ConnectionLostRetryPolicyCRszrlE010connectionefG010retryLimit22exponentialBackoffBase0kL5Scale20retryableHTTPMethodsAESu_SuSdShyAA10HTTPMethodVGtFZ">connectionLostRetryPolicy(retryLimit:<wbr>exponentialBackoffBase:<wbr>exponentialBackoffScale:<wbr>retryableHTTPMethods:<wbr>)</a>
  1139. </code>
  1140. <span class="declaration-note">
  1141. Extension method
  1142. </span>
  1143. </div>
  1144. <div class="height-container">
  1145. <div class="pointer-container"></div>
  1146. <section class="section">
  1147. <div class="pointer"></div>
  1148. <div class="abstract">
  1149. <p>Creates a <code><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></code> instance from the specified parameters.</p>
  1150. </div>
  1151. <div class="declaration">
  1152. <h4>Declaration</h4>
  1153. <div class="language">
  1154. <p class="aside-title">Swift</p>
  1155. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">connectionLostRetryPolicy</span><span class="p">(</span><span class="nv">retryLimit</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryLimit</span><span class="p">,</span>
  1156. <span class="nv">exponentialBackoffBase</span><span class="p">:</span> <span class="kt">UInt</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultExponentialBackoffBase</span><span class="p">,</span>
  1157. <span class="nv">exponentialBackoffScale</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultExponentialBackoffScale</span><span class="p">,</span>
  1158. <span class="nv">retryableHTTPMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/RetryPolicy.html">RetryPolicy</a></span><span class="o">.</span><span class="n">defaultRetryableHTTPMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></span></code></pre>
  1159. </div>
  1160. </div>
  1161. <div>
  1162. <h4>Parameters</h4>
  1163. <table class="graybox">
  1164. <tbody>
  1165. <tr>
  1166. <td>
  1167. <code>
  1168. <em>retryLimit</em>
  1169. </code>
  1170. </td>
  1171. <td>
  1172. <div>
  1173. <p>The total number of times the request is allowed to be retried.
  1174. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC07defaultB5LimitSuvpZ">RetryPolicy.defaultRetryLimit</a></code> by default.</p>
  1175. </div>
  1176. </td>
  1177. </tr>
  1178. <tr>
  1179. <td>
  1180. <code>
  1181. <em>exponentialBackoffBase</em>
  1182. </code>
  1183. </td>
  1184. <td>
  1185. <div>
  1186. <p>The base of the exponential backoff policy.
  1187. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC29defaultExponentialBackoffBaseSuvpZ">RetryPolicy.defaultExponentialBackoffBase</a></code> by default.</p>
  1188. </div>
  1189. </td>
  1190. </tr>
  1191. <tr>
  1192. <td>
  1193. <code>
  1194. <em>exponentialBackoffScale</em>
  1195. </code>
  1196. </td>
  1197. <td>
  1198. <div>
  1199. <p>The scale of the exponential backoff.
  1200. <code><a href="../Classes/RetryPolicy.html#/s:9Alamofire11RetryPolicyC30defaultExponentialBackoffScaleSdvpZ">RetryPolicy.defaultExponentialBackoffScale</a></code> by default.</p>
  1201. </div>
  1202. </td>
  1203. </tr>
  1204. <tr>
  1205. <td>
  1206. <code>
  1207. <em>retryableHTTPMethods</em>
  1208. </code>
  1209. </td>
  1210. <td>
  1211. <div>
  1212. <p>The idempotent http methods to retry.</p>
  1213. </div>
  1214. </td>
  1215. </tr>
  1216. </tbody>
  1217. </table>
  1218. </div>
  1219. <div>
  1220. <h4>Return Value</h4>
  1221. <p>The <code><a href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a></code>.</p>
  1222. </div>
  1223. </section>
  1224. </div>
  1225. </li>
  1226. </ul>
  1227. </div>
  1228. </div>
  1229. </section>
  1230. </article>
  1231. </div>
  1232. <section class="footer">
  1233. <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-05-10)</p>
  1234. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1235. </section>
  1236. </body>
  1237. </html>