2
0

Structs.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907
  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. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%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/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</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/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="Global%20Variables.html">Global Variables</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  192. </li>
  193. </ul>
  194. </li>
  195. <li class="nav-group-name">
  196. <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
  197. <ul class="nav-group-tasks">
  198. <li class="nav-group-task">
  199. <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
  200. </li>
  201. <li class="nav-group-task">
  202. <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  203. </li>
  204. <li class="nav-group-task">
  205. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  206. </li>
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="Enums/RetryResult.html">RetryResult</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="Extensions/CharacterSet.html">CharacterSet</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="Extensions/Error.html">Error</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="Extensions.html#/c:@T@OSStatus">OSStatus</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="Extensions/String.html">String</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  280. </li>
  281. </ul>
  282. </li>
  283. <li class="nav-group-name">
  284. <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
  285. <ul class="nav-group-tasks">
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="Protocols/AlamofireExtended.html">AlamofireExtended</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="Protocols/DataDecoder.html">DataDecoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="Protocols/DataPreprocessor.html">DataPreprocessor</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="Protocols/EmptyResponse.html">EmptyResponse</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="Protocols/EventMonitor.html">EventMonitor</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="Protocols/ParameterEncoder.html">ParameterEncoder</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="Protocols/RedirectHandler.html">RedirectHandler</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="Protocols/RequestDelegate.html">RequestDelegate</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="Protocols/RequestInterceptor.html">RequestInterceptor</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="Protocols/ResponseSerializer.html">ResponseSerializer</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="Protocols/UploadableConvertible.html">UploadableConvertible</a>
  348. </li>
  349. </ul>
  350. </li>
  351. <li class="nav-group-name">
  352. <a class="nav-group-name-link" href="Structs.html">Structures</a>
  353. <ul class="nav-group-tasks">
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="Structs/AlamofireExtension.html">AlamofireExtension</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="Structs/Empty.html">Empty</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="Structs/HTTPHeader.html">HTTPHeader</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="Structs/HTTPHeaders.html">HTTPHeaders</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="Structs/HTTPMethod.html">HTTPMethod</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="Structs/Redirector.html">Redirector</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="Structs/Redirector/Behavior.html">– Behavior</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="Structs/ResponseCacher.html">ResponseCacher</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="Structs/ResponseCacher/Behavior.html">– Behavior</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  407. </li>
  408. </ul>
  409. </li>
  410. <li class="nav-group-name">
  411. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  412. <ul class="nav-group-tasks">
  413. <li class="nav-group-task">
  414. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  415. </li>
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  430. </li>
  431. </ul>
  432. </li>
  433. </ul>
  434. </nav>
  435. <article class="main-content">
  436. <section class="section">
  437. <div class="section-content top-matter">
  438. <h1>Structures</h1>
  439. <p>The following structures are available globally.</p>
  440. </div>
  441. </section>
  442. <section class="section">
  443. <div class="section-content">
  444. <div class="task-group">
  445. <ul class="item-container">
  446. <li class="item">
  447. <div>
  448. <code>
  449. <a name="/s:9Alamofire0A9ExtensionV"></a>
  450. <a name="//apple_ref/swift/Struct/AlamofireExtension" class="dashAnchor"></a>
  451. <a class="token" href="#/s:9Alamofire0A9ExtensionV">AlamofireExtension</a>
  452. </code>
  453. </div>
  454. <div class="height-container">
  455. <div class="pointer-container"></div>
  456. <section class="section">
  457. <div class="pointer"></div>
  458. <div class="abstract">
  459. <p>Type that acts as a generic extension point for all <code><a href="Protocols/AlamofireExtended.html">AlamofireExtended</a></code> types.</p>
  460. <a href="Structs/AlamofireExtension.html" class="slightly-smaller">See more</a>
  461. </div>
  462. <div class="declaration">
  463. <h4>Declaration</h4>
  464. <div class="language">
  465. <p class="aside-title">Swift</p>
  466. <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>
  467. </div>
  468. </div>
  469. </section>
  470. </div>
  471. </li>
  472. <li class="item">
  473. <div>
  474. <code>
  475. <a name="/s:9Alamofire14ResponseCacherV"></a>
  476. <a name="//apple_ref/swift/Struct/ResponseCacher" class="dashAnchor"></a>
  477. <a class="token" href="#/s:9Alamofire14ResponseCacherV">ResponseCacher</a>
  478. </code>
  479. </div>
  480. <div class="height-container">
  481. <div class="pointer-container"></div>
  482. <section class="section">
  483. <div class="pointer"></div>
  484. <div class="abstract">
  485. <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
  486. response.</p>
  487. <a href="Structs/ResponseCacher.html" class="slightly-smaller">See more</a>
  488. </div>
  489. <div class="declaration">
  490. <h4>Declaration</h4>
  491. <div class="language">
  492. <p class="aside-title">Swift</p>
  493. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ResponseCacher</span></code></pre>
  494. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ResponseCacher</span><span class="p">:</span> <span class="kt"><a href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span></code></pre>
  495. </div>
  496. </div>
  497. </section>
  498. </div>
  499. </li>
  500. <li class="item">
  501. <div>
  502. <code>
  503. <a name="/s:9Alamofire11HTTPHeadersV"></a>
  504. <a name="//apple_ref/swift/Struct/HTTPHeaders" class="dashAnchor"></a>
  505. <a class="token" href="#/s:9Alamofire11HTTPHeadersV">HTTPHeaders</a>
  506. </code>
  507. </div>
  508. <div class="height-container">
  509. <div class="pointer-container"></div>
  510. <section class="section">
  511. <div class="pointer"></div>
  512. <div class="abstract">
  513. <p>An order-preserving and case-insensitive representation of HTTP headers.</p>
  514. <a href="Structs/HTTPHeaders.html" class="slightly-smaller">See more</a>
  515. </div>
  516. <div class="declaration">
  517. <h4>Declaration</h4>
  518. <div class="language">
  519. <p class="aside-title">Swift</p>
  520. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeaders</span></code></pre>
  521. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByDictionaryLiteral</span></code></pre>
  522. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByArrayLiteral</span></code></pre>
  523. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
  524. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Collection</span></code></pre>
  525. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  526. </div>
  527. </div>
  528. </section>
  529. </div>
  530. </li>
  531. </ul>
  532. </div>
  533. <div class="task-group">
  534. <div class="task-name-container">
  535. <a name="/HTTPHeader"></a>
  536. <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
  537. <div class="section-name-container">
  538. <a class="section-name-link" href="#/HTTPHeader"></a>
  539. <h3 class="section-name"><p>HTTPHeader</p>
  540. </h3>
  541. </div>
  542. </div>
  543. <ul class="item-container">
  544. <li class="item">
  545. <div>
  546. <code>
  547. <a name="/s:9Alamofire10HTTPHeaderV"></a>
  548. <a name="//apple_ref/swift/Struct/HTTPHeader" class="dashAnchor"></a>
  549. <a class="token" href="#/s:9Alamofire10HTTPHeaderV">HTTPHeader</a>
  550. </code>
  551. </div>
  552. <div class="height-container">
  553. <div class="pointer-container"></div>
  554. <section class="section">
  555. <div class="pointer"></div>
  556. <div class="abstract">
  557. <p>A representation of a single HTTP header&rsquo;s name / value pair.</p>
  558. <a href="Structs/HTTPHeader.html" class="slightly-smaller">See more</a>
  559. </div>
  560. <div class="declaration">
  561. <h4>Declaration</h4>
  562. <div class="language">
  563. <p class="aside-title">Swift</p>
  564. <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>
  565. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeader</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  566. </div>
  567. </div>
  568. </section>
  569. </div>
  570. </li>
  571. <li class="item">
  572. <div>
  573. <code>
  574. <a name="/s:9Alamofire10HTTPMethodV"></a>
  575. <a name="//apple_ref/swift/Struct/HTTPMethod" class="dashAnchor"></a>
  576. <a class="token" href="#/s:9Alamofire10HTTPMethodV">HTTPMethod</a>
  577. </code>
  578. </div>
  579. <div class="height-container">
  580. <div class="pointer-container"></div>
  581. <section class="section">
  582. <div class="pointer"></div>
  583. <div class="abstract">
  584. <p>Type representing HTTP methods. Raw <code>String</code> value is stored and compared case-sensitively, so
  585. <code>HTTPMethod.get != HTTPMethod(rawValue: &quot;get&quot;)</code>.</p>
  586. <p>See <a href="https://tools.ietf.org/html/rfc7231#section-4.3">https://tools.ietf.org/html/rfc7231#section-4.3</a></p>
  587. <a href="Structs/HTTPMethod.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">HTTPMethod</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</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:9Alamofire11URLEncodingV"></a>
  607. <a name="//apple_ref/swift/Struct/URLEncoding" class="dashAnchor"></a>
  608. <a class="token" href="#/s:9Alamofire11URLEncodingV">URLEncoding</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>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
  617. body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
  618. the HTTP body depends on the destination of the encoding.</p>
  619. <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
  620. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  621. <p>There is no published specification for how to encode collection types. By default the convention of appending
  622. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  623. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  624. square brackets appended to array keys.</p>
  625. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  626. <code>true</code> as 1 and <code>false</code> as 0.</p>
  627. <a href="Structs/URLEncoding.html" class="slightly-smaller">See more</a>
  628. </div>
  629. <div class="declaration">
  630. <h4>Declaration</h4>
  631. <div class="language">
  632. <p class="aside-title">Swift</p>
  633. <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>
  634. </div>
  635. </div>
  636. </section>
  637. </div>
  638. </li>
  639. <li class="item">
  640. <div>
  641. <code>
  642. <a name="/s:9Alamofire12JSONEncodingV"></a>
  643. <a name="//apple_ref/swift/Struct/JSONEncoding" class="dashAnchor"></a>
  644. <a class="token" href="#/s:9Alamofire12JSONEncodingV">JSONEncoding</a>
  645. </code>
  646. </div>
  647. <div class="height-container">
  648. <div class="pointer-container"></div>
  649. <section class="section">
  650. <div class="pointer"></div>
  651. <div class="abstract">
  652. <p>Uses <code>JSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the
  653. request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
  654. <a href="Structs/JSONEncoding.html" class="slightly-smaller">See more</a>
  655. </div>
  656. <div class="declaration">
  657. <h4>Declaration</h4>
  658. <div class="language">
  659. <p class="aside-title">Swift</p>
  660. <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>
  661. </div>
  662. </div>
  663. </section>
  664. </div>
  665. </li>
  666. <li class="item">
  667. <div>
  668. <code>
  669. <a name="/s:9Alamofire10RedirectorV"></a>
  670. <a name="//apple_ref/swift/Struct/Redirector" class="dashAnchor"></a>
  671. <a class="token" href="#/s:9Alamofire10RedirectorV">Redirector</a>
  672. </code>
  673. </div>
  674. <div class="height-container">
  675. <div class="pointer-container"></div>
  676. <section class="section">
  677. <div class="pointer"></div>
  678. <div class="abstract">
  679. <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>
  680. <a href="Structs/Redirector.html" class="slightly-smaller">See more</a>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Redirector</span></code></pre>
  687. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Redirector</span><span class="p">:</span> <span class="kt"><a href="Protocols/RedirectHandler.html">RedirectHandler</a></span></code></pre>
  688. </div>
  689. </div>
  690. </section>
  691. </div>
  692. </li>
  693. <li class="item">
  694. <div>
  695. <code>
  696. <a name="/s:9Alamofire12DataResponseV"></a>
  697. <a name="//apple_ref/swift/Struct/DataResponse" class="dashAnchor"></a>
  698. <a class="token" href="#/s:9Alamofire12DataResponseV">DataResponse</a>
  699. </code>
  700. </div>
  701. <div class="height-container">
  702. <div class="pointer-container"></div>
  703. <section class="section">
  704. <div class="pointer"></div>
  705. <div class="abstract">
  706. <p>Type used to store all values associated with a serialized response of a <code><a href="Classes/DataRequest.html">DataRequest</a></code> or <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  707. <a href="Structs/DataResponse.html" class="slightly-smaller">See more</a>
  708. </div>
  709. <div class="declaration">
  710. <h4>Declaration</h4>
  711. <div class="language">
  712. <p class="aside-title">Swift</p>
  713. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponse</span><span class="o">&lt;</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  714. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DataResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
  715. </div>
  716. </div>
  717. </section>
  718. </div>
  719. </li>
  720. <li class="item">
  721. <div>
  722. <code>
  723. <a name="/s:9Alamofire16DownloadResponseV"></a>
  724. <a name="//apple_ref/swift/Struct/DownloadResponse" class="dashAnchor"></a>
  725. <a class="token" href="#/s:9Alamofire16DownloadResponseV">DownloadResponse</a>
  726. </code>
  727. </div>
  728. <div class="height-container">
  729. <div class="pointer-container"></div>
  730. <section class="section">
  731. <div class="pointer"></div>
  732. <div class="abstract">
  733. <p>Used to store all data associated with a serialized response of a download request.</p>
  734. <a href="Structs/DownloadResponse.html" class="slightly-smaller">See more</a>
  735. </div>
  736. <div class="declaration">
  737. <h4>Declaration</h4>
  738. <div class="language">
  739. <p class="aside-title">Swift</p>
  740. <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">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  741. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DownloadResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
  742. </div>
  743. </div>
  744. </section>
  745. </div>
  746. </li>
  747. </ul>
  748. </div>
  749. <div class="task-group">
  750. <div class="task-name-container">
  751. <a name="/Protocols"></a>
  752. <a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
  753. <div class="section-name-container">
  754. <a class="section-name-link" href="#/Protocols"></a>
  755. <h3 class="section-name"><p>Protocols</p>
  756. </h3>
  757. </div>
  758. </div>
  759. <ul class="item-container">
  760. <li class="item">
  761. <div>
  762. <code>
  763. <a name="/s:9Alamofire23PassthroughPreprocessorV"></a>
  764. <a name="//apple_ref/swift/Struct/PassthroughPreprocessor" class="dashAnchor"></a>
  765. <a class="token" href="#/s:9Alamofire23PassthroughPreprocessorV">PassthroughPreprocessor</a>
  766. </code>
  767. </div>
  768. <div class="height-container">
  769. <div class="pointer-container"></div>
  770. <section class="section">
  771. <div class="pointer"></div>
  772. <div class="abstract">
  773. <p><code><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></code> that returns passed <code>Data</code> without any transform.</p>
  774. <a href="Structs/PassthroughPreprocessor.html" class="slightly-smaller">See more</a>
  775. </div>
  776. <div class="declaration">
  777. <h4>Declaration</h4>
  778. <div class="language">
  779. <p class="aside-title">Swift</p>
  780. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PassthroughPreprocessor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></span></code></pre>
  781. </div>
  782. </div>
  783. </section>
  784. </div>
  785. </li>
  786. <li class="item">
  787. <div>
  788. <code>
  789. <a name="/s:9Alamofire22GoogleXSSIPreprocessorV"></a>
  790. <a name="//apple_ref/swift/Struct/GoogleXSSIPreprocessor" class="dashAnchor"></a>
  791. <a class="token" href="#/s:9Alamofire22GoogleXSSIPreprocessorV">GoogleXSSIPreprocessor</a>
  792. </code>
  793. </div>
  794. <div class="height-container">
  795. <div class="pointer-container"></div>
  796. <section class="section">
  797. <div class="pointer"></div>
  798. <div class="abstract">
  799. <p><code><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></code> that trims Google&rsquo;s typical <code>)]}&#39;,\n</code> XSSI JSON header.</p>
  800. <a href="Structs/GoogleXSSIPreprocessor.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">struct</span> <span class="kt">GoogleXSSIPreprocessor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataPreprocessor.html">DataPreprocessor</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="/Empty"></a>
  817. <a name="//apple_ref/swift/Section/Empty" class="dashAnchor"></a>
  818. <div class="section-name-container">
  819. <a class="section-name-link" href="#/Empty"></a>
  820. <h3 class="section-name"><p>Empty</p>
  821. </h3>
  822. </div>
  823. </div>
  824. <ul class="item-container">
  825. <li class="item">
  826. <div>
  827. <code>
  828. <a name="/s:9Alamofire5EmptyV"></a>
  829. <a name="//apple_ref/swift/Struct/Empty" class="dashAnchor"></a>
  830. <a class="token" href="#/s:9Alamofire5EmptyV">Empty</a>
  831. </code>
  832. </div>
  833. <div class="height-container">
  834. <div class="pointer-container"></div>
  835. <section class="section">
  836. <div class="pointer"></div>
  837. <div class="abstract">
  838. <p>Type representing an empty response. Use <code><a href="Structs/Empty.html#/s:9Alamofire5EmptyV5valueACvpZ">Empty.value</a></code> to get the static instance.</p>
  839. <a href="Structs/Empty.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">struct</span> <span class="kt">Empty</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
  846. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Empty</span><span class="p">:</span> <span class="kt"><a href="Protocols/EmptyResponse.html">EmptyResponse</a></span></code></pre>
  847. </div>
  848. </div>
  849. </section>
  850. </div>
  851. </li>
  852. </ul>
  853. </div>
  854. </div>
  855. </section>
  856. </article>
  857. </div>
  858. <section class="footer">
  859. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-02-23)</p>
  860. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  861. </section>
  862. </body>
  863. </div>
  864. </html>