Protocols.html 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293
  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.2.2 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. </ul>
  463. </li>
  464. <li class="nav-group-name">
  465. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  466. <ul class="nav-group-tasks">
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  487. </li>
  488. </ul>
  489. </li>
  490. </ul>
  491. </nav>
  492. <article class="main-content">
  493. <section class="section">
  494. <div class="section-content top-matter">
  495. <h1>Protocols</h1>
  496. <p>The following protocols are available globally.</p>
  497. </div>
  498. </section>
  499. <section class="section">
  500. <div class="section-content">
  501. <div class="task-group">
  502. <ul class="item-container">
  503. <li class="item">
  504. <div>
  505. <code>
  506. <a name="/s:9Alamofire0A8ExtendedP"></a>
  507. <a name="//apple_ref/swift/Protocol/AlamofireExtended" class="dashAnchor"></a>
  508. <a class="token" href="#/s:9Alamofire0A8ExtendedP">AlamofireExtended</a>
  509. </code>
  510. </div>
  511. <div class="height-container">
  512. <div class="pointer-container"></div>
  513. <section class="section">
  514. <div class="pointer"></div>
  515. <div class="abstract">
  516. <p>Protocol describing the <code>af</code> extension points for Alamofire extended types.</p>
  517. <a href="Protocols/AlamofireExtended.html" class="slightly-smaller">See more</a>
  518. </div>
  519. <div class="declaration">
  520. <h4>Declaration</h4>
  521. <div class="language">
  522. <p class="aside-title">Swift</p>
  523. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AlamofireExtended</span></code></pre>
  524. </div>
  525. </div>
  526. </section>
  527. </div>
  528. </li>
  529. <li class="item">
  530. <div>
  531. <code>
  532. <a name="/s:9Alamofire24AuthenticationCredentialP"></a>
  533. <a name="//apple_ref/swift/Protocol/AuthenticationCredential" class="dashAnchor"></a>
  534. <a class="token" href="#/s:9Alamofire24AuthenticationCredentialP">AuthenticationCredential</a>
  535. </code>
  536. </div>
  537. <div class="height-container">
  538. <div class="pointer-container"></div>
  539. <section class="section">
  540. <div class="pointer"></div>
  541. <div class="abstract">
  542. <p>Types adopting the <code>AuthenticationCredential</code> protocol can be used to authenticate <code>URLRequest</code>s.</p>
  543. <p>One common example of an <code>AuthenticationCredential</code> is an OAuth2 credential containing an access token used to
  544. authenticate all requests on behalf of a user. The access token generally has an expiration window of 60 minutes
  545. which will then require a refresh of the credential using the refresh token to generate a new access token.</p>
  546. <a href="Protocols/AuthenticationCredential.html" class="slightly-smaller">See more</a>
  547. </div>
  548. <div class="declaration">
  549. <h4>Declaration</h4>
  550. <div class="language">
  551. <p class="aside-title">Swift</p>
  552. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AuthenticationCredential</span></code></pre>
  553. </div>
  554. </div>
  555. </section>
  556. </div>
  557. </li>
  558. <li class="item">
  559. <div>
  560. <code>
  561. <a name="/s:9Alamofire13AuthenticatorP"></a>
  562. <a name="//apple_ref/swift/Protocol/Authenticator" class="dashAnchor"></a>
  563. <a class="token" href="#/s:9Alamofire13AuthenticatorP">Authenticator</a>
  564. </code>
  565. </div>
  566. <div class="height-container">
  567. <div class="pointer-container"></div>
  568. <section class="section">
  569. <div class="pointer"></div>
  570. <div class="abstract">
  571. <p>Types adopting the <code>Authenticator</code> protocol can be used to authenticate <code>URLRequest</code>s with an
  572. <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>
  573. <a href="Protocols/Authenticator.html" class="slightly-smaller">See more</a>
  574. </div>
  575. <div class="declaration">
  576. <h4>Declaration</h4>
  577. <div class="language">
  578. <p class="aside-title">Swift</p>
  579. <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>
  580. </div>
  581. </div>
  582. </section>
  583. </div>
  584. </li>
  585. <li class="item">
  586. <div>
  587. <code>
  588. <a name="/s:9Alamofire21CachedResponseHandlerP"></a>
  589. <a name="//apple_ref/swift/Protocol/CachedResponseHandler" class="dashAnchor"></a>
  590. <a class="token" href="#/s:9Alamofire21CachedResponseHandlerP">CachedResponseHandler</a>
  591. </code>
  592. </div>
  593. <div class="height-container">
  594. <div class="pointer-container"></div>
  595. <section class="section">
  596. <div class="pointer"></div>
  597. <div class="abstract">
  598. <p>A type that handles whether the data task should store the HTTP response in the cache.</p>
  599. <a href="Protocols/CachedResponseHandler.html" class="slightly-smaller">See more</a>
  600. </div>
  601. <div class="declaration">
  602. <h4>Declaration</h4>
  603. <div class="language">
  604. <p class="aside-title">Swift</p>
  605. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">CachedResponseHandler</span></code></pre>
  606. </div>
  607. </div>
  608. </section>
  609. </div>
  610. </li>
  611. <li class="item">
  612. <div>
  613. <code>
  614. <a name="/s:9Alamofire12EventMonitorP"></a>
  615. <a name="//apple_ref/swift/Protocol/EventMonitor" class="dashAnchor"></a>
  616. <a class="token" href="#/s:9Alamofire12EventMonitorP">EventMonitor</a>
  617. </code>
  618. </div>
  619. <div class="height-container">
  620. <div class="pointer-container"></div>
  621. <section class="section">
  622. <div class="pointer"></div>
  623. <div class="abstract">
  624. <p>Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
  625. <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>
  626. <a href="Protocols/EventMonitor.html" class="slightly-smaller">See more</a>
  627. </div>
  628. <div class="declaration">
  629. <h4>Declaration</h4>
  630. <div class="language">
  631. <p class="aside-title">Swift</p>
  632. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">EventMonitor</span></code></pre>
  633. </div>
  634. </div>
  635. </section>
  636. </div>
  637. </li>
  638. <li class="item">
  639. <div>
  640. <code>
  641. <a name="/s:9Alamofire16ParameterEncoderP"></a>
  642. <a name="//apple_ref/swift/Protocol/ParameterEncoder" class="dashAnchor"></a>
  643. <a class="token" href="#/s:9Alamofire16ParameterEncoderP">ParameterEncoder</a>
  644. </code>
  645. </div>
  646. <div class="height-container">
  647. <div class="pointer-container"></div>
  648. <section class="section">
  649. <div class="pointer"></div>
  650. <div class="abstract">
  651. <p>A type that can encode any <code>Encodable</code> type into a <code>URLRequest</code>.</p>
  652. <a href="Protocols/ParameterEncoder.html" class="slightly-smaller">See more</a>
  653. </div>
  654. <div class="declaration">
  655. <h4>Declaration</h4>
  656. <div class="language">
  657. <p class="aside-title">Swift</p>
  658. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ParameterEncoder</span></code></pre>
  659. </div>
  660. </div>
  661. </section>
  662. </div>
  663. </li>
  664. <li class="item">
  665. <div>
  666. <code>
  667. <a name="/s:9Alamofire17ParameterEncodingP"></a>
  668. <a name="//apple_ref/swift/Protocol/ParameterEncoding" class="dashAnchor"></a>
  669. <a class="token" href="#/s:9Alamofire17ParameterEncodingP">ParameterEncoding</a>
  670. </code>
  671. </div>
  672. <div class="height-container">
  673. <div class="pointer-container"></div>
  674. <section class="section">
  675. <div class="pointer"></div>
  676. <div class="abstract">
  677. <p>A type used to define how a set of parameters are applied to a <code>URLRequest</code>.</p>
  678. <a href="Protocols/ParameterEncoding.html" class="slightly-smaller">See more</a>
  679. </div>
  680. <div class="declaration">
  681. <h4>Declaration</h4>
  682. <div class="language">
  683. <p class="aside-title">Swift</p>
  684. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ParameterEncoding</span></code></pre>
  685. </div>
  686. </div>
  687. </section>
  688. </div>
  689. </li>
  690. <li class="item">
  691. <div>
  692. <code>
  693. <a name="/s:9Alamofire15RedirectHandlerP"></a>
  694. <a name="//apple_ref/swift/Protocol/RedirectHandler" class="dashAnchor"></a>
  695. <a class="token" href="#/s:9Alamofire15RedirectHandlerP">RedirectHandler</a>
  696. </code>
  697. </div>
  698. <div class="height-container">
  699. <div class="pointer-container"></div>
  700. <section class="section">
  701. <div class="pointer"></div>
  702. <div class="abstract">
  703. <p>A type that handles how an HTTP redirect response from a remote server should be redirected to the new request.</p>
  704. <a href="Protocols/RedirectHandler.html" class="slightly-smaller">See more</a>
  705. </div>
  706. <div class="declaration">
  707. <h4>Declaration</h4>
  708. <div class="language">
  709. <p class="aside-title">Swift</p>
  710. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RedirectHandler</span></code></pre>
  711. </div>
  712. </div>
  713. </section>
  714. </div>
  715. </li>
  716. </ul>
  717. </div>
  718. <div class="task-group">
  719. <div class="task-name-container">
  720. <a name="/Protocol%20Conformances"></a>
  721. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  722. <div class="section-name-container">
  723. <a class="section-name-link" href="#/Protocol%20Conformances"></a>
  724. <h3 class="section-name"><p>Protocol Conformances</p>
  725. </h3>
  726. </div>
  727. </div>
  728. <ul class="item-container">
  729. <li class="item">
  730. <div>
  731. <code>
  732. <a name="/s:9Alamofire15RequestDelegateP"></a>
  733. <a name="//apple_ref/swift/Protocol/RequestDelegate" class="dashAnchor"></a>
  734. <a class="token" href="#/s:9Alamofire15RequestDelegateP">RequestDelegate</a>
  735. </code>
  736. </div>
  737. <div class="height-container">
  738. <div class="pointer-container"></div>
  739. <section class="section">
  740. <div class="pointer"></div>
  741. <div class="abstract">
  742. <p>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>
  743. <a href="Protocols/RequestDelegate.html" class="slightly-smaller">See more</a>
  744. </div>
  745. <div class="declaration">
  746. <h4>Declaration</h4>
  747. <div class="language">
  748. <p class="aside-title">Swift</p>
  749. <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>
  750. </div>
  751. </div>
  752. </section>
  753. </div>
  754. </li>
  755. </ul>
  756. </div>
  757. <div class="task-group">
  758. <div class="task-name-container">
  759. <a name="/UploadRequest"></a>
  760. <a name="//apple_ref/swift/Section/UploadRequest" class="dashAnchor"></a>
  761. <div class="section-name-container">
  762. <a class="section-name-link" href="#/UploadRequest"></a>
  763. <h3 class="section-name"><p>UploadRequest</p>
  764. </h3>
  765. </div>
  766. </div>
  767. <ul class="item-container">
  768. <li class="item">
  769. <div>
  770. <code>
  771. <a name="/s:9Alamofire21UploadableConvertibleP"></a>
  772. <a name="//apple_ref/swift/Protocol/UploadableConvertible" class="dashAnchor"></a>
  773. <a class="token" href="#/s:9Alamofire21UploadableConvertibleP">UploadableConvertible</a>
  774. </code>
  775. </div>
  776. <div class="height-container">
  777. <div class="pointer-container"></div>
  778. <section class="section">
  779. <div class="pointer"></div>
  780. <div class="abstract">
  781. <p>A type that can produce an <code><a href="Classes/UploadRequest/Uploadable.html">UploadRequest.Uploadable</a></code> value.</p>
  782. <a href="Protocols/UploadableConvertible.html" class="slightly-smaller">See more</a>
  783. </div>
  784. <div class="declaration">
  785. <h4>Declaration</h4>
  786. <div class="language">
  787. <p class="aside-title">Swift</p>
  788. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">UploadableConvertible</span></code></pre>
  789. </div>
  790. </div>
  791. </section>
  792. </div>
  793. </li>
  794. <li class="item">
  795. <div>
  796. <code>
  797. <a name="/s:9Alamofire17UploadConvertibleP"></a>
  798. <a name="//apple_ref/swift/Protocol/UploadConvertible" class="dashAnchor"></a>
  799. <a class="token" href="#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  800. </code>
  801. </div>
  802. <div class="height-container">
  803. <div class="pointer-container"></div>
  804. <section class="section">
  805. <div class="pointer"></div>
  806. <div class="abstract">
  807. <p>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>
  808. </div>
  809. <div class="declaration">
  810. <h4>Declaration</h4>
  811. <div class="language">
  812. <p class="aside-title">Swift</p>
  813. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">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>
  814. </div>
  815. </div>
  816. </section>
  817. </div>
  818. </li>
  819. <li class="item">
  820. <div>
  821. <code>
  822. <a name="/s:9Alamofire14RequestAdapterP"></a>
  823. <a name="//apple_ref/swift/Protocol/RequestAdapter" class="dashAnchor"></a>
  824. <a class="token" href="#/s:9Alamofire14RequestAdapterP">RequestAdapter</a>
  825. </code>
  826. </div>
  827. <div class="height-container">
  828. <div class="pointer-container"></div>
  829. <section class="section">
  830. <div class="pointer"></div>
  831. <div class="abstract">
  832. <p>A type that can inspect and optionally adapt a <code>URLRequest</code> in some manner if necessary.</p>
  833. <a href="Protocols/RequestAdapter.html" class="slightly-smaller">See more</a>
  834. </div>
  835. <div class="declaration">
  836. <h4>Declaration</h4>
  837. <div class="language">
  838. <p class="aside-title">Swift</p>
  839. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestAdapter</span></code></pre>
  840. </div>
  841. </div>
  842. </section>
  843. </div>
  844. </li>
  845. </ul>
  846. </div>
  847. <div class="task-group">
  848. <ul class="item-container">
  849. <li class="item">
  850. <div>
  851. <code>
  852. <a name="/s:9Alamofire14RequestRetrierP"></a>
  853. <a name="//apple_ref/swift/Protocol/RequestRetrier" class="dashAnchor"></a>
  854. <a class="token" href="#/s:9Alamofire14RequestRetrierP">RequestRetrier</a>
  855. </code>
  856. </div>
  857. <div class="height-container">
  858. <div class="pointer-container"></div>
  859. <section class="section">
  860. <div class="pointer"></div>
  861. <div class="abstract">
  862. <p>A type that determines whether a request should be retried after being executed by the specified session manager
  863. and encountering an error.</p>
  864. <a href="Protocols/RequestRetrier.html" class="slightly-smaller">See more</a>
  865. </div>
  866. <div class="declaration">
  867. <h4>Declaration</h4>
  868. <div class="language">
  869. <p class="aside-title">Swift</p>
  870. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">RequestRetrier</span></code></pre>
  871. </div>
  872. </div>
  873. </section>
  874. </div>
  875. </li>
  876. <li class="item">
  877. <div>
  878. <code>
  879. <a name="/s:9Alamofire18RequestInterceptorP"></a>
  880. <a name="//apple_ref/swift/Protocol/RequestInterceptor" class="dashAnchor"></a>
  881. <a class="token" href="#/s:9Alamofire18RequestInterceptorP">RequestInterceptor</a>
  882. </code>
  883. </div>
  884. <div class="height-container">
  885. <div class="pointer-container"></div>
  886. <section class="section">
  887. <div class="pointer"></div>
  888. <div class="abstract">
  889. <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>
  890. <a href="Protocols/RequestInterceptor.html" class="slightly-smaller">See more</a>
  891. </div>
  892. <div class="declaration">
  893. <h4>Declaration</h4>
  894. <div class="language">
  895. <p class="aside-title">Swift</p>
  896. <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>
  897. </div>
  898. </div>
  899. </section>
  900. </div>
  901. </li>
  902. </ul>
  903. </div>
  904. <div class="task-group">
  905. <div class="task-name-container">
  906. <a name="/Protocols"></a>
  907. <a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
  908. <div class="section-name-container">
  909. <a class="section-name-link" href="#/Protocols"></a>
  910. <h3 class="section-name"><p>Protocols</p>
  911. </h3>
  912. </div>
  913. </div>
  914. <ul class="item-container">
  915. <li class="item">
  916. <div>
  917. <code>
  918. <a name="/s:9Alamofire30DataResponseSerializerProtocolP"></a>
  919. <a name="//apple_ref/swift/Protocol/DataResponseSerializerProtocol" class="dashAnchor"></a>
  920. <a class="token" href="#/s:9Alamofire30DataResponseSerializerProtocolP">DataResponseSerializerProtocol</a>
  921. </code>
  922. </div>
  923. <div class="height-container">
  924. <div class="pointer-container"></div>
  925. <section class="section">
  926. <div class="pointer"></div>
  927. <div class="abstract">
  928. <p>The type to which all data response serializers must conform in order to serialize a response.</p>
  929. <a href="Protocols/DataResponseSerializerProtocol.html" class="slightly-smaller">See more</a>
  930. </div>
  931. <div class="declaration">
  932. <h4>Declaration</h4>
  933. <div class="language">
  934. <p class="aside-title">Swift</p>
  935. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataResponseSerializerProtocol</span></code></pre>
  936. </div>
  937. </div>
  938. </section>
  939. </div>
  940. </li>
  941. <li class="item">
  942. <div>
  943. <code>
  944. <a name="/s:9Alamofire34DownloadResponseSerializerProtocolP"></a>
  945. <a name="//apple_ref/swift/Protocol/DownloadResponseSerializerProtocol" class="dashAnchor"></a>
  946. <a class="token" href="#/s:9Alamofire34DownloadResponseSerializerProtocolP">DownloadResponseSerializerProtocol</a>
  947. </code>
  948. </div>
  949. <div class="height-container">
  950. <div class="pointer-container"></div>
  951. <section class="section">
  952. <div class="pointer"></div>
  953. <div class="abstract">
  954. <p>The type to which all download response serializers must conform in order to serialize a response.</p>
  955. <a href="Protocols/DownloadResponseSerializerProtocol.html" class="slightly-smaller">See more</a>
  956. </div>
  957. <div class="declaration">
  958. <h4>Declaration</h4>
  959. <div class="language">
  960. <p class="aside-title">Swift</p>
  961. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DownloadResponseSerializerProtocol</span></code></pre>
  962. </div>
  963. </div>
  964. </section>
  965. </div>
  966. </li>
  967. <li class="item">
  968. <div>
  969. <code>
  970. <a name="/s:9Alamofire18ResponseSerializerP"></a>
  971. <a name="//apple_ref/swift/Protocol/ResponseSerializer" class="dashAnchor"></a>
  972. <a class="token" href="#/s:9Alamofire18ResponseSerializerP">ResponseSerializer</a>
  973. </code>
  974. </div>
  975. <div class="height-container">
  976. <div class="pointer-container"></div>
  977. <section class="section">
  978. <div class="pointer"></div>
  979. <div class="abstract">
  980. <p>A serializer that can handle both data and download responses.</p>
  981. <a href="Protocols/ResponseSerializer.html" class="slightly-smaller">See more</a>
  982. </div>
  983. <div class="declaration">
  984. <h4>Declaration</h4>
  985. <div class="language">
  986. <p class="aside-title">Swift</p>
  987. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">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>
  988. </div>
  989. </div>
  990. </section>
  991. </div>
  992. </li>
  993. <li class="item">
  994. <div>
  995. <code>
  996. <a name="/s:9Alamofire16DataPreprocessorP"></a>
  997. <a name="//apple_ref/swift/Protocol/DataPreprocessor" class="dashAnchor"></a>
  998. <a class="token" href="#/s:9Alamofire16DataPreprocessorP">DataPreprocessor</a>
  999. </code>
  1000. </div>
  1001. <div class="height-container">
  1002. <div class="pointer-container"></div>
  1003. <section class="section">
  1004. <div class="pointer"></div>
  1005. <div class="abstract">
  1006. <p>Type used to preprocess <code>Data</code> before it handled by a serializer.</p>
  1007. <a href="Protocols/DataPreprocessor.html" class="slightly-smaller">See more</a>
  1008. </div>
  1009. <div class="declaration">
  1010. <h4>Declaration</h4>
  1011. <div class="language">
  1012. <p class="aside-title">Swift</p>
  1013. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataPreprocessor</span></code></pre>
  1014. </div>
  1015. </div>
  1016. </section>
  1017. </div>
  1018. </li>
  1019. </ul>
  1020. </div>
  1021. <div class="task-group">
  1022. <div class="task-name-container">
  1023. <a name="/Empty"></a>
  1024. <a name="//apple_ref/swift/Section/Empty" class="dashAnchor"></a>
  1025. <div class="section-name-container">
  1026. <a class="section-name-link" href="#/Empty"></a>
  1027. <h3 class="section-name"><p>Empty</p>
  1028. </h3>
  1029. </div>
  1030. </div>
  1031. <ul class="item-container">
  1032. <li class="item">
  1033. <div>
  1034. <code>
  1035. <a name="/s:9Alamofire13EmptyResponseP"></a>
  1036. <a name="//apple_ref/swift/Protocol/EmptyResponse" class="dashAnchor"></a>
  1037. <a class="token" href="#/s:9Alamofire13EmptyResponseP">EmptyResponse</a>
  1038. </code>
  1039. </div>
  1040. <div class="height-container">
  1041. <div class="pointer-container"></div>
  1042. <section class="section">
  1043. <div class="pointer"></div>
  1044. <div class="abstract">
  1045. <p>Protocol representing an empty response. Use <code>T.emptyValue()</code> to get an instance.</p>
  1046. <a href="Protocols/EmptyResponse.html" class="slightly-smaller">See more</a>
  1047. </div>
  1048. <div class="declaration">
  1049. <h4>Declaration</h4>
  1050. <div class="language">
  1051. <p class="aside-title">Swift</p>
  1052. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">EmptyResponse</span></code></pre>
  1053. </div>
  1054. </div>
  1055. </section>
  1056. </div>
  1057. </li>
  1058. </ul>
  1059. </div>
  1060. <div class="task-group">
  1061. <div class="task-name-container">
  1062. <a name="/DataDecoder%20Protocol"></a>
  1063. <a name="//apple_ref/swift/Section/DataDecoder Protocol" class="dashAnchor"></a>
  1064. <div class="section-name-container">
  1065. <a class="section-name-link" href="#/DataDecoder%20Protocol"></a>
  1066. <h3 class="section-name"><p>DataDecoder Protocol</p>
  1067. </h3>
  1068. </div>
  1069. </div>
  1070. <ul class="item-container">
  1071. <li class="item">
  1072. <div>
  1073. <code>
  1074. <a name="/s:9Alamofire11DataDecoderP"></a>
  1075. <a name="//apple_ref/swift/Protocol/DataDecoder" class="dashAnchor"></a>
  1076. <a class="token" href="#/s:9Alamofire11DataDecoderP">DataDecoder</a>
  1077. </code>
  1078. </div>
  1079. <div class="height-container">
  1080. <div class="pointer-container"></div>
  1081. <section class="section">
  1082. <div class="pointer"></div>
  1083. <div class="abstract">
  1084. <p>Any type which can decode <code>Data</code> into a <code>Decodable</code> type.</p>
  1085. <a href="Protocols/DataDecoder.html" class="slightly-smaller">See more</a>
  1086. </div>
  1087. <div class="declaration">
  1088. <h4>Declaration</h4>
  1089. <div class="language">
  1090. <p class="aside-title">Swift</p>
  1091. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataDecoder</span></code></pre>
  1092. </div>
  1093. </div>
  1094. </section>
  1095. </div>
  1096. </li>
  1097. </ul>
  1098. </div>
  1099. <div class="task-group">
  1100. <div class="task-name-container">
  1101. <a name="/DataStreamRequest"></a>
  1102. <a name="//apple_ref/swift/Section/DataStreamRequest" class="dashAnchor"></a>
  1103. <div class="section-name-container">
  1104. <a class="section-name-link" href="#/DataStreamRequest"></a>
  1105. <h3 class="section-name"><p>DataStreamRequest</p>
  1106. </h3>
  1107. </div>
  1108. </div>
  1109. <ul class="item-container">
  1110. <li class="item">
  1111. <div>
  1112. <code>
  1113. <a name="/s:9Alamofire20DataStreamSerializerP"></a>
  1114. <a name="//apple_ref/swift/Protocol/DataStreamSerializer" class="dashAnchor"></a>
  1115. <a class="token" href="#/s:9Alamofire20DataStreamSerializerP">DataStreamSerializer</a>
  1116. </code>
  1117. </div>
  1118. <div class="height-container">
  1119. <div class="pointer-container"></div>
  1120. <section class="section">
  1121. <div class="pointer"></div>
  1122. <div class="abstract">
  1123. <p>A type which can serialize incoming <code>Data</code>.</p>
  1124. <a href="Protocols/DataStreamSerializer.html" class="slightly-smaller">See more</a>
  1125. </div>
  1126. <div class="declaration">
  1127. <h4>Declaration</h4>
  1128. <div class="language">
  1129. <p class="aside-title">Swift</p>
  1130. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DataStreamSerializer</span></code></pre>
  1131. </div>
  1132. </div>
  1133. </section>
  1134. </div>
  1135. </li>
  1136. <li class="item">
  1137. <div>
  1138. <code>
  1139. <a name="/s:9Alamofire21ServerTrustEvaluatingP"></a>
  1140. <a name="//apple_ref/swift/Protocol/ServerTrustEvaluating" class="dashAnchor"></a>
  1141. <a class="token" href="#/s:9Alamofire21ServerTrustEvaluatingP">ServerTrustEvaluating</a>
  1142. </code>
  1143. </div>
  1144. <div class="height-container">
  1145. <div class="pointer-container"></div>
  1146. <section class="section">
  1147. <div class="pointer"></div>
  1148. <div class="abstract">
  1149. <p>A protocol describing the API used to evaluate server trusts.</p>
  1150. <a href="Protocols/ServerTrustEvaluating.html" class="slightly-smaller">See more</a>
  1151. </div>
  1152. <div class="declaration">
  1153. <h4>Declaration</h4>
  1154. <div class="language">
  1155. <p class="aside-title">Swift</p>
  1156. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ServerTrustEvaluating</span></code></pre>
  1157. </div>
  1158. </div>
  1159. </section>
  1160. </div>
  1161. </li>
  1162. <li class="item">
  1163. <div>
  1164. <code>
  1165. <a name="/s:9Alamofire14URLConvertibleP"></a>
  1166. <a name="//apple_ref/swift/Protocol/URLConvertible" class="dashAnchor"></a>
  1167. <a class="token" href="#/s:9Alamofire14URLConvertibleP">URLConvertible</a>
  1168. </code>
  1169. </div>
  1170. <div class="height-container">
  1171. <div class="pointer-container"></div>
  1172. <section class="section">
  1173. <div class="pointer"></div>
  1174. <div class="abstract">
  1175. <p>Types adopting the <code>URLConvertible</code> protocol can be used to construct <code>URL</code>s, which can then be used to construct
  1176. <code>URLRequests</code>.</p>
  1177. <a href="Protocols/URLConvertible.html" class="slightly-smaller">See more</a>
  1178. </div>
  1179. <div class="declaration">
  1180. <h4>Declaration</h4>
  1181. <div class="language">
  1182. <p class="aside-title">Swift</p>
  1183. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLConvertible</span></code></pre>
  1184. </div>
  1185. </div>
  1186. </section>
  1187. </div>
  1188. </li>
  1189. </ul>
  1190. </div>
  1191. <div class="task-group">
  1192. <ul class="item-container">
  1193. <li class="item">
  1194. <div>
  1195. <code>
  1196. <a name="/s:9Alamofire21URLRequestConvertibleP"></a>
  1197. <a name="//apple_ref/swift/Protocol/URLRequestConvertible" class="dashAnchor"></a>
  1198. <a class="token" href="#/s:9Alamofire21URLRequestConvertibleP">URLRequestConvertible</a>
  1199. </code>
  1200. </div>
  1201. <div class="height-container">
  1202. <div class="pointer-container"></div>
  1203. <section class="section">
  1204. <div class="pointer"></div>
  1205. <div class="abstract">
  1206. <p>Types adopting the <code>URLRequestConvertible</code> protocol can be used to safely construct <code>URLRequest</code>s.</p>
  1207. <a href="Protocols/URLRequestConvertible.html" class="slightly-smaller">See more</a>
  1208. </div>
  1209. <div class="declaration">
  1210. <h4>Declaration</h4>
  1211. <div class="language">
  1212. <p class="aside-title">Swift</p>
  1213. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">URLRequestConvertible</span></code></pre>
  1214. </div>
  1215. </div>
  1216. </section>
  1217. </div>
  1218. </li>
  1219. </ul>
  1220. </div>
  1221. </div>
  1222. </section>
  1223. </article>
  1224. </div>
  1225. <section class="footer">
  1226. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-07-17)</p>
  1227. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1228. </section>
  1229. </body>
  1230. </div>
  1231. </html>