Structs.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Structures 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/Structures" class="dashAnchor"></a>
  16. <a title="Structures 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. Structures 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>Structures</h1>
  397. <p>The following structures 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:9Alamofire0A9ExtensionV"></a>
  408. <a name="//apple_ref/swift/Struct/AlamofireExtension" class="dashAnchor"></a>
  409. <a class="token" href="#/s:9Alamofire0A9ExtensionV">AlamofireExtension</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>Type that acts as a generic extension point for all <code><a href="Protocols/AlamofireExtended.html">AlamofireExtended</a></code> types.</p>
  418. <a href="Structs/AlamofireExtension.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">struct</span> <span class="kt">AlamofireExtension</span><span class="o">&lt;</span><span class="kt">ExtendedType</span><span class="o">&gt;</span></code></pre>
  425. </div>
  426. </div>
  427. </section>
  428. </div>
  429. </li>
  430. </ul>
  431. </div>
  432. <div class="task-group">
  433. <ul class="item-container">
  434. <li class="item">
  435. <div>
  436. <code>
  437. <a name="/s:9Alamofire14ResponseCacherV"></a>
  438. <a name="//apple_ref/swift/Struct/ResponseCacher" class="dashAnchor"></a>
  439. <a class="token" href="#/s:9Alamofire14ResponseCacherV">ResponseCacher</a>
  440. </code>
  441. </div>
  442. <div class="height-container">
  443. <div class="pointer-container"></div>
  444. <section class="section">
  445. <div class="pointer"></div>
  446. <div class="abstract">
  447. <p><code>ResponseCacher</code> is a convenience <code><a href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> making it easy to cache, not cache, or modify a cached
  448. response.</p>
  449. <a href="Structs/ResponseCacher.html" class="slightly-smaller">See more</a>
  450. </div>
  451. <div class="declaration">
  452. <h4>Declaration</h4>
  453. <div class="language">
  454. <p class="aside-title">Swift</p>
  455. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ResponseCacher</span></code></pre>
  456. </div>
  457. </div>
  458. </section>
  459. </div>
  460. </li>
  461. </ul>
  462. </div>
  463. <div class="task-group">
  464. <ul class="item-container">
  465. <li class="item">
  466. <div>
  467. <code>
  468. <a name="/s:9Alamofire11HTTPHeadersV"></a>
  469. <a name="//apple_ref/swift/Struct/HTTPHeaders" class="dashAnchor"></a>
  470. <a class="token" href="#/s:9Alamofire11HTTPHeadersV">HTTPHeaders</a>
  471. </code>
  472. </div>
  473. <div class="height-container">
  474. <div class="pointer-container"></div>
  475. <section class="section">
  476. <div class="pointer"></div>
  477. <div class="abstract">
  478. <p>An order-preserving and case-insensitive representation of HTTP headers.</p>
  479. <a href="Structs/HTTPHeaders.html" class="slightly-smaller">See more</a>
  480. </div>
  481. <div class="declaration">
  482. <h4>Declaration</h4>
  483. <div class="language">
  484. <p class="aside-title">Swift</p>
  485. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeaders</span></code></pre>
  486. </div>
  487. </div>
  488. </section>
  489. </div>
  490. </li>
  491. </ul>
  492. </div>
  493. <div class="task-group">
  494. <div class="task-name-container">
  495. <a name="/HTTPHeader"></a>
  496. <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
  497. <a href="#/HTTPHeader">
  498. <h3 class="section-name">HTTPHeader</h3>
  499. </a>
  500. </div>
  501. <ul class="item-container">
  502. <li class="item">
  503. <div>
  504. <code>
  505. <a name="/s:9Alamofire10HTTPHeaderV"></a>
  506. <a name="//apple_ref/swift/Struct/HTTPHeader" class="dashAnchor"></a>
  507. <a class="token" href="#/s:9Alamofire10HTTPHeaderV">HTTPHeader</a>
  508. </code>
  509. </div>
  510. <div class="height-container">
  511. <div class="pointer-container"></div>
  512. <section class="section">
  513. <div class="pointer"></div>
  514. <div class="abstract">
  515. <p>A representation of a single HTTP header&rsquo;s name / value pair.</p>
  516. <a href="Structs/HTTPHeader.html" class="slightly-smaller">See more</a>
  517. </div>
  518. <div class="declaration">
  519. <h4>Declaration</h4>
  520. <div class="language">
  521. <p class="aside-title">Swift</p>
  522. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeader</span> <span class="p">:</span> <span class="kt">Hashable</span></code></pre>
  523. </div>
  524. </div>
  525. </section>
  526. </div>
  527. </li>
  528. </ul>
  529. </div>
  530. <div class="task-group">
  531. <ul class="item-container">
  532. <li class="item">
  533. <div>
  534. <code>
  535. <a name="/s:9Alamofire11URLEncodingV"></a>
  536. <a name="//apple_ref/swift/Struct/URLEncoding" class="dashAnchor"></a>
  537. <a class="token" href="#/s:9Alamofire11URLEncodingV">URLEncoding</a>
  538. </code>
  539. </div>
  540. <div class="height-container">
  541. <div class="pointer-container"></div>
  542. <section class="section">
  543. <div class="pointer"></div>
  544. <div class="abstract">
  545. <p>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
  546. body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
  547. the HTTP body depends on the destination of the encoding.</p>
  548. <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
  549. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  550. <p>There is no published specification for how to encode collection types. By default the convention of appending
  551. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  552. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  553. square brackets appended to array keys.</p>
  554. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  555. <code>true</code> as 1 and <code>false</code> as 0.</p>
  556. <a href="Structs/URLEncoding.html" class="slightly-smaller">See more</a>
  557. </div>
  558. <div class="declaration">
  559. <h4>Declaration</h4>
  560. <div class="language">
  561. <p class="aside-title">Swift</p>
  562. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">URLEncoding</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
  563. </div>
  564. </div>
  565. </section>
  566. </div>
  567. </li>
  568. </ul>
  569. </div>
  570. <div class="task-group">
  571. <ul class="item-container">
  572. <li class="item">
  573. <div>
  574. <code>
  575. <a name="/s:9Alamofire12JSONEncodingV"></a>
  576. <a name="//apple_ref/swift/Struct/JSONEncoding" class="dashAnchor"></a>
  577. <a class="token" href="#/s:9Alamofire12JSONEncodingV">JSONEncoding</a>
  578. </code>
  579. </div>
  580. <div class="height-container">
  581. <div class="pointer-container"></div>
  582. <section class="section">
  583. <div class="pointer"></div>
  584. <div class="abstract">
  585. <p>Uses <code>JSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the
  586. request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
  587. <a href="Structs/JSONEncoding.html" class="slightly-smaller">See more</a>
  588. </div>
  589. <div class="declaration">
  590. <h4>Declaration</h4>
  591. <div class="language">
  592. <p class="aside-title">Swift</p>
  593. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">JSONEncoding</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
  594. </div>
  595. </div>
  596. </section>
  597. </div>
  598. </li>
  599. </ul>
  600. </div>
  601. <div class="task-group">
  602. <ul class="item-container">
  603. <li class="item">
  604. <div>
  605. <code>
  606. <a name="/s:9Alamofire10RedirectorV"></a>
  607. <a name="//apple_ref/swift/Struct/Redirector" class="dashAnchor"></a>
  608. <a class="token" href="#/s:9Alamofire10RedirectorV">Redirector</a>
  609. </code>
  610. </div>
  611. <div class="height-container">
  612. <div class="pointer-container"></div>
  613. <section class="section">
  614. <div class="pointer"></div>
  615. <div class="abstract">
  616. <p><code>Redirector</code> is a convenience <code><a href="Protocols/RedirectHandler.html">RedirectHandler</a></code> making it easy to follow, not follow, or modify a redirect.</p>
  617. <a href="Structs/Redirector.html" class="slightly-smaller">See more</a>
  618. </div>
  619. <div class="declaration">
  620. <h4>Declaration</h4>
  621. <div class="language">
  622. <p class="aside-title">Swift</p>
  623. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Redirector</span></code></pre>
  624. </div>
  625. </div>
  626. </section>
  627. </div>
  628. </li>
  629. </ul>
  630. </div>
  631. <div class="task-group">
  632. <ul class="item-container">
  633. <li class="item">
  634. <div>
  635. <code>
  636. <a name="/s:9Alamofire12DataResponseV"></a>
  637. <a name="//apple_ref/swift/Struct/DataResponse" class="dashAnchor"></a>
  638. <a class="token" href="#/s:9Alamofire12DataResponseV">DataResponse</a>
  639. </code>
  640. </div>
  641. <div class="height-container">
  642. <div class="pointer-container"></div>
  643. <section class="section">
  644. <div class="pointer"></div>
  645. <div class="abstract">
  646. <p>Used to store all data associated with a serialized response of a data or upload request.</p>
  647. <a href="Structs/DataResponse.html" class="slightly-smaller">See more</a>
  648. </div>
  649. <div class="declaration">
  650. <h4>Declaration</h4>
  651. <div class="language">
  652. <p class="aside-title">Swift</p>
  653. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  654. </div>
  655. </div>
  656. </section>
  657. </div>
  658. </li>
  659. </ul>
  660. </div>
  661. <div class="task-group">
  662. <ul class="item-container">
  663. <li class="item">
  664. <div>
  665. <code>
  666. <a name="/s:9Alamofire16DownloadResponseV"></a>
  667. <a name="//apple_ref/swift/Struct/DownloadResponse" class="dashAnchor"></a>
  668. <a class="token" href="#/s:9Alamofire16DownloadResponseV">DownloadResponse</a>
  669. </code>
  670. </div>
  671. <div class="height-container">
  672. <div class="pointer-container"></div>
  673. <section class="section">
  674. <div class="pointer"></div>
  675. <div class="abstract">
  676. <p>Used to store all data associated with a serialized response of a download request.</p>
  677. <a href="Structs/DownloadResponse.html" class="slightly-smaller">See more</a>
  678. </div>
  679. <div class="declaration">
  680. <h4>Declaration</h4>
  681. <div class="language">
  682. <p class="aside-title">Swift</p>
  683. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadResponse</span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  684. </div>
  685. </div>
  686. </section>
  687. </div>
  688. </li>
  689. </ul>
  690. </div>
  691. <div class="task-group">
  692. <div class="task-name-container">
  693. <a name="/Empty"></a>
  694. <a name="//apple_ref/swift/Section/Empty" class="dashAnchor"></a>
  695. <a href="#/Empty">
  696. <h3 class="section-name">Empty</h3>
  697. </a>
  698. </div>
  699. <ul class="item-container">
  700. <li class="item">
  701. <div>
  702. <code>
  703. <a name="/s:9Alamofire5EmptyV"></a>
  704. <a name="//apple_ref/swift/Struct/Empty" class="dashAnchor"></a>
  705. <a class="token" href="#/s:9Alamofire5EmptyV">Empty</a>
  706. </code>
  707. </div>
  708. <div class="height-container">
  709. <div class="pointer-container"></div>
  710. <section class="section">
  711. <div class="pointer"></div>
  712. <div class="abstract">
  713. <p>A type representing an empty response. Use <code><a href="Structs/Empty.html#/s:9Alamofire5EmptyV5valueACvpZ">Empty.value</a></code> to get the instance.</p>
  714. <a href="Structs/Empty.html" class="slightly-smaller">See more</a>
  715. </div>
  716. <div class="declaration">
  717. <h4>Declaration</h4>
  718. <div class="language">
  719. <p class="aside-title">Swift</p>
  720. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Empty</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
  721. </div>
  722. </div>
  723. </section>
  724. </div>
  725. </li>
  726. </ul>
  727. </div>
  728. </div>
  729. </section>
  730. </article>
  731. </div>
  732. <section class="footer">
  733. <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>
  734. <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>
  735. </section>
  736. </body>
  737. </div>
  738. </html>