Classes.html 77 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Classes 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/Classes" class="dashAnchor"></a>
  16. <a title="Classes Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="index.html">
  20. Alamofire Docs
  21. </a>
  22. (77% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="index.html">Alamofire Reference</a>
  44. <img class="carat" src="img/carat.png" />
  45. Classes Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="Classes/Request/State.html">– State</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="Classes/Retrier.html">Retrier</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="Classes/RetryPolicy.html">RetryPolicy</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="Classes/ServerTrustManager.html">ServerTrustManager</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="Classes/Session.html">Session</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  178. </li>
  179. </ul>
  180. </li>
  181. <li class="nav-group-name">
  182. <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
  183. <ul class="nav-group-tasks">
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="Enums/AF.html">AF</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="Enums/HTTPMethod.html">HTTPMethod</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="Enums/RetryResult.html">RetryResult</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="Extensions/CharacterSet.html">CharacterSet</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="Extensions/Error.html">Error</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="Extensions/String.html">String</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="Functions.html">Functions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  256. </li>
  257. </ul>
  258. </li>
  259. <li class="nav-group-name">
  260. <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
  261. <ul class="nav-group-tasks">
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="Protocols/AlamofireExtended.html">AlamofireExtended</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="Protocols/DataDecoder.html">DataDecoder</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="Protocols/EmptyResponse.html">EmptyResponse</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="Protocols/EventMonitor.html">EventMonitor</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="Protocols/ParameterEncoder.html">ParameterEncoder</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="Protocols/RedirectHandler.html">RedirectHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="Protocols/RequestDelegate.html">RequestDelegate</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="Protocols/RequestInterceptor.html">RequestInterceptor</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="Protocols/ResponseSerializer.html">ResponseSerializer</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="Protocols/UploadableConvertible.html">UploadableConvertible</a>
  321. </li>
  322. </ul>
  323. </li>
  324. <li class="nav-group-name">
  325. <a class="nav-group-name-link" href="Structs.html">Structures</a>
  326. <ul class="nav-group-tasks">
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="Structs/AlamofireExtension.html">AlamofireExtension</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
  332. </li>
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="Structs/Empty.html">Empty</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="Structs/HTTPHeader.html">HTTPHeader</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="Structs/HTTPHeaders.html">HTTPHeaders</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="Structs/Redirector.html">Redirector</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="Structs/Redirector/Behavior.html">– Behavior</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="Structs/ResponseCacher.html">ResponseCacher</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="Structs/ResponseCacher/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  371. </li>
  372. </ul>
  373. </li>
  374. <li class="nav-group-name">
  375. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  376. <ul class="nav-group-tasks">
  377. <li class="nav-group-task">
  378. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  379. </li>
  380. <li class="nav-group-task">
  381. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  382. </li>
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  388. </li>
  389. </ul>
  390. </li>
  391. </ul>
  392. </nav>
  393. <article class="main-content">
  394. <section class="section">
  395. <div class="section-content">
  396. <h1>Classes</h1>
  397. <p>The following classes are available globally.</p>
  398. </div>
  399. </section>
  400. <section class="section">
  401. <div class="section-content">
  402. <div class="task-group">
  403. <ul class="item-container">
  404. <li class="item">
  405. <div>
  406. <code>
  407. <a name="/s:9Alamofire21CompositeEventMonitorC"></a>
  408. <a name="//apple_ref/swift/Class/CompositeEventMonitor" class="dashAnchor"></a>
  409. <a class="token" href="#/s:9Alamofire21CompositeEventMonitorC">CompositeEventMonitor</a>
  410. </code>
  411. </div>
  412. <div class="height-container">
  413. <div class="pointer-container"></div>
  414. <section class="section">
  415. <div class="pointer"></div>
  416. <div class="abstract">
  417. <p>An <code><a href="Protocols/EventMonitor.html">EventMonitor</a></code> which can contain multiple <code><a href="Protocols/EventMonitor.html">EventMonitor</a></code>s and calls their methods on their queues.</p>
  418. <a href="Classes/CompositeEventMonitor.html" class="slightly-smaller">See more</a>
  419. </div>
  420. <div class="declaration">
  421. <h4>Declaration</h4>
  422. <div class="language">
  423. <p class="aside-title">Swift</p>
  424. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CompositeEventMonitor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/EventMonitor.html">EventMonitor</a></span></code></pre>
  425. </div>
  426. </div>
  427. </section>
  428. </div>
  429. </li>
  430. <li class="item">
  431. <div>
  432. <code>
  433. <a name="/s:9Alamofire19ClosureEventMonitorC"></a>
  434. <a name="//apple_ref/swift/Class/ClosureEventMonitor" class="dashAnchor"></a>
  435. <a class="token" href="#/s:9Alamofire19ClosureEventMonitorC">ClosureEventMonitor</a>
  436. </code>
  437. </div>
  438. <div class="height-container">
  439. <div class="pointer-container"></div>
  440. <section class="section">
  441. <div class="pointer"></div>
  442. <div class="abstract">
  443. <p><code><a href="Protocols/EventMonitor.html">EventMonitor</a></code> that allows optional closures to be set to receive events.</p>
  444. <a href="Classes/ClosureEventMonitor.html" class="slightly-smaller">See more</a>
  445. </div>
  446. <div class="declaration">
  447. <h4>Declaration</h4>
  448. <div class="language">
  449. <p class="aside-title">Swift</p>
  450. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ClosureEventMonitor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/EventMonitor.html">EventMonitor</a></span></code></pre>
  451. </div>
  452. </div>
  453. </section>
  454. </div>
  455. </li>
  456. </ul>
  457. </div>
  458. <div class="task-group">
  459. <ul class="item-container">
  460. <li class="item">
  461. <div>
  462. <code>
  463. <a name="/s:9Alamofire17MultipartFormDataC"></a>
  464. <a name="//apple_ref/swift/Class/MultipartFormData" class="dashAnchor"></a>
  465. <a class="token" href="#/s:9Alamofire17MultipartFormDataC">MultipartFormData</a>
  466. </code>
  467. </div>
  468. <div class="height-container">
  469. <div class="pointer-container"></div>
  470. <section class="section">
  471. <div class="pointer"></div>
  472. <div class="abstract">
  473. <p>Constructs <code>multipart/form-data</code> for uploads within an HTTP or HTTPS body. There are currently two ways to encode
  474. multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead
  475. to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the
  476. data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for
  477. larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.</p>
  478. <p>For more information on <code>multipart/form-data</code> in general, please refer to the RFC-2388 and RFC-2045 specs as well
  479. and the w3 form documentation.</p>
  480. <ul>
  481. <li><a href="https://www.ietf.org/rfc/rfc2388.txt">https://www.ietf.org/rfc/rfc2388.txt</a></li>
  482. <li><a href="https://www.ietf.org/rfc/rfc2045.txt">https://www.ietf.org/rfc/rfc2045.txt</a></li>
  483. <li><a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13">https://www.w3.org/TR/html401/interact/forms.html#h-17.13</a></li>
  484. </ul>
  485. <a href="Classes/MultipartFormData.html" class="slightly-smaller">See more</a>
  486. </div>
  487. <div class="declaration">
  488. <h4>Declaration</h4>
  489. <div class="language">
  490. <p class="aside-title">Swift</p>
  491. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">MultipartFormData</span></code></pre>
  492. </div>
  493. </div>
  494. </section>
  495. </div>
  496. </li>
  497. </ul>
  498. </div>
  499. <div class="task-group">
  500. <ul class="item-container">
  501. <li class="item">
  502. <div>
  503. <code>
  504. <a name="/s:9Alamofire26NetworkReachabilityManagerC"></a>
  505. <a name="//apple_ref/swift/Class/NetworkReachabilityManager" class="dashAnchor"></a>
  506. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC">NetworkReachabilityManager</a>
  507. </code>
  508. </div>
  509. <div class="height-container">
  510. <div class="pointer-container"></div>
  511. <section class="section">
  512. <div class="pointer"></div>
  513. <div class="abstract">
  514. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both WWAN and
  515. WiFi network interfaces.</p>
  516. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  517. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  518. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  519. <a href="Classes/NetworkReachabilityManager.html" class="slightly-smaller">See more</a>
  520. </div>
  521. <div class="declaration">
  522. <h4>Declaration</h4>
  523. <div class="language">
  524. <p class="aside-title">Swift</p>
  525. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  526. </div>
  527. </div>
  528. </section>
  529. </div>
  530. </li>
  531. </ul>
  532. </div>
  533. <div class="task-group">
  534. <ul class="item-container">
  535. <li class="item">
  536. <div>
  537. <code>
  538. <a name="/s:9Alamofire7RequestC"></a>
  539. <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
  540. <a class="token" href="#/s:9Alamofire7RequestC">Request</a>
  541. </code>
  542. </div>
  543. <div class="height-container">
  544. <div class="pointer-container"></div>
  545. <section class="section">
  546. <div class="pointer"></div>
  547. <div class="abstract">
  548. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  549. handling.</p>
  550. <a href="Classes/Request.html" class="slightly-smaller">See more</a>
  551. </div>
  552. <div class="declaration">
  553. <h4>Declaration</h4>
  554. <div class="language">
  555. <p class="aside-title">Swift</p>
  556. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  557. </div>
  558. </div>
  559. </section>
  560. </div>
  561. </li>
  562. </ul>
  563. </div>
  564. <div class="task-group">
  565. <ul class="item-container">
  566. <li class="item">
  567. <div>
  568. <code>
  569. <a name="/s:9Alamofire0A13NotificationsC"></a>
  570. <a name="//apple_ref/swift/Class/AlamofireNotifications" class="dashAnchor"></a>
  571. <a class="token" href="#/s:9Alamofire0A13NotificationsC">AlamofireNotifications</a>
  572. </code>
  573. </div>
  574. <div class="height-container">
  575. <div class="pointer-container"></div>
  576. <section class="section">
  577. <div class="pointer"></div>
  578. <div class="abstract">
  579. <p><code><a href="Protocols/EventMonitor.html">EventMonitor</a></code> that provides Alamofire&rsquo;s notifications.</p>
  580. <a href="Classes/AlamofireNotifications.html" class="slightly-smaller">See more</a>
  581. </div>
  582. <div class="declaration">
  583. <h4>Declaration</h4>
  584. <div class="language">
  585. <p class="aside-title">Swift</p>
  586. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AlamofireNotifications</span> <span class="p">:</span> <span class="kt"><a href="Protocols/EventMonitor.html">EventMonitor</a></span></code></pre>
  587. </div>
  588. </div>
  589. </section>
  590. </div>
  591. </li>
  592. </ul>
  593. </div>
  594. <div class="task-group">
  595. <ul class="item-container">
  596. <li class="item">
  597. <div>
  598. <code>
  599. <a name="/s:9Alamofire20JSONParameterEncoderC"></a>
  600. <a name="//apple_ref/swift/Class/JSONParameterEncoder" class="dashAnchor"></a>
  601. <a class="token" href="#/s:9Alamofire20JSONParameterEncoderC">JSONParameterEncoder</a>
  602. </code>
  603. </div>
  604. <div class="height-container">
  605. <div class="pointer-container"></div>
  606. <section class="section">
  607. <div class="pointer"></div>
  608. <div class="abstract">
  609. <p>A <code><a href="Protocols/ParameterEncoder.html">ParameterEncoder</a></code> that encodes types as JSON body data.</p>
  610. <p>If no <code>Content-Type</code> header is already set on the provided <code>URLRequest</code>s, it&rsquo;s set to <code>application/json</code>.</p>
  611. <a href="Classes/JSONParameterEncoder.html" class="slightly-smaller">See more</a>
  612. </div>
  613. <div class="declaration">
  614. <h4>Declaration</h4>
  615. <div class="language">
  616. <p class="aside-title">Swift</p>
  617. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">JSONParameterEncoder</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoder.html">ParameterEncoder</a></span></code></pre>
  618. </div>
  619. </div>
  620. </section>
  621. </div>
  622. </li>
  623. <li class="item">
  624. <div>
  625. <code>
  626. <a name="/s:9Alamofire30URLEncodedFormParameterEncoderC"></a>
  627. <a name="//apple_ref/swift/Class/URLEncodedFormParameterEncoder" class="dashAnchor"></a>
  628. <a class="token" href="#/s:9Alamofire30URLEncodedFormParameterEncoderC">URLEncodedFormParameterEncoder</a>
  629. </code>
  630. </div>
  631. <div class="height-container">
  632. <div class="pointer-container"></div>
  633. <section class="section">
  634. <div class="pointer"></div>
  635. <div class="abstract">
  636. <p>A <code><a href="Protocols/ParameterEncoder.html">ParameterEncoder</a></code> that encodes types as URL-encoded query strings to be set on the URL or as body data, depending
  637. on the <code>Destination</code> set.</p>
  638. <p>If no <code>Content-Type</code> header is already set on the provided <code>URLRequest</code>s, it will be set to
  639. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  640. <p>There is no published specification for how to encode collection types. By default, the convention of appending
  641. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  642. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  643. square brackets appended to array keys.</p>
  644. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  645. <code>true</code> as 1 and <code>false</code> as 0.</p>
  646. <a href="Classes/URLEncodedFormParameterEncoder.html" class="slightly-smaller">See more</a>
  647. </div>
  648. <div class="declaration">
  649. <h4>Declaration</h4>
  650. <div class="language">
  651. <p class="aside-title">Swift</p>
  652. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">URLEncodedFormParameterEncoder</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoder.html">ParameterEncoder</a></span></code></pre>
  653. </div>
  654. </div>
  655. </section>
  656. </div>
  657. </li>
  658. <li class="item">
  659. <div>
  660. <code>
  661. <a name="/s:9Alamofire21URLEncodedFormEncoderC"></a>
  662. <a name="//apple_ref/swift/Class/URLEncodedFormEncoder" class="dashAnchor"></a>
  663. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC">URLEncodedFormEncoder</a>
  664. </code>
  665. </div>
  666. <div class="height-container">
  667. <div class="pointer-container"></div>
  668. <section class="section">
  669. <div class="pointer"></div>
  670. <div class="abstract">
  671. <p>An object that encodes instances into URL-encoded query strings.</p>
  672. <p>There is no published specification for how to encode collection types. By default, the convention of appending
  673. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  674. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  675. square brackets appended to array keys.</p>
  676. <p><code>BoolEncoding</code> can be used to configure how <code>Bool</code> values are encoded. The default behavior is to encode
  677. <code>true</code> as 1 and <code>false</code> as 0.</p>
  678. <p><code>SpaceEncoding</code> can be used to configure how spaces are encoded. Modern encodings use percent replacement (%20),
  679. while older encoding may expect spaces to be replaced with +.</p>
  680. <p>This type is largely based on Vapor&rsquo;s <a href="https://github.com/vapor/url-encoded-form"><code>url-encoded-form</code></a> project.</p>
  681. <a href="Classes/URLEncodedFormEncoder.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">final</span> <span class="kd">class</span> <span class="kt">URLEncodedFormEncoder</span></code></pre>
  688. </div>
  689. </div>
  690. </section>
  691. </div>
  692. </li>
  693. </ul>
  694. </div>
  695. <div class="task-group">
  696. <div class="task-name-container">
  697. <a name="/DataRequest"></a>
  698. <a name="//apple_ref/swift/Section/DataRequest" class="dashAnchor"></a>
  699. <a href="#/DataRequest">
  700. <h3 class="section-name">DataRequest</h3>
  701. </a>
  702. </div>
  703. <ul class="item-container">
  704. <li class="item">
  705. <div>
  706. <code>
  707. <a name="/s:9Alamofire11DataRequestC"></a>
  708. <a name="//apple_ref/swift/Class/DataRequest" class="dashAnchor"></a>
  709. <a class="token" href="#/s:9Alamofire11DataRequestC">DataRequest</a>
  710. </code>
  711. </div>
  712. <div class="height-container">
  713. <div class="pointer-container"></div>
  714. <section class="section">
  715. <div class="pointer"></div>
  716. <div class="abstract">
  717. <p>Undocumented</p>
  718. <a href="Classes/DataRequest.html" class="slightly-smaller">See more</a>
  719. </div>
  720. <div class="declaration">
  721. <h4>Declaration</h4>
  722. <div class="language">
  723. <p class="aside-title">Swift</p>
  724. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DataRequest</span> <span class="p">:</span> <span class="kt"><a href="Classes/Request.html">Request</a></span></code></pre>
  725. </div>
  726. </div>
  727. </section>
  728. </div>
  729. </li>
  730. <li class="item">
  731. <div>
  732. <code>
  733. <a name="/s:9Alamofire15DownloadRequestC"></a>
  734. <a name="//apple_ref/swift/Class/DownloadRequest" class="dashAnchor"></a>
  735. <a class="token" href="#/s:9Alamofire15DownloadRequestC">DownloadRequest</a>
  736. </code>
  737. </div>
  738. <div class="height-container">
  739. <div class="pointer-container"></div>
  740. <section class="section">
  741. <div class="pointer"></div>
  742. <div class="abstract">
  743. <p>Undocumented</p>
  744. <a href="Classes/DownloadRequest.html" class="slightly-smaller">See more</a>
  745. </div>
  746. <div class="declaration">
  747. <h4>Declaration</h4>
  748. <div class="language">
  749. <p class="aside-title">Swift</p>
  750. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span> <span class="p">:</span> <span class="kt"><a href="Classes/Request.html">Request</a></span></code></pre>
  751. </div>
  752. </div>
  753. </section>
  754. </div>
  755. </li>
  756. <li class="item">
  757. <div>
  758. <code>
  759. <a name="/s:9Alamofire13UploadRequestC"></a>
  760. <a name="//apple_ref/swift/Class/UploadRequest" class="dashAnchor"></a>
  761. <a class="token" href="#/s:9Alamofire13UploadRequestC">UploadRequest</a>
  762. </code>
  763. </div>
  764. <div class="height-container">
  765. <div class="pointer-container"></div>
  766. <section class="section">
  767. <div class="pointer"></div>
  768. <div class="abstract">
  769. <p>Undocumented</p>
  770. <a href="Classes/UploadRequest.html" class="slightly-smaller">See more</a>
  771. </div>
  772. <div class="declaration">
  773. <h4>Declaration</h4>
  774. <div class="language">
  775. <p class="aside-title">Swift</p>
  776. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UploadRequest</span> <span class="p">:</span> <span class="kt"><a href="Classes/DataRequest.html">DataRequest</a></span></code></pre>
  777. </div>
  778. </div>
  779. </section>
  780. </div>
  781. </li>
  782. </ul>
  783. </div>
  784. <div class="task-group">
  785. <ul class="item-container">
  786. <li class="item">
  787. <div>
  788. <code>
  789. <a name="/s:9Alamofire7AdapterC"></a>
  790. <a name="//apple_ref/swift/Class/Adapter" class="dashAnchor"></a>
  791. <a class="token" href="#/s:9Alamofire7AdapterC">Adapter</a>
  792. </code>
  793. </div>
  794. <div class="height-container">
  795. <div class="pointer-container"></div>
  796. <section class="section">
  797. <div class="pointer"></div>
  798. <div class="abstract">
  799. <p>Undocumented</p>
  800. <a href="Classes/Adapter.html" class="slightly-smaller">See more</a>
  801. </div>
  802. <div class="declaration">
  803. <h4>Declaration</h4>
  804. <div class="language">
  805. <p class="aside-title">Swift</p>
  806. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Adapter</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
  807. </div>
  808. </div>
  809. </section>
  810. </div>
  811. </li>
  812. </ul>
  813. </div>
  814. <div class="task-group">
  815. <ul class="item-container">
  816. <li class="item">
  817. <div>
  818. <code>
  819. <a name="/s:9Alamofire7RetrierC"></a>
  820. <a name="//apple_ref/swift/Class/Retrier" class="dashAnchor"></a>
  821. <a class="token" href="#/s:9Alamofire7RetrierC">Retrier</a>
  822. </code>
  823. </div>
  824. <div class="height-container">
  825. <div class="pointer-container"></div>
  826. <section class="section">
  827. <div class="pointer"></div>
  828. <div class="abstract">
  829. <p>Undocumented</p>
  830. <a href="Classes/Retrier.html" class="slightly-smaller">See more</a>
  831. </div>
  832. <div class="declaration">
  833. <h4>Declaration</h4>
  834. <div class="language">
  835. <p class="aside-title">Swift</p>
  836. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Retrier</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
  837. </div>
  838. </div>
  839. </section>
  840. </div>
  841. </li>
  842. </ul>
  843. </div>
  844. <div class="task-group">
  845. <ul class="item-container">
  846. <li class="item">
  847. <div>
  848. <code>
  849. <a name="/s:9Alamofire11InterceptorC"></a>
  850. <a name="//apple_ref/swift/Class/Interceptor" class="dashAnchor"></a>
  851. <a class="token" href="#/s:9Alamofire11InterceptorC">Interceptor</a>
  852. </code>
  853. </div>
  854. <div class="height-container">
  855. <div class="pointer-container"></div>
  856. <section class="section">
  857. <div class="pointer"></div>
  858. <div class="abstract">
  859. <p>Undocumented</p>
  860. <a href="Classes/Interceptor.html" class="slightly-smaller">See more</a>
  861. </div>
  862. <div class="declaration">
  863. <h4>Declaration</h4>
  864. <div class="language">
  865. <p class="aside-title">Swift</p>
  866. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Interceptor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
  867. </div>
  868. </div>
  869. </section>
  870. </div>
  871. </li>
  872. </ul>
  873. </div>
  874. <div class="task-group">
  875. <div class="task-name-container">
  876. <a name="/Data"></a>
  877. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  878. <a href="#/Data">
  879. <h3 class="section-name">Data</h3>
  880. </a>
  881. </div>
  882. <ul class="item-container">
  883. <li class="item">
  884. <div>
  885. <code>
  886. <a name="/s:9Alamofire22DataResponseSerializerC"></a>
  887. <a name="//apple_ref/swift/Class/DataResponseSerializer" class="dashAnchor"></a>
  888. <a class="token" href="#/s:9Alamofire22DataResponseSerializerC">DataResponseSerializer</a>
  889. </code>
  890. </div>
  891. <div class="height-container">
  892. <div class="pointer-container"></div>
  893. <section class="section">
  894. <div class="pointer"></div>
  895. <div class="abstract">
  896. <p>A <code><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></code> that performs minimal reponse checking and returns any response data as-is. By default, a
  897. request returning <code>nil</code> or no data is considered an error. However, if the response is has a status code valid for
  898. empty responses (<code>204</code>, <code>205</code>), then an empty <code>Data</code> value is returned.</p>
  899. <a href="Classes/DataResponseSerializer.html" class="slightly-smaller">See more</a>
  900. </div>
  901. <div class="declaration">
  902. <h4>Declaration</h4>
  903. <div class="language">
  904. <p class="aside-title">Swift</p>
  905. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">DataResponseSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></span></code></pre>
  906. </div>
  907. </div>
  908. </section>
  909. </div>
  910. </li>
  911. </ul>
  912. </div>
  913. <div class="task-group">
  914. <div class="task-name-container">
  915. <a name="/String"></a>
  916. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  917. <a href="#/String">
  918. <h3 class="section-name">String</h3>
  919. </a>
  920. </div>
  921. <ul class="item-container">
  922. <li class="item">
  923. <div>
  924. <code>
  925. <a name="/s:9Alamofire24StringResponseSerializerC"></a>
  926. <a name="//apple_ref/swift/Class/StringResponseSerializer" class="dashAnchor"></a>
  927. <a class="token" href="#/s:9Alamofire24StringResponseSerializerC">StringResponseSerializer</a>
  928. </code>
  929. </div>
  930. <div class="height-container">
  931. <div class="pointer-container"></div>
  932. <section class="section">
  933. <div class="pointer"></div>
  934. <div class="abstract">
  935. <p>A <code><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></code> that decodes the response data as a <code>String</code>. By default, a request returning <code>nil</code> or no
  936. data is considered an error. However, if the response is has a status code valid for empty responses (<code>204</code>, <code>205</code>),
  937. then an empty <code>String</code> is returned.</p>
  938. <a href="Classes/StringResponseSerializer.html" class="slightly-smaller">See more</a>
  939. </div>
  940. <div class="declaration">
  941. <h4>Declaration</h4>
  942. <div class="language">
  943. <p class="aside-title">Swift</p>
  944. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">StringResponseSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></span></code></pre>
  945. </div>
  946. </div>
  947. </section>
  948. </div>
  949. </li>
  950. </ul>
  951. </div>
  952. <div class="task-group">
  953. <div class="task-name-container">
  954. <a name="/JSON"></a>
  955. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  956. <a href="#/JSON">
  957. <h3 class="section-name">JSON</h3>
  958. </a>
  959. </div>
  960. <ul class="item-container">
  961. <li class="item">
  962. <div>
  963. <code>
  964. <a name="/s:9Alamofire22JSONResponseSerializerC"></a>
  965. <a name="//apple_ref/swift/Class/JSONResponseSerializer" class="dashAnchor"></a>
  966. <a class="token" href="#/s:9Alamofire22JSONResponseSerializerC">JSONResponseSerializer</a>
  967. </code>
  968. </div>
  969. <div class="height-container">
  970. <div class="pointer-container"></div>
  971. <section class="section">
  972. <div class="pointer"></div>
  973. <div class="abstract">
  974. <p>A <code><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></code> that decodes the response data using <code>JSONSerialization</code>. By default, a request returning
  975. <code>nil</code> or no data is considered an error. However, if the response is has a status code valid for empty responses
  976. (<code>204</code>, <code>205</code>), then an <code>NSNull</code> value is returned.</p>
  977. <a href="Classes/JSONResponseSerializer.html" class="slightly-smaller">See more</a>
  978. </div>
  979. <div class="declaration">
  980. <h4>Declaration</h4>
  981. <div class="language">
  982. <p class="aside-title">Swift</p>
  983. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">JSONResponseSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></span></code></pre>
  984. </div>
  985. </div>
  986. </section>
  987. </div>
  988. </li>
  989. </ul>
  990. </div>
  991. <div class="task-group">
  992. <div class="task-name-container">
  993. <a name="/Decodable"></a>
  994. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  995. <a href="#/Decodable">
  996. <h3 class="section-name">Decodable</h3>
  997. </a>
  998. </div>
  999. <ul class="item-container">
  1000. <li class="item">
  1001. <div>
  1002. <code>
  1003. <a name="/s:9Alamofire27DecodableResponseSerializerC"></a>
  1004. <a name="//apple_ref/swift/Class/DecodableResponseSerializer" class="dashAnchor"></a>
  1005. <a class="token" href="#/s:9Alamofire27DecodableResponseSerializerC">DecodableResponseSerializer</a>
  1006. </code>
  1007. </div>
  1008. <div class="height-container">
  1009. <div class="pointer-container"></div>
  1010. <section class="section">
  1011. <div class="pointer"></div>
  1012. <div class="abstract">
  1013. <p>A <code><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></code> that decodes the response data as a generic value using any type that conforms to
  1014. <code><a href="Protocols/DataDecoder.html">DataDecoder</a></code>. By default, this is an instance of <code>JSONDecoder</code>. Additionally, a request returning <code>nil</code> or no data
  1015. is considered an error. However, if the response is has a status code valid for empty responses (<code>204</code>, <code>205</code>), then
  1016. the <code><a href="Structs/Empty.html#/s:9Alamofire5EmptyV5valueACvpZ">Empty.value</a></code> value is returned.</p>
  1017. <a href="Classes/DecodableResponseSerializer.html" class="slightly-smaller">See more</a>
  1018. </div>
  1019. <div class="declaration">
  1020. <h4>Declaration</h4>
  1021. <div class="language">
  1022. <p class="aside-title">Swift</p>
  1023. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">DecodableResponseSerializer</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ResponseSerializer.html">ResponseSerializer</a></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
  1024. </div>
  1025. </div>
  1026. </section>
  1027. </div>
  1028. </li>
  1029. </ul>
  1030. </div>
  1031. <div class="task-group">
  1032. <ul class="item-container">
  1033. <li class="item">
  1034. <div>
  1035. <code>
  1036. <a name="/s:9Alamofire11RetryPolicyC"></a>
  1037. <a name="//apple_ref/swift/Class/RetryPolicy" class="dashAnchor"></a>
  1038. <a class="token" href="#/s:9Alamofire11RetryPolicyC">RetryPolicy</a>
  1039. </code>
  1040. </div>
  1041. <div class="height-container">
  1042. <div class="pointer-container"></div>
  1043. <section class="section">
  1044. <div class="pointer"></div>
  1045. <div class="abstract">
  1046. <p>A retry policy that retries requests using an exponential backoff for allowed HTTP methods and HTTP status codes
  1047. as well as certain types of networking errors.</p>
  1048. <a href="Classes/RetryPolicy.html" class="slightly-smaller">See more</a>
  1049. </div>
  1050. <div class="declaration">
  1051. <h4>Declaration</h4>
  1052. <div class="language">
  1053. <p class="aside-title">Swift</p>
  1054. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">RetryPolicy</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
  1055. </div>
  1056. </div>
  1057. </section>
  1058. </div>
  1059. </li>
  1060. </ul>
  1061. </div>
  1062. <div class="task-group">
  1063. <ul class="item-container">
  1064. <li class="item">
  1065. <div>
  1066. <code>
  1067. <a name="/s:9Alamofire25ConnectionLostRetryPolicyC"></a>
  1068. <a name="//apple_ref/swift/Class/ConnectionLostRetryPolicy" class="dashAnchor"></a>
  1069. <a class="token" href="#/s:9Alamofire25ConnectionLostRetryPolicyC">ConnectionLostRetryPolicy</a>
  1070. </code>
  1071. </div>
  1072. <div class="height-container">
  1073. <div class="pointer-container"></div>
  1074. <section class="section">
  1075. <div class="pointer"></div>
  1076. <div class="abstract">
  1077. <p>A retry policy that automatically retries idempotent requests for network connection lost errors. For more
  1078. information about retrying network connection lost errors, please refer to Apple&rsquo;s
  1079. <a href="https://developer.apple.com/library/content/qa/qa1941/_index.html">technical document</a>.</p>
  1080. <a href="Classes/ConnectionLostRetryPolicy.html" class="slightly-smaller">See more</a>
  1081. </div>
  1082. <div class="declaration">
  1083. <h4>Declaration</h4>
  1084. <div class="language">
  1085. <p class="aside-title">Swift</p>
  1086. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ConnectionLostRetryPolicy</span> <span class="p">:</span> <span class="kt"><a href="Classes/RetryPolicy.html">RetryPolicy</a></span></code></pre>
  1087. </div>
  1088. </div>
  1089. </section>
  1090. </div>
  1091. </li>
  1092. </ul>
  1093. </div>
  1094. <div class="task-group">
  1095. <ul class="item-container">
  1096. <li class="item">
  1097. <div>
  1098. <code>
  1099. <a name="/s:9Alamofire18ServerTrustManagerC"></a>
  1100. <a name="//apple_ref/swift/Class/ServerTrustManager" class="dashAnchor"></a>
  1101. <a class="token" href="#/s:9Alamofire18ServerTrustManagerC">ServerTrustManager</a>
  1102. </code>
  1103. </div>
  1104. <div class="height-container">
  1105. <div class="pointer-container"></div>
  1106. <section class="section">
  1107. <div class="pointer"></div>
  1108. <div class="abstract">
  1109. <p>Responsible for managing the mapping of <code><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></code> values to given hosts.</p>
  1110. <a href="Classes/ServerTrustManager.html" class="slightly-smaller">See more</a>
  1111. </div>
  1112. <div class="declaration">
  1113. <h4>Declaration</h4>
  1114. <div class="language">
  1115. <p class="aside-title">Swift</p>
  1116. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">ServerTrustManager</span></code></pre>
  1117. </div>
  1118. </div>
  1119. </section>
  1120. </div>
  1121. </li>
  1122. </ul>
  1123. </div>
  1124. <div class="task-group">
  1125. <div class="task-name-container">
  1126. <a name="/Server%20Trust%20Evaluators"></a>
  1127. <a name="//apple_ref/swift/Section/Server Trust Evaluators" class="dashAnchor"></a>
  1128. <a href="#/Server%20Trust%20Evaluators">
  1129. <h3 class="section-name">Server Trust Evaluators</h3>
  1130. </a>
  1131. </div>
  1132. <ul class="item-container">
  1133. <li class="item">
  1134. <div>
  1135. <code>
  1136. <a name="/s:9Alamofire21DefaultTrustEvaluatorC"></a>
  1137. <a name="//apple_ref/swift/Class/DefaultTrustEvaluator" class="dashAnchor"></a>
  1138. <a class="token" href="#/s:9Alamofire21DefaultTrustEvaluatorC">DefaultTrustEvaluator</a>
  1139. </code>
  1140. </div>
  1141. <div class="height-container">
  1142. <div class="pointer-container"></div>
  1143. <section class="section">
  1144. <div class="pointer"></div>
  1145. <div class="abstract">
  1146. <p>An evaluator which uses the default server trust evaluation while allowing you to control whether to validate the
  1147. host provided by the challenge. Applications are encouraged to always validate the host in production environments
  1148. to guarantee the validity of the server&rsquo;s certificate chain.</p>
  1149. <a href="Classes/DefaultTrustEvaluator.html" class="slightly-smaller">See more</a>
  1150. </div>
  1151. <div class="declaration">
  1152. <h4>Declaration</h4>
  1153. <div class="language">
  1154. <p class="aside-title">Swift</p>
  1155. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">DefaultTrustEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1156. </div>
  1157. </div>
  1158. </section>
  1159. </div>
  1160. </li>
  1161. <li class="item">
  1162. <div>
  1163. <code>
  1164. <a name="/s:9Alamofire24RevocationTrustEvaluatorC"></a>
  1165. <a name="//apple_ref/swift/Class/RevocationTrustEvaluator" class="dashAnchor"></a>
  1166. <a class="token" href="#/s:9Alamofire24RevocationTrustEvaluatorC">RevocationTrustEvaluator</a>
  1167. </code>
  1168. </div>
  1169. <div class="height-container">
  1170. <div class="pointer-container"></div>
  1171. <section class="section">
  1172. <div class="pointer"></div>
  1173. <div class="abstract">
  1174. <p>An evaluator which Uses the default and revoked server trust evaluations allowing you to control whether to validate
  1175. the host provided by the challenge as well as specify the revocation flags for testing for revoked certificates.
  1176. Apple platforms did not start testing for revoked certificates automatically until iOS 10.1, macOS 10.12 and tvOS
  1177. 10.1 which is demonstrated in our TLS tests. Applications are encouraged to always validate the host in production
  1178. environments to guarantee the validity of the server&rsquo;s certificate chain.</p>
  1179. <a href="Classes/RevocationTrustEvaluator.html" class="slightly-smaller">See more</a>
  1180. </div>
  1181. <div class="declaration">
  1182. <h4>Declaration</h4>
  1183. <div class="language">
  1184. <p class="aside-title">Swift</p>
  1185. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">RevocationTrustEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1186. </div>
  1187. </div>
  1188. </section>
  1189. </div>
  1190. </li>
  1191. <li class="item">
  1192. <div>
  1193. <code>
  1194. <a name="/s:9Alamofire32PinnedCertificatesTrustEvaluatorC"></a>
  1195. <a name="//apple_ref/swift/Class/PinnedCertificatesTrustEvaluator" class="dashAnchor"></a>
  1196. <a class="token" href="#/s:9Alamofire32PinnedCertificatesTrustEvaluatorC">PinnedCertificatesTrustEvaluator</a>
  1197. </code>
  1198. </div>
  1199. <div class="height-container">
  1200. <div class="pointer-container"></div>
  1201. <section class="section">
  1202. <div class="pointer"></div>
  1203. <div class="abstract">
  1204. <p>Uses the pinned certificates to validate the server trust. The server trust is considered valid if one of the pinned
  1205. certificates match one of the server certificates. By validating both the certificate chain and host, certificate
  1206. pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks.
  1207. Applications are encouraged to always validate the host and require a valid certificate chain in production
  1208. environments.</p>
  1209. <a href="Classes/PinnedCertificatesTrustEvaluator.html" class="slightly-smaller">See more</a>
  1210. </div>
  1211. <div class="declaration">
  1212. <h4>Declaration</h4>
  1213. <div class="language">
  1214. <p class="aside-title">Swift</p>
  1215. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">PinnedCertificatesTrustEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1216. </div>
  1217. </div>
  1218. </section>
  1219. </div>
  1220. </li>
  1221. <li class="item">
  1222. <div>
  1223. <code>
  1224. <a name="/s:9Alamofire24PublicKeysTrustEvaluatorC"></a>
  1225. <a name="//apple_ref/swift/Class/PublicKeysTrustEvaluator" class="dashAnchor"></a>
  1226. <a class="token" href="#/s:9Alamofire24PublicKeysTrustEvaluatorC">PublicKeysTrustEvaluator</a>
  1227. </code>
  1228. </div>
  1229. <div class="height-container">
  1230. <div class="pointer-container"></div>
  1231. <section class="section">
  1232. <div class="pointer"></div>
  1233. <div class="abstract">
  1234. <p>Uses the pinned public keys to validate the server trust. The server trust is considered valid if one of the pinned
  1235. public keys match one of the server certificate public keys. By validating both the certificate chain and host,
  1236. public key pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks.
  1237. Applications are encouraged to always validate the host and require a valid certificate chain in production
  1238. environments.</p>
  1239. <a href="Classes/PublicKeysTrustEvaluator.html" class="slightly-smaller">See more</a>
  1240. </div>
  1241. <div class="declaration">
  1242. <h4>Declaration</h4>
  1243. <div class="language">
  1244. <p class="aside-title">Swift</p>
  1245. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">PublicKeysTrustEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1246. </div>
  1247. </div>
  1248. </section>
  1249. </div>
  1250. </li>
  1251. <li class="item">
  1252. <div>
  1253. <code>
  1254. <a name="/s:9Alamofire23CompositeTrustEvaluatorC"></a>
  1255. <a name="//apple_ref/swift/Class/CompositeTrustEvaluator" class="dashAnchor"></a>
  1256. <a class="token" href="#/s:9Alamofire23CompositeTrustEvaluatorC">CompositeTrustEvaluator</a>
  1257. </code>
  1258. </div>
  1259. <div class="height-container">
  1260. <div class="pointer-container"></div>
  1261. <section class="section">
  1262. <div class="pointer"></div>
  1263. <div class="abstract">
  1264. <p>Uses the provided evaluators to validate the server trust. The trust is only considered valid if all of the
  1265. evaluators consider it valid.</p>
  1266. <a href="Classes/CompositeTrustEvaluator.html" class="slightly-smaller">See more</a>
  1267. </div>
  1268. <div class="declaration">
  1269. <h4>Declaration</h4>
  1270. <div class="language">
  1271. <p class="aside-title">Swift</p>
  1272. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CompositeTrustEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1273. </div>
  1274. </div>
  1275. </section>
  1276. </div>
  1277. </li>
  1278. <li class="item">
  1279. <div>
  1280. <code>
  1281. <a name="/s:9Alamofire17DisabledEvaluatorC"></a>
  1282. <a name="//apple_ref/swift/Class/DisabledEvaluator" class="dashAnchor"></a>
  1283. <a class="token" href="#/s:9Alamofire17DisabledEvaluatorC">DisabledEvaluator</a>
  1284. </code>
  1285. </div>
  1286. <div class="height-container">
  1287. <div class="pointer-container"></div>
  1288. <section class="section">
  1289. <div class="pointer"></div>
  1290. <div class="abstract">
  1291. <p>Disables all evaluation which in turn will always consider any server trust as valid.</p>
  1292. <p>THIS EVALUATOR SHOULD NEVER BE USED IN PRODUCTION!</p>
  1293. <a href="Classes/DisabledEvaluator.html" class="slightly-smaller">See more</a>
  1294. </div>
  1295. <div class="declaration">
  1296. <h4>Declaration</h4>
  1297. <div class="language">
  1298. <p class="aside-title">Swift</p>
  1299. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">DisabledEvaluator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a></span></code></pre>
  1300. </div>
  1301. </div>
  1302. </section>
  1303. </div>
  1304. </li>
  1305. </ul>
  1306. </div>
  1307. <div class="task-group">
  1308. <ul class="item-container">
  1309. <li class="item">
  1310. <div>
  1311. <code>
  1312. <a name="/s:9Alamofire7SessionC"></a>
  1313. <a name="//apple_ref/swift/Class/Session" class="dashAnchor"></a>
  1314. <a class="token" href="#/s:9Alamofire7SessionC">Session</a>
  1315. </code>
  1316. </div>
  1317. <div class="height-container">
  1318. <div class="pointer-container"></div>
  1319. <section class="section">
  1320. <div class="pointer"></div>
  1321. <div class="abstract">
  1322. <p>Undocumented</p>
  1323. <a href="Classes/Session.html" class="slightly-smaller">See more</a>
  1324. </div>
  1325. <div class="declaration">
  1326. <h4>Declaration</h4>
  1327. <div class="language">
  1328. <p class="aside-title">Swift</p>
  1329. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Session</span></code></pre>
  1330. </div>
  1331. </div>
  1332. </section>
  1333. </div>
  1334. </li>
  1335. </ul>
  1336. </div>
  1337. <div class="task-group">
  1338. <ul class="item-container">
  1339. <li class="item">
  1340. <div>
  1341. <code>
  1342. <a name="/c:@M@Alamofire@objc(cs)SessionDelegate"></a>
  1343. <a name="//apple_ref/swift/Class/SessionDelegate" class="dashAnchor"></a>
  1344. <a class="token" href="#/c:@M@Alamofire@objc(cs)SessionDelegate">SessionDelegate</a>
  1345. </code>
  1346. </div>
  1347. <div class="height-container">
  1348. <div class="pointer-container"></div>
  1349. <section class="section">
  1350. <div class="pointer"></div>
  1351. <div class="abstract">
  1352. <p>Undocumented</p>
  1353. <a href="Classes/SessionDelegate.html" class="slightly-smaller">See more</a>
  1354. </div>
  1355. <div class="declaration">
  1356. <h4>Declaration</h4>
  1357. <div class="language">
  1358. <p class="aside-title">Swift</p>
  1359. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SessionDelegate</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
  1360. </div>
  1361. </div>
  1362. </section>
  1363. </div>
  1364. </li>
  1365. </ul>
  1366. </div>
  1367. </div>
  1368. </section>
  1369. </article>
  1370. </div>
  1371. <section class="footer">
  1372. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-12)</p>
  1373. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1374. </section>
  1375. </body>
  1376. </div>
  1377. </html>