2
0

Structs.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  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 title="Structures Reference"></a>
  16. <header class="header">
  17. <p class="header-col header-col--primary">
  18. <a class="header-link" href="index.html">
  19. Alamofire Docs
  20. </a>
  21. (86% documented)
  22. </p>
  23. <p class="header-col--secondary">
  24. <form role="search" action="search.json">
  25. <input type="text" placeholder="Search documentation" data-typeahead>
  26. </form>
  27. </p>
  28. <p class="header-col header-col--secondary">
  29. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  30. <img class="header-icon" src="img/gh.png"/>
  31. View on GitHub
  32. </a>
  33. </p>
  34. <p class="header-col header-col--secondary">
  35. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  36. <img class="header-icon" src="img/dash.png"/>
  37. Install in Dash
  38. </a>
  39. </p>
  40. </header>
  41. <p class="breadcrumbs">
  42. <a class="breadcrumb" href="index.html">Alamofire Reference</a>
  43. <img class="carat" src="img/carat.png" />
  44. Structures Reference
  45. </p>
  46. <div class="content-wrapper">
  47. <nav class="navigation">
  48. <ul class="nav-groups">
  49. <li class="nav-group-name">
  50. <a class="nav-group-name-link" href="Classes.html">Classes</a>
  51. <ul class="nav-group-tasks">
  52. <li class="nav-group-task">
  53. <a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
  54. </li>
  55. <li class="nav-group-task">
  56. <a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
  57. </li>
  58. <li class="nav-group-task">
  59. <a class="nav-group-task-link" href="Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  60. </li>
  61. <li class="nav-group-task">
  62. <a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  66. </li>
  67. <li class="nav-group-task">
  68. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  69. </li>
  70. <li class="nav-group-task">
  71. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  72. </li>
  73. <li class="nav-group-task">
  74. <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
  75. </li>
  76. <li class="nav-group-task">
  77. <a class="nav-group-task-link" href="Classes/Request/ValidationResult.html">– ValidationResult</a>
  78. </li>
  79. <li class="nav-group-task">
  80. <a class="nav-group-task-link" href="Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  81. </li>
  82. <li class="nav-group-task">
  83. <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
  84. </li>
  85. <li class="nav-group-task">
  86. <a class="nav-group-task-link" href="Classes/SessionManager.html">SessionManager</a>
  87. </li>
  88. <li class="nav-group-task">
  89. <a class="nav-group-task-link" href="Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  90. </li>
  91. <li class="nav-group-task">
  92. <a class="nav-group-task-link" href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  93. </li>
  94. <li class="nav-group-task">
  95. <a class="nav-group-task-link" href="Classes/TaskDelegate.html">TaskDelegate</a>
  96. </li>
  97. <li class="nav-group-task">
  98. <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
  99. </li>
  100. </ul>
  101. </li>
  102. <li class="nav-group-name">
  103. <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
  104. <ul class="nav-group-tasks">
  105. <li class="nav-group-task">
  106. <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
  107. </li>
  108. <li class="nav-group-task">
  109. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  110. </li>
  111. <li class="nav-group-task">
  112. <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  113. </li>
  114. <li class="nav-group-task">
  115. <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  116. </li>
  117. <li class="nav-group-task">
  118. <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  119. </li>
  120. <li class="nav-group-task">
  121. <a class="nav-group-task-link" href="Enums/HTTPMethod.html">HTTPMethod</a>
  122. </li>
  123. <li class="nav-group-task">
  124. <a class="nav-group-task-link" href="Enums/Result.html">Result</a>
  125. </li>
  126. <li class="nav-group-task">
  127. <a class="nav-group-task-link" href="Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="nav-group-name">
  132. <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
  133. <ul class="nav-group-tasks">
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="Extensions/Notification/Name.html">– Name</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="Extensions/Notification/Key.html">– Key</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="Extensions/String.html">String</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
  154. </li>
  155. </ul>
  156. </li>
  157. <li class="nav-group-name">
  158. <a class="nav-group-name-link" href="Functions.html">Functions</a>
  159. <ul class="nav-group-tasks">
  160. <li class="nav-group-task">
  161. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  162. </li>
  163. <li class="nav-group-task">
  164. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  165. </li>
  166. <li class="nav-group-task">
  167. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  168. </li>
  169. <li class="nav-group-task">
  170. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  171. </li>
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  207. </li>
  208. </ul>
  209. </li>
  210. <li class="nav-group-name">
  211. <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
  212. <ul class="nav-group-tasks">
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  233. </li>
  234. </ul>
  235. </li>
  236. <li class="nav-group-name">
  237. <a class="nav-group-name-link" href="Structs.html">Structures</a>
  238. <ul class="nav-group-tasks">
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="Structs/Timeline.html">Timeline</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  277. </li>
  278. </ul>
  279. </li>
  280. <li class="nav-group-name">
  281. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  282. <ul class="nav-group-tasks">
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  291. </li>
  292. </ul>
  293. </li>
  294. </ul>
  295. </nav>
  296. <article class="main-content">
  297. <section class="section">
  298. <div class="section-content">
  299. <h1>Structures</h1>
  300. <p>The following structures are available globally.</p>
  301. </div>
  302. </section>
  303. <section class="section">
  304. <div class="section-content">
  305. <div class="task-group">
  306. <ul class="item-container">
  307. <li class="item">
  308. <div>
  309. <code>
  310. <a name="/s:9Alamofire8TimelineV"></a>
  311. <a name="//apple_ref/swift/Struct/Timeline" class="dashAnchor"></a>
  312. <a class="token" href="#/s:9Alamofire8TimelineV">Timeline</a>
  313. </code>
  314. </div>
  315. <div class="height-container">
  316. <div class="pointer-container"></div>
  317. <section class="section">
  318. <div class="pointer"></div>
  319. <div class="abstract">
  320. <p>Responsible for computing the timing metrics for the complete lifecycle of a <code><a href="Classes/Request.html">Request</a></code>.</p>
  321. <a href="Structs/Timeline.html" class="slightly-smaller">See more</a>
  322. </div>
  323. <div class="declaration">
  324. <h4>Declaration</h4>
  325. <div class="language">
  326. <p class="aside-title">Swift</p>
  327. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Timeline</span></code></pre>
  328. </div>
  329. </div>
  330. </section>
  331. </div>
  332. </li>
  333. </ul>
  334. </div>
  335. <div class="task-group">
  336. <ul class="item-container">
  337. <li class="item">
  338. <div>
  339. <code>
  340. <a name="/s:9Alamofire11URLEncodingV"></a>
  341. <a name="//apple_ref/swift/Struct/URLEncoding" class="dashAnchor"></a>
  342. <a class="token" href="#/s:9Alamofire11URLEncodingV">URLEncoding</a>
  343. </code>
  344. </div>
  345. <div class="height-container">
  346. <div class="pointer-container"></div>
  347. <section class="section">
  348. <div class="pointer"></div>
  349. <div class="abstract">
  350. <p>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
  351. body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
  352. the HTTP body depends on the destination of the encoding.</p>
  353. <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
  354. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  355. <p>There is no published specification for how to encode collection types. By default the convention of appending
  356. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  357. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  358. square brackets appended to array keys.</p>
  359. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  360. <code>true</code> as 1 and <code>false</code> as 0.</p>
  361. <a href="Structs/URLEncoding.html" class="slightly-smaller">See more</a>
  362. </div>
  363. <div class="declaration">
  364. <h4>Declaration</h4>
  365. <div class="language">
  366. <p class="aside-title">Swift</p>
  367. <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>
  368. </div>
  369. </div>
  370. </section>
  371. </div>
  372. </li>
  373. </ul>
  374. </div>
  375. <div class="task-group">
  376. <ul class="item-container">
  377. <li class="item">
  378. <div>
  379. <code>
  380. <a name="/s:9Alamofire12JSONEncodingV"></a>
  381. <a name="//apple_ref/swift/Struct/JSONEncoding" class="dashAnchor"></a>
  382. <a class="token" href="#/s:9Alamofire12JSONEncodingV">JSONEncoding</a>
  383. </code>
  384. </div>
  385. <div class="height-container">
  386. <div class="pointer-container"></div>
  387. <section class="section">
  388. <div class="pointer"></div>
  389. <div class="abstract">
  390. <p>Uses <code>JSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the
  391. request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
  392. <a href="Structs/JSONEncoding.html" class="slightly-smaller">See more</a>
  393. </div>
  394. <div class="declaration">
  395. <h4>Declaration</h4>
  396. <div class="language">
  397. <p class="aside-title">Swift</p>
  398. <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>
  399. </div>
  400. </div>
  401. </section>
  402. </div>
  403. </li>
  404. </ul>
  405. </div>
  406. <div class="task-group">
  407. <ul class="item-container">
  408. <li class="item">
  409. <div>
  410. <code>
  411. <a name="/s:9Alamofire20PropertyListEncodingV"></a>
  412. <a name="//apple_ref/swift/Struct/PropertyListEncoding" class="dashAnchor"></a>
  413. <a class="token" href="#/s:9Alamofire20PropertyListEncodingV">PropertyListEncoding</a>
  414. </code>
  415. </div>
  416. <div class="height-container">
  417. <div class="pointer-container"></div>
  418. <section class="section">
  419. <div class="pointer"></div>
  420. <div class="abstract">
  421. <p>Uses <code>PropertyListSerialization</code> to create a plist representation of the parameters object, according to the
  422. associated format and write options values, which is set as the body of the request. The <code>Content-Type</code> HTTP header
  423. field of an encoded request is set to <code>application/x-plist</code>.</p>
  424. <a href="Structs/PropertyListEncoding.html" class="slightly-smaller">See more</a>
  425. </div>
  426. <div class="declaration">
  427. <h4>Declaration</h4>
  428. <div class="language">
  429. <p class="aside-title">Swift</p>
  430. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PropertyListEncoding</span><span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
  431. </div>
  432. </div>
  433. </section>
  434. </div>
  435. </li>
  436. </ul>
  437. </div>
  438. <div class="task-group">
  439. <ul class="item-container">
  440. <li class="item">
  441. <div>
  442. <code>
  443. <a name="/s:9Alamofire22DataResponseSerializerV"></a>
  444. <a name="//apple_ref/swift/Struct/DataResponseSerializer" class="dashAnchor"></a>
  445. <a class="token" href="#/s:9Alamofire22DataResponseSerializerV">DataResponseSerializer</a>
  446. </code>
  447. </div>
  448. <div class="height-container">
  449. <div class="pointer-container"></div>
  450. <section class="section">
  451. <div class="pointer"></div>
  452. <div class="abstract">
  453. <p>A generic <code>DataResponseSerializerType</code> used to serialize a request, response, and data into a serialized object.</p>
  454. <a href="Structs/DataResponseSerializer.html" class="slightly-smaller">See more</a>
  455. </div>
  456. <div class="declaration">
  457. <h4>Declaration</h4>
  458. <div class="language">
  459. <p class="aside-title">Swift</p>
  460. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponseSerializer</span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt"><a href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a></span></code></pre>
  461. </div>
  462. </div>
  463. </section>
  464. </div>
  465. </li>
  466. </ul>
  467. </div>
  468. <div class="task-group">
  469. <ul class="item-container">
  470. <li class="item">
  471. <div>
  472. <code>
  473. <a name="/s:9Alamofire26DownloadResponseSerializerV"></a>
  474. <a name="//apple_ref/swift/Struct/DownloadResponseSerializer" class="dashAnchor"></a>
  475. <a class="token" href="#/s:9Alamofire26DownloadResponseSerializerV">DownloadResponseSerializer</a>
  476. </code>
  477. </div>
  478. <div class="height-container">
  479. <div class="pointer-container"></div>
  480. <section class="section">
  481. <div class="pointer"></div>
  482. <div class="abstract">
  483. <p>A generic <code>DownloadResponseSerializerType</code> used to serialize a request, response, and data into a serialized object.</p>
  484. <a href="Structs/DownloadResponseSerializer.html" class="slightly-smaller">See more</a>
  485. </div>
  486. <div class="declaration">
  487. <h4>Declaration</h4>
  488. <div class="language">
  489. <p class="aside-title">Swift</p>
  490. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadResponseSerializer</span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt"><a href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span></code></pre>
  491. </div>
  492. </div>
  493. </section>
  494. </div>
  495. </li>
  496. </ul>
  497. </div>
  498. <div class="task-group">
  499. <ul class="item-container">
  500. <li class="item">
  501. <div>
  502. <code>
  503. <a name="/s:9Alamofire19DefaultDataResponseV"></a>
  504. <a name="//apple_ref/swift/Struct/DefaultDataResponse" class="dashAnchor"></a>
  505. <a class="token" href="#/s:9Alamofire19DefaultDataResponseV">DefaultDataResponse</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>Used to store all data associated with an non-serialized response of a data or upload request.</p>
  514. <a href="Structs/DefaultDataResponse.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">DefaultDataResponse</span></code></pre>
  521. </div>
  522. </div>
  523. </section>
  524. </div>
  525. </li>
  526. </ul>
  527. </div>
  528. <div class="task-group">
  529. <ul class="item-container">
  530. <li class="item">
  531. <div>
  532. <code>
  533. <a name="/s:9Alamofire12DataResponseV"></a>
  534. <a name="//apple_ref/swift/Struct/DataResponse" class="dashAnchor"></a>
  535. <a class="token" href="#/s:9Alamofire12DataResponseV">DataResponse</a>
  536. </code>
  537. </div>
  538. <div class="height-container">
  539. <div class="pointer-container"></div>
  540. <section class="section">
  541. <div class="pointer"></div>
  542. <div class="abstract">
  543. <p>Used to store all data associated with a serialized response of a data or upload request.</p>
  544. <a href="Structs/DataResponse.html" class="slightly-smaller">See more</a>
  545. </div>
  546. <div class="declaration">
  547. <h4>Declaration</h4>
  548. <div class="language">
  549. <p class="aside-title">Swift</p>
  550. <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>
  551. </div>
  552. </div>
  553. </section>
  554. </div>
  555. </li>
  556. </ul>
  557. </div>
  558. <div class="task-group">
  559. <ul class="item-container">
  560. <li class="item">
  561. <div>
  562. <code>
  563. <a name="/s:9Alamofire23DefaultDownloadResponseV"></a>
  564. <a name="//apple_ref/swift/Struct/DefaultDownloadResponse" class="dashAnchor"></a>
  565. <a class="token" href="#/s:9Alamofire23DefaultDownloadResponseV">DefaultDownloadResponse</a>
  566. </code>
  567. </div>
  568. <div class="height-container">
  569. <div class="pointer-container"></div>
  570. <section class="section">
  571. <div class="pointer"></div>
  572. <div class="abstract">
  573. <p>Used to store all data associated with an non-serialized response of a download request.</p>
  574. <a href="Structs/DefaultDownloadResponse.html" class="slightly-smaller">See more</a>
  575. </div>
  576. <div class="declaration">
  577. <h4>Declaration</h4>
  578. <div class="language">
  579. <p class="aside-title">Swift</p>
  580. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DefaultDownloadResponse</span></code></pre>
  581. </div>
  582. </div>
  583. </section>
  584. </div>
  585. </li>
  586. </ul>
  587. </div>
  588. <div class="task-group">
  589. <ul class="item-container">
  590. <li class="item">
  591. <div>
  592. <code>
  593. <a name="/s:9Alamofire16DownloadResponseV"></a>
  594. <a name="//apple_ref/swift/Struct/DownloadResponse" class="dashAnchor"></a>
  595. <a class="token" href="#/s:9Alamofire16DownloadResponseV">DownloadResponse</a>
  596. </code>
  597. </div>
  598. <div class="height-container">
  599. <div class="pointer-container"></div>
  600. <section class="section">
  601. <div class="pointer"></div>
  602. <div class="abstract">
  603. <p>Used to store all data associated with a serialized response of a download request.</p>
  604. <a href="Structs/DownloadResponse.html" class="slightly-smaller">See more</a>
  605. </div>
  606. <div class="declaration">
  607. <h4>Declaration</h4>
  608. <div class="language">
  609. <p class="aside-title">Swift</p>
  610. <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>
  611. </div>
  612. </div>
  613. </section>
  614. </div>
  615. </li>
  616. </ul>
  617. </div>
  618. </div>
  619. </section>
  620. </article>
  621. </div>
  622. <section class="footer">
  623. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-03-31)</p>
  624. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  625. </section>
  626. </body>
  627. </div>
  628. </html>