Protocols.html 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Protocols 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/Section/Protocols" class="dashAnchor"></a>
  16. <a title="Protocols 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.10.0 Docs
  21. </a>
  22. (96% 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</a>
  44. <img class="carat" src="img/carat.png" alt=""/>
  45. Protocols 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/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="Enums/AFInfo.html">AFInfo</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="Enums/AuthenticationError.html">AuthenticationError</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="Enums/RetryResult.html">RetryResult</a>
  263. </li>
  264. </ul>
  265. </li>
  266. <li class="nav-group-name">
  267. <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
  268. <ul class="nav-group-tasks">
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="Extensions/CharacterSet.html">CharacterSet</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="Extensions/Error.html">Error</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="Extensions.html#/c:@T@OSStatus">OSStatus</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="Extensions.html#/Protected">Protected</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="Extensions/String.html">String</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
  322. </li>
  323. <li class="nav-group-task">
  324. <a class="nav-group-task-link" href="Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  325. </li>
  326. <li class="nav-group-task">
  327. <a class="nav-group-task-link" href="Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  328. </li>
  329. </ul>
  330. </li>
  331. <li class="nav-group-name">
  332. <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
  333. <ul class="nav-group-tasks">
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="Protocols/AlamofireExtended.html">AlamofireExtended</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="Protocols/Authenticator.html">Authenticator</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="Protocols/DataDecoder.html">DataDecoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="Protocols/DataPreprocessor.html">DataPreprocessor</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="Protocols/EmptyResponse.html">EmptyResponse</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="Protocols/EventMonitor.html">EventMonitor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="Protocols/ParameterEncoder.html">ParameterEncoder</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="Protocols/RedirectHandler.html">RedirectHandler</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="Protocols/RequestDelegate.html">RequestDelegate</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="Protocols/RequestInterceptor.html">RequestInterceptor</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="Protocols/ResponseSerializer.html">ResponseSerializer</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
  396. </li>
  397. <li class="nav-group-task">
  398. <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  399. </li>
  400. <li class="nav-group-task">
  401. <a class="nav-group-task-link" href="Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  402. </li>
  403. <li class="nav-group-task">
  404. <a class="nav-group-task-link" href="Protocols/UploadableConvertible.html">UploadableConvertible</a>
  405. </li>
  406. <li class="nav-group-task">
  407. <a class="nav-group-task-link" href="Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  408. </li>
  409. </ul>
  410. </li>
  411. <li class="nav-group-name">
  412. <a class="nav-group-name-link" href="Structs.html">Structures</a>
  413. <ul class="nav-group-tasks">
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="Structs/AlamofireExtension.html">AlamofireExtension</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="Structs/DataStreamTask.html">DataStreamTask</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="Structs/DataTask.html">DataTask</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="Structs/DownloadTask.html">DownloadTask</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="Structs/Empty.html">Empty</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="Structs/HTTPHeader.html">HTTPHeader</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="Structs/HTTPHeaders.html">HTTPHeaders</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="Structs/HTTPMethod.html">HTTPMethod</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="Structs/JSONEncoding/Error.html">– Error</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="Structs/Redirector.html">Redirector</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="Structs/Redirector/Behavior.html">– Behavior</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="Structs/RequestAdapterState.html">RequestAdapterState</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="Structs/ResponseCacher.html">ResponseCacher</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="Structs/ResponseCacher/Behavior.html">– Behavior</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="Structs/StreamOf.html">StreamOf</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="Structs/StreamOf/Iterator.html">– Iterator</a>
  506. </li>
  507. <li class="nav-group-task">
  508. <a class="nav-group-task-link" href="Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  509. </li>
  510. <li class="nav-group-task">
  511. <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
  512. </li>
  513. <li class="nav-group-task">
  514. <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
  515. </li>
  516. <li class="nav-group-task">
  517. <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  518. </li>
  519. <li class="nav-group-task">
  520. <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  521. </li>
  522. <li class="nav-group-task">
  523. <a class="nav-group-task-link" href="Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  524. </li>
  525. </ul>
  526. </li>
  527. <li class="nav-group-name">
  528. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  529. <ul class="nav-group-tasks">
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  532. </li>
  533. <li class="nav-group-task">
  534. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  535. </li>
  536. <li class="nav-group-task">
  537. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  538. </li>
  539. <li class="nav-group-task">
  540. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  541. </li>
  542. <li class="nav-group-task">
  543. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  544. </li>
  545. <li class="nav-group-task">
  546. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  547. </li>
  548. <li class="nav-group-task">
  549. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  550. </li>
  551. </ul>
  552. </li>
  553. </ul>
  554. </nav>
  555. <article class="main-content">
  556. <section class="section">
  557. <div class="section-content top-matter">
  558. <h1>Protocols</h1>
  559. <p>The following protocols are available globally.</p>
  560. </div>
  561. </section>
  562. <section class="section">
  563. <div class="section-content">
  564. <div class="task-group">
  565. <div class="task-name-container">
  566. <a name="/Serialization"></a>
  567. <a name="//apple_ref/swift/Section/Serialization" class="dashAnchor"></a>
  568. <div class="section-name-container">
  569. <a class="section-name-link" href="#/Serialization"></a>
  570. <h3 class="section-name"><span>Serialization</span>
  571. </h3>
  572. </div>
  573. </div>
  574. <ul class="item-container">
  575. <li class="item">
  576. <div>
  577. <code>
  578. <a name="/s:9Alamofire20DataStreamSerializerP"></a>
  579. <a name="//apple_ref/swift/Protocol/DataStreamSerializer" class="dashAnchor"></a>
  580. <a class="token" href="#/s:9Alamofire20DataStreamSerializerP">DataStreamSerializer</a>
  581. </code>
  582. </div>
  583. <div class="height-container">
  584. <div class="pointer-container"></div>
  585. <section class="section">
  586. <div class="pointer"></div>
  587. <div class="abstract">
  588. <p>A type which can serialize incoming <code>Data</code>.</p>
  589. <a href="Protocols/DataStreamSerializer.html" class="slightly-smaller">See more</a>
  590. </div>
  591. <div class="declaration">
  592. <h4>Declaration</h4>
  593. <div class="language">
  594. <p class="aside-title">Swift</p>
  595. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataStreamSerializer</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  596. </div>
  597. </div>
  598. </section>
  599. </div>
  600. </li>
  601. <li class="item">
  602. <div>
  603. <code>
  604. <a name="/s:9Alamofire16ParameterEncoderP"></a>
  605. <a name="//apple_ref/swift/Protocol/ParameterEncoder" class="dashAnchor"></a>
  606. <a class="token" href="#/s:9Alamofire16ParameterEncoderP">ParameterEncoder</a>
  607. </code>
  608. </div>
  609. <div class="height-container">
  610. <div class="pointer-container"></div>
  611. <section class="section">
  612. <div class="pointer"></div>
  613. <div class="abstract">
  614. <p>A type that can encode any <code>Encodable</code> type into a <code>URLRequest</code>.</p>
  615. <a href="Protocols/ParameterEncoder.html" class="slightly-smaller">See more</a>
  616. </div>
  617. <div class="declaration">
  618. <h4>Declaration</h4>
  619. <div class="language">
  620. <p class="aside-title">Swift</p>
  621. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ParameterEncoder</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  622. </div>
  623. </div>
  624. </section>
  625. </div>
  626. </li>
  627. <li class="item">
  628. <div>
  629. <code>
  630. <a name="/s:9Alamofire17ParameterEncodingP"></a>
  631. <a name="//apple_ref/swift/Protocol/ParameterEncoding" class="dashAnchor"></a>
  632. <a class="token" href="#/s:9Alamofire17ParameterEncodingP">ParameterEncoding</a>
  633. </code>
  634. </div>
  635. <div class="height-container">
  636. <div class="pointer-container"></div>
  637. <section class="section">
  638. <div class="pointer"></div>
  639. <div class="abstract">
  640. <p>A type used to define how a set of parameters are applied to a <code>URLRequest</code>.</p>
  641. <a href="Protocols/ParameterEncoding.html" class="slightly-smaller">See more</a>
  642. </div>
  643. <div class="declaration">
  644. <h4>Declaration</h4>
  645. <div class="language">
  646. <p class="aside-title">Swift</p>
  647. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ParameterEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  648. </div>
  649. </div>
  650. </section>
  651. </div>
  652. </li>
  653. </ul>
  654. </div>
  655. <div class="task-group">
  656. <div class="task-name-container">
  657. <a name="/Protocol%20Conformances"></a>
  658. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  659. <div class="section-name-container">
  660. <a class="section-name-link" href="#/Protocol%20Conformances"></a>
  661. <h3 class="section-name"><span>Protocol Conformances</span>
  662. </h3>
  663. </div>
  664. </div>
  665. <ul class="item-container">
  666. <li class="item">
  667. <div>
  668. <code>
  669. <a name="/s:9Alamofire15RequestDelegateP"></a>
  670. <a name="//apple_ref/swift/Protocol/RequestDelegate" class="dashAnchor"></a>
  671. <a class="token" href="#/s:9Alamofire15RequestDelegateP">RequestDelegate</a>
  672. </code>
  673. </div>
  674. <div class="height-container">
  675. <div class="pointer-container"></div>
  676. <section class="section">
  677. <div class="pointer"></div>
  678. <div class="abstract">
  679. <p>Protocol abstraction for <code><a href="Classes/Request.html">Request</a></code>&lsquo;s communication back to the <code><a href="Classes/SessionDelegate.html">SessionDelegate</a></code>.</p>
  680. <a href="Protocols/RequestDelegate.html" class="slightly-smaller">See more</a>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestDelegate</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt">Sendable</span></code></pre>
  687. </div>
  688. </div>
  689. </section>
  690. </div>
  691. </li>
  692. <li class="item">
  693. <div>
  694. <code>
  695. <a name="/s:9Alamofire14URLConvertibleP"></a>
  696. <a name="//apple_ref/swift/Protocol/URLConvertible" class="dashAnchor"></a>
  697. <a class="token" href="#/s:9Alamofire14URLConvertibleP">URLConvertible</a>
  698. </code>
  699. </div>
  700. <div class="height-container">
  701. <div class="pointer-container"></div>
  702. <section class="section">
  703. <div class="pointer"></div>
  704. <div class="abstract">
  705. <p>Types adopting the <code>URLConvertible</code> protocol can be used to construct <code>URL</code>s, which can then be used to construct
  706. <code>URLRequest</code>s.</p>
  707. <a href="Protocols/URLConvertible.html" class="slightly-smaller">See more</a>
  708. </div>
  709. <div class="declaration">
  710. <h4>Declaration</h4>
  711. <div class="language">
  712. <p class="aside-title">Swift</p>
  713. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLConvertible</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  714. </div>
  715. </div>
  716. </section>
  717. </div>
  718. </li>
  719. </ul>
  720. </div>
  721. <div class="task-group">
  722. <ul class="item-container">
  723. <li class="item">
  724. <div>
  725. <code>
  726. <a name="/s:9Alamofire21URLRequestConvertibleP"></a>
  727. <a name="//apple_ref/swift/Protocol/URLRequestConvertible" class="dashAnchor"></a>
  728. <a class="token" href="#/s:9Alamofire21URLRequestConvertibleP">URLRequestConvertible</a>
  729. </code>
  730. </div>
  731. <div class="height-container">
  732. <div class="pointer-container"></div>
  733. <section class="section">
  734. <div class="pointer"></div>
  735. <div class="abstract">
  736. <p>Types adopting the <code>URLRequestConvertible</code> protocol can be used to safely construct <code>URLRequest</code>s.</p>
  737. <a href="Protocols/URLRequestConvertible.html" class="slightly-smaller">See more</a>
  738. </div>
  739. <div class="declaration">
  740. <h4>Declaration</h4>
  741. <div class="language">
  742. <p class="aside-title">Swift</p>
  743. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLRequestConvertible</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  744. </div>
  745. </div>
  746. </section>
  747. </div>
  748. </li>
  749. <li class="item">
  750. <div>
  751. <code>
  752. <a name="/s:9Alamofire21UploadableConvertibleP"></a>
  753. <a name="//apple_ref/swift/Protocol/UploadableConvertible" class="dashAnchor"></a>
  754. <a class="token" href="#/s:9Alamofire21UploadableConvertibleP">UploadableConvertible</a>
  755. </code>
  756. </div>
  757. <div class="height-container">
  758. <div class="pointer-container"></div>
  759. <section class="section">
  760. <div class="pointer"></div>
  761. <div class="abstract">
  762. <p>A type that can produce an <code><a href="Classes/UploadRequest/Uploadable.html">UploadRequest.Uploadable</a></code> value.</p>
  763. <a href="Protocols/UploadableConvertible.html" class="slightly-smaller">See more</a>
  764. </div>
  765. <div class="declaration">
  766. <h4>Declaration</h4>
  767. <div class="language">
  768. <p class="aside-title">Swift</p>
  769. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">UploadableConvertible</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  770. </div>
  771. </div>
  772. </section>
  773. </div>
  774. </li>
  775. <li class="item">
  776. <div>
  777. <code>
  778. <a name="/s:9Alamofire17UploadConvertibleP"></a>
  779. <a name="//apple_ref/swift/Protocol/UploadConvertible" class="dashAnchor"></a>
  780. <a class="token" href="#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  781. </code>
  782. </div>
  783. <div class="height-container">
  784. <div class="pointer-container"></div>
  785. <section class="section">
  786. <div class="pointer"></div>
  787. <div class="abstract">
  788. <p>A type that can be converted to an upload, whether from an <code><a href="Classes/UploadRequest/Uploadable.html">UploadRequest.Uploadable</a></code> or <code><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>.</p>
  789. </div>
  790. <div class="declaration">
  791. <h4>Declaration</h4>
  792. <div class="language">
  793. <p class="aside-title">Swift</p>
  794. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">UploadConvertible</span> <span class="p">:</span> <span class="kt"><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/UploadableConvertible.html">UploadableConvertible</a></span></code></pre>
  795. </div>
  796. </div>
  797. </section>
  798. </div>
  799. </li>
  800. <li class="item">
  801. <div>
  802. <code>
  803. <a name="/s:9Alamofire26WebSocketMessageSerializerP"></a>
  804. <a name="//apple_ref/swift/Protocol/WebSocketMessageSerializer" class="dashAnchor"></a>
  805. <a class="token" href="#/s:9Alamofire26WebSocketMessageSerializerP">WebSocketMessageSerializer</a>
  806. </code>
  807. </div>
  808. <div class="height-container">
  809. <div class="pointer-container"></div>
  810. <section class="section">
  811. <div class="pointer"></div>
  812. <div class="abstract">
  813. <p>Undocumented</p>
  814. <a href="Protocols/WebSocketMessageSerializer.html" class="slightly-smaller">See more</a>
  815. </div>
  816. <div class="declaration">
  817. <h4>Declaration</h4>
  818. <div class="language">
  819. <p class="aside-title">Swift</p>
  820. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">WebSocketMessageSerializer</span><span class="o">&lt;</span><span class="kt">Output</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  821. </div>
  822. </div>
  823. </section>
  824. </div>
  825. </li>
  826. <li class="item">
  827. <div>
  828. <code>
  829. <a name="/s:9Alamofire0A8ExtendedP"></a>
  830. <a name="//apple_ref/swift/Protocol/AlamofireExtended" class="dashAnchor"></a>
  831. <a class="token" href="#/s:9Alamofire0A8ExtendedP">AlamofireExtended</a>
  832. </code>
  833. </div>
  834. <div class="height-container">
  835. <div class="pointer-container"></div>
  836. <section class="section">
  837. <div class="pointer"></div>
  838. <div class="abstract">
  839. <p>Protocol describing the <code>af</code> extension points for Alamofire extended types.</p>
  840. <a href="Protocols/AlamofireExtended.html" class="slightly-smaller">See more</a>
  841. </div>
  842. <div class="declaration">
  843. <h4>Declaration</h4>
  844. <div class="language">
  845. <p class="aside-title">Swift</p>
  846. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AlamofireExtended</span></code></pre>
  847. </div>
  848. </div>
  849. </section>
  850. </div>
  851. </li>
  852. <li class="item">
  853. <div>
  854. <code>
  855. <a name="/s:9Alamofire24AuthenticationCredentialP"></a>
  856. <a name="//apple_ref/swift/Protocol/AuthenticationCredential" class="dashAnchor"></a>
  857. <a class="token" href="#/s:9Alamofire24AuthenticationCredentialP">AuthenticationCredential</a>
  858. </code>
  859. </div>
  860. <div class="height-container">
  861. <div class="pointer-container"></div>
  862. <section class="section">
  863. <div class="pointer"></div>
  864. <div class="abstract">
  865. <p>Types adopting the <code>AuthenticationCredential</code> protocol can be used to authenticate <code>URLRequest</code>s.</p>
  866. <p>One common example of an <code>AuthenticationCredential</code> is an OAuth2 credential containing an access token used to
  867. authenticate all requests on behalf of a user. The access token generally has an expiration window of 60 minutes
  868. which will then require a refresh of the credential using the refresh token to generate a new access token.</p>
  869. <a href="Protocols/AuthenticationCredential.html" class="slightly-smaller">See more</a>
  870. </div>
  871. <div class="declaration">
  872. <h4>Declaration</h4>
  873. <div class="language">
  874. <p class="aside-title">Swift</p>
  875. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AuthenticationCredential</span></code></pre>
  876. </div>
  877. </div>
  878. </section>
  879. </div>
  880. </li>
  881. <li class="item">
  882. <div>
  883. <code>
  884. <a name="/s:9Alamofire13AuthenticatorP"></a>
  885. <a name="//apple_ref/swift/Protocol/Authenticator" class="dashAnchor"></a>
  886. <a class="token" href="#/s:9Alamofire13AuthenticatorP">Authenticator</a>
  887. </code>
  888. </div>
  889. <div class="height-container">
  890. <div class="pointer-container"></div>
  891. <section class="section">
  892. <div class="pointer"></div>
  893. <div class="abstract">
  894. <p>Types adopting the <code>Authenticator</code> protocol can be used to authenticate <code>URLRequest</code>s with an
  895. <code><a href="Protocols/AuthenticationCredential.html">AuthenticationCredential</a></code> as well as refresh the <code><a href="Protocols/AuthenticationCredential.html">AuthenticationCredential</a></code> when required.</p>
  896. <a href="Protocols/Authenticator.html" class="slightly-smaller">See more</a>
  897. </div>
  898. <div class="declaration">
  899. <h4>Declaration</h4>
  900. <div class="language">
  901. <p class="aside-title">Swift</p>
  902. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Authenticator</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt">Sendable</span></code></pre>
  903. </div>
  904. </div>
  905. </section>
  906. </div>
  907. </li>
  908. <li class="item">
  909. <div>
  910. <code>
  911. <a name="/s:9Alamofire21CachedResponseHandlerP"></a>
  912. <a name="//apple_ref/swift/Protocol/CachedResponseHandler" class="dashAnchor"></a>
  913. <a class="token" href="#/s:9Alamofire21CachedResponseHandlerP">CachedResponseHandler</a>
  914. </code>
  915. </div>
  916. <div class="height-container">
  917. <div class="pointer-container"></div>
  918. <section class="section">
  919. <div class="pointer"></div>
  920. <div class="abstract">
  921. <p>A type that handles whether the data task should store the HTTP response in the cache.</p>
  922. <a href="Protocols/CachedResponseHandler.html" class="slightly-smaller">See more</a>
  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">protocol</span> <span class="kt">CachedResponseHandler</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  929. </div>
  930. </div>
  931. </section>
  932. </div>
  933. </li>
  934. <li class="item">
  935. <div>
  936. <code>
  937. <a name="/s:9Alamofire12EventMonitorP"></a>
  938. <a name="//apple_ref/swift/Protocol/EventMonitor" class="dashAnchor"></a>
  939. <a class="token" href="#/s:9Alamofire12EventMonitorP">EventMonitor</a>
  940. </code>
  941. </div>
  942. <div class="height-container">
  943. <div class="pointer-container"></div>
  944. <section class="section">
  945. <div class="pointer"></div>
  946. <div class="abstract">
  947. <p>Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
  948. <code>URLSession</code> delegate protocols as well as various events from the lifetime of <code><a href="Classes/Request.html">Request</a></code> and its subclasses.</p>
  949. <a href="Protocols/EventMonitor.html" class="slightly-smaller">See more</a>
  950. </div>
  951. <div class="declaration">
  952. <h4>Declaration</h4>
  953. <div class="language">
  954. <p class="aside-title">Swift</p>
  955. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">EventMonitor</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  956. </div>
  957. </div>
  958. </section>
  959. </div>
  960. </li>
  961. <li class="item">
  962. <div>
  963. <code>
  964. <a name="/s:9Alamofire15RedirectHandlerP"></a>
  965. <a name="//apple_ref/swift/Protocol/RedirectHandler" class="dashAnchor"></a>
  966. <a class="token" href="#/s:9Alamofire15RedirectHandlerP">RedirectHandler</a>
  967. </code>
  968. </div>
  969. <div class="height-container">
  970. <div class="pointer-container"></div>
  971. <section class="section">
  972. <div class="pointer"></div>
  973. <div class="abstract">
  974. <p>A type that handles how an HTTP redirect response from a remote server should be redirected to the new request.</p>
  975. <a href="Protocols/RedirectHandler.html" class="slightly-smaller">See more</a>
  976. </div>
  977. <div class="declaration">
  978. <h4>Declaration</h4>
  979. <div class="language">
  980. <p class="aside-title">Swift</p>
  981. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RedirectHandler</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  982. </div>
  983. </div>
  984. </section>
  985. </div>
  986. </li>
  987. <li class="item">
  988. <div>
  989. <code>
  990. <a name="/s:9Alamofire18RequestInterceptorP"></a>
  991. <a name="//apple_ref/swift/Protocol/RequestInterceptor" class="dashAnchor"></a>
  992. <a class="token" href="#/s:9Alamofire18RequestInterceptorP">RequestInterceptor</a>
  993. </code>
  994. </div>
  995. <div class="height-container">
  996. <div class="pointer-container"></div>
  997. <section class="section">
  998. <div class="pointer"></div>
  999. <div class="abstract">
  1000. <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>
  1001. <a href="Protocols/RequestInterceptor.html" class="slightly-smaller">See more</a>
  1002. </div>
  1003. <div class="declaration">
  1004. <h4>Declaration</h4>
  1005. <div class="language">
  1006. <p class="aside-title">Swift</p>
  1007. <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>
  1008. </div>
  1009. </div>
  1010. </section>
  1011. </div>
  1012. </li>
  1013. <li class="item">
  1014. <div>
  1015. <code>
  1016. <a name="/s:9Alamofire14RequestAdapterP"></a>
  1017. <a name="//apple_ref/swift/Protocol/RequestAdapter" class="dashAnchor"></a>
  1018. <a class="token" href="#/s:9Alamofire14RequestAdapterP">RequestAdapter</a>
  1019. </code>
  1020. </div>
  1021. <div class="height-container">
  1022. <div class="pointer-container"></div>
  1023. <section class="section">
  1024. <div class="pointer"></div>
  1025. <div class="abstract">
  1026. <p>A type that can inspect and optionally adapt a <code>URLRequest</code> in some manner if necessary.</p>
  1027. <a href="Protocols/RequestAdapter.html" class="slightly-smaller">See more</a>
  1028. </div>
  1029. <div class="declaration">
  1030. <h4>Declaration</h4>
  1031. <div class="language">
  1032. <p class="aside-title">Swift</p>
  1033. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestAdapter</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1034. </div>
  1035. </div>
  1036. </section>
  1037. </div>
  1038. </li>
  1039. <li class="item">
  1040. <div>
  1041. <code>
  1042. <a name="/s:9Alamofire14RequestRetrierP"></a>
  1043. <a name="//apple_ref/swift/Protocol/RequestRetrier" class="dashAnchor"></a>
  1044. <a class="token" href="#/s:9Alamofire14RequestRetrierP">RequestRetrier</a>
  1045. </code>
  1046. </div>
  1047. <div class="height-container">
  1048. <div class="pointer-container"></div>
  1049. <section class="section">
  1050. <div class="pointer"></div>
  1051. <div class="abstract">
  1052. <p>A type that determines whether a request should be retried after being executed by the specified session manager
  1053. and encountering an error.</p>
  1054. <a href="Protocols/RequestRetrier.html" class="slightly-smaller">See more</a>
  1055. </div>
  1056. <div class="declaration">
  1057. <h4>Declaration</h4>
  1058. <div class="language">
  1059. <p class="aside-title">Swift</p>
  1060. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestRetrier</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1061. </div>
  1062. </div>
  1063. </section>
  1064. </div>
  1065. </li>
  1066. <li class="item">
  1067. <div>
  1068. <code>
  1069. <a name="/s:9Alamofire30DataResponseSerializerProtocolP"></a>
  1070. <a name="//apple_ref/swift/Protocol/DataResponseSerializerProtocol" class="dashAnchor"></a>
  1071. <a class="token" href="#/s:9Alamofire30DataResponseSerializerProtocolP">DataResponseSerializerProtocol</a>
  1072. </code>
  1073. </div>
  1074. <div class="height-container">
  1075. <div class="pointer-container"></div>
  1076. <section class="section">
  1077. <div class="pointer"></div>
  1078. <div class="abstract">
  1079. <p>The type to which all data response serializers must conform in order to serialize a response.</p>
  1080. <a href="Protocols/DataResponseSerializerProtocol.html" class="slightly-smaller">See more</a>
  1081. </div>
  1082. <div class="declaration">
  1083. <h4>Declaration</h4>
  1084. <div class="language">
  1085. <p class="aside-title">Swift</p>
  1086. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataResponseSerializerProtocol</span><span class="o">&lt;</span><span class="kt">SerializedObject</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1087. </div>
  1088. </div>
  1089. </section>
  1090. </div>
  1091. </li>
  1092. <li class="item">
  1093. <div>
  1094. <code>
  1095. <a name="/s:9Alamofire34DownloadResponseSerializerProtocolP"></a>
  1096. <a name="//apple_ref/swift/Protocol/DownloadResponseSerializerProtocol" class="dashAnchor"></a>
  1097. <a class="token" href="#/s:9Alamofire34DownloadResponseSerializerProtocolP">DownloadResponseSerializerProtocol</a>
  1098. </code>
  1099. </div>
  1100. <div class="height-container">
  1101. <div class="pointer-container"></div>
  1102. <section class="section">
  1103. <div class="pointer"></div>
  1104. <div class="abstract">
  1105. <p>The type to which all download response serializers must conform in order to serialize a response.</p>
  1106. <a href="Protocols/DownloadResponseSerializerProtocol.html" class="slightly-smaller">See more</a>
  1107. </div>
  1108. <div class="declaration">
  1109. <h4>Declaration</h4>
  1110. <div class="language">
  1111. <p class="aside-title">Swift</p>
  1112. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DownloadResponseSerializerProtocol</span><span class="o">&lt;</span><span class="kt">SerializedObject</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1113. </div>
  1114. </div>
  1115. </section>
  1116. </div>
  1117. </li>
  1118. <li class="item">
  1119. <div>
  1120. <code>
  1121. <a name="/s:9Alamofire18ResponseSerializerP"></a>
  1122. <a name="//apple_ref/swift/Protocol/ResponseSerializer" class="dashAnchor"></a>
  1123. <a class="token" href="#/s:9Alamofire18ResponseSerializerP">ResponseSerializer</a>
  1124. </code>
  1125. </div>
  1126. <div class="height-container">
  1127. <div class="pointer-container"></div>
  1128. <section class="section">
  1129. <div class="pointer"></div>
  1130. <div class="abstract">
  1131. <p>A serializer that can handle both data and download responses.</p>
  1132. <a href="Protocols/ResponseSerializer.html" class="slightly-smaller">See more</a>
  1133. </div>
  1134. <div class="declaration">
  1135. <h4>Declaration</h4>
  1136. <div class="language">
  1137. <p class="aside-title">Swift</p>
  1138. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ResponseSerializer</span><span class="o">&lt;</span><span class="kt">SerializedObject</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span></code></pre>
  1139. </div>
  1140. </div>
  1141. </section>
  1142. </div>
  1143. </li>
  1144. <li class="item">
  1145. <div>
  1146. <code>
  1147. <a name="/s:9Alamofire16DataPreprocessorP"></a>
  1148. <a name="//apple_ref/swift/Protocol/DataPreprocessor" class="dashAnchor"></a>
  1149. <a class="token" href="#/s:9Alamofire16DataPreprocessorP">DataPreprocessor</a>
  1150. </code>
  1151. </div>
  1152. <div class="height-container">
  1153. <div class="pointer-container"></div>
  1154. <section class="section">
  1155. <div class="pointer"></div>
  1156. <div class="abstract">
  1157. <p>Type used to preprocess <code>Data</code> before it handled by a serializer.</p>
  1158. <a href="Protocols/DataPreprocessor.html" class="slightly-smaller">See more</a>
  1159. </div>
  1160. <div class="declaration">
  1161. <h4>Declaration</h4>
  1162. <div class="language">
  1163. <p class="aside-title">Swift</p>
  1164. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataPreprocessor</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1165. </div>
  1166. </div>
  1167. </section>
  1168. </div>
  1169. </li>
  1170. </ul>
  1171. </div>
  1172. <div class="task-group">
  1173. <div class="task-name-container">
  1174. <a name="/Empty"></a>
  1175. <a name="//apple_ref/swift/Section/Empty" class="dashAnchor"></a>
  1176. <div class="section-name-container">
  1177. <a class="section-name-link" href="#/Empty"></a>
  1178. <h3 class="section-name"><span>Empty</span>
  1179. </h3>
  1180. </div>
  1181. </div>
  1182. <ul class="item-container">
  1183. <li class="item">
  1184. <div>
  1185. <code>
  1186. <a name="/s:9Alamofire13EmptyResponseP"></a>
  1187. <a name="//apple_ref/swift/Protocol/EmptyResponse" class="dashAnchor"></a>
  1188. <a class="token" href="#/s:9Alamofire13EmptyResponseP">EmptyResponse</a>
  1189. </code>
  1190. </div>
  1191. <div class="height-container">
  1192. <div class="pointer-container"></div>
  1193. <section class="section">
  1194. <div class="pointer"></div>
  1195. <div class="abstract">
  1196. <p>Protocol representing an empty response. Use <code>T.emptyValue()</code> to get an instance.</p>
  1197. <a href="Protocols/EmptyResponse.html" class="slightly-smaller">See more</a>
  1198. </div>
  1199. <div class="declaration">
  1200. <h4>Declaration</h4>
  1201. <div class="language">
  1202. <p class="aside-title">Swift</p>
  1203. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">EmptyResponse</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1204. </div>
  1205. </div>
  1206. </section>
  1207. </div>
  1208. </li>
  1209. </ul>
  1210. </div>
  1211. <div class="task-group">
  1212. <div class="task-name-container">
  1213. <a name="/DataDecoder%20Protocol"></a>
  1214. <a name="//apple_ref/swift/Section/DataDecoder Protocol" class="dashAnchor"></a>
  1215. <div class="section-name-container">
  1216. <a class="section-name-link" href="#/DataDecoder%20Protocol"></a>
  1217. <h3 class="section-name"><span>DataDecoder Protocol</span>
  1218. </h3>
  1219. </div>
  1220. </div>
  1221. <ul class="item-container">
  1222. <li class="item">
  1223. <div>
  1224. <code>
  1225. <a name="/s:9Alamofire11DataDecoderP"></a>
  1226. <a name="//apple_ref/swift/Protocol/DataDecoder" class="dashAnchor"></a>
  1227. <a class="token" href="#/s:9Alamofire11DataDecoderP">DataDecoder</a>
  1228. </code>
  1229. </div>
  1230. <div class="height-container">
  1231. <div class="pointer-container"></div>
  1232. <section class="section">
  1233. <div class="pointer"></div>
  1234. <div class="abstract">
  1235. <p>Any type which can decode <code>Data</code> into a <code>Decodable</code> type.</p>
  1236. <a href="Protocols/DataDecoder.html" class="slightly-smaller">See more</a>
  1237. </div>
  1238. <div class="declaration">
  1239. <h4>Declaration</h4>
  1240. <div class="language">
  1241. <p class="aside-title">Swift</p>
  1242. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataDecoder</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1243. </div>
  1244. </div>
  1245. </section>
  1246. </div>
  1247. </li>
  1248. <li class="item">
  1249. <div>
  1250. <code>
  1251. <a name="/s:9Alamofire21ServerTrustEvaluatingP"></a>
  1252. <a name="//apple_ref/swift/Protocol/ServerTrustEvaluating" class="dashAnchor"></a>
  1253. <a class="token" href="#/s:9Alamofire21ServerTrustEvaluatingP">ServerTrustEvaluating</a>
  1254. </code>
  1255. </div>
  1256. <div class="height-container">
  1257. <div class="pointer-container"></div>
  1258. <section class="section">
  1259. <div class="pointer"></div>
  1260. <div class="abstract">
  1261. <p>A protocol describing the API used to evaluate server trusts.</p>
  1262. <a href="Protocols/ServerTrustEvaluating.html" class="slightly-smaller">See more</a>
  1263. </div>
  1264. <div class="declaration">
  1265. <h4>Declaration</h4>
  1266. <div class="language">
  1267. <p class="aside-title">Swift</p>
  1268. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ServerTrustEvaluating</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  1269. </div>
  1270. </div>
  1271. </section>
  1272. </div>
  1273. </li>
  1274. </ul>
  1275. </div>
  1276. </div>
  1277. </section>
  1278. </article>
  1279. </div>
  1280. <section class="footer">
  1281. <p>&copy; 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-10-13)</p>
  1282. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1283. </section>
  1284. </body>
  1285. </html>