Protocols.html 66 KB

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