Classes.html 68 KB

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