URLEncodedFormEncoder.html 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>URLEncodedFormEncoder Class 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/Class/URLEncodedFormEncoder" class="dashAnchor"></a>
  16. <a title="URLEncodedFormEncoder Class 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. (98% 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. URLEncodedFormEncoder Class 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="../Enums.html">Enumerations</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</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/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  254. </li>
  255. </ul>
  256. </li>
  257. <li class="nav-group-name">
  258. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  259. <ul class="nav-group-tasks">
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  322. </li>
  323. </ul>
  324. </li>
  325. <li class="nav-group-name">
  326. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  327. <ul class="nav-group-tasks">
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  381. </li>
  382. </ul>
  383. </li>
  384. <li class="nav-group-name">
  385. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  386. <ul class="nav-group-tasks">
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  404. </li>
  405. </ul>
  406. </li>
  407. </ul>
  408. </nav>
  409. <article class="main-content">
  410. <section class="section">
  411. <div class="section-content">
  412. <h1>URLEncodedFormEncoder</h1>
  413. <div class="declaration">
  414. <div class="language">
  415. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">URLEncodedFormEncoder</span></code></pre>
  416. </div>
  417. </div>
  418. <p>An object that encodes instances into URL-encoded query strings.</p>
  419. <p>There is no published specification for how to encode collection types. By default, the convention of appending
  420. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  421. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  422. square brackets appended to array keys.</p>
  423. <p><code>BoolEncoding</code> can be used to configure how <code>Bool</code> values are encoded. The default behavior is to encode
  424. <code>true</code> as 1 and <code>false</code> as 0.</p>
  425. <p><code>DateEncoding</code> can be used to configure how <code>Date</code> values are encoded. By default, the <code>.deferredToDate</code>
  426. strategy is used, which formats dates from their structure.</p>
  427. <p><code>SpaceEncoding</code> can be used to configure how spaces are encoded. Modern encodings use percent replacement (<code>%20</code>),
  428. while older encodings may expect spaces to be replaced with <code>+</code>.</p>
  429. <p>This type is largely based on Vapor&rsquo;s <a href="https://github.com/vapor/url-encoded-form"><code>url-encoded-form</code></a> project.</p>
  430. </div>
  431. </section>
  432. <section class="section">
  433. <div class="section-content">
  434. <div class="task-group">
  435. <ul class="item-container">
  436. <li class="item">
  437. <div>
  438. <code>
  439. <a name="/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO"></a>
  440. <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
  441. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO">ArrayEncoding</a>
  442. </code>
  443. </div>
  444. <div class="height-container">
  445. <div class="pointer-container"></div>
  446. <section class="section">
  447. <div class="pointer"></div>
  448. <div class="abstract">
  449. <p>Encoding to use for <code>Array</code> values.</p>
  450. <a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html" class="slightly-smaller">See more</a>
  451. </div>
  452. <div class="declaration">
  453. <h4>Declaration</h4>
  454. <div class="language">
  455. <p class="aside-title">Swift</p>
  456. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ArrayEncoding</span></code></pre>
  457. </div>
  458. </div>
  459. </section>
  460. </div>
  461. </li>
  462. <li class="item">
  463. <div>
  464. <code>
  465. <a name="/s:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO"></a>
  466. <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
  467. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO">BoolEncoding</a>
  468. </code>
  469. </div>
  470. <div class="height-container">
  471. <div class="pointer-container"></div>
  472. <section class="section">
  473. <div class="pointer"></div>
  474. <div class="abstract">
  475. <p>Encoding to use for <code>Bool</code> values.</p>
  476. <a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html" class="slightly-smaller">See more</a>
  477. </div>
  478. <div class="declaration">
  479. <h4>Declaration</h4>
  480. <div class="language">
  481. <p class="aside-title">Swift</p>
  482. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BoolEncoding</span></code></pre>
  483. </div>
  484. </div>
  485. </section>
  486. </div>
  487. </li>
  488. <li class="item">
  489. <div>
  490. <code>
  491. <a name="/s:9Alamofire21URLEncodedFormEncoderC12DataEncodingO"></a>
  492. <a name="//apple_ref/swift/Enum/DataEncoding" class="dashAnchor"></a>
  493. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DataEncodingO">DataEncoding</a>
  494. </code>
  495. </div>
  496. <div class="height-container">
  497. <div class="pointer-container"></div>
  498. <section class="section">
  499. <div class="pointer"></div>
  500. <div class="abstract">
  501. <p>Encoding to use for <code>Data</code> values.</p>
  502. <a href="../Classes/URLEncodedFormEncoder/DataEncoding.html" class="slightly-smaller">See more</a>
  503. </div>
  504. <div class="declaration">
  505. <h4>Declaration</h4>
  506. <div class="language">
  507. <p class="aside-title">Swift</p>
  508. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DataEncoding</span></code></pre>
  509. </div>
  510. </div>
  511. </section>
  512. </div>
  513. </li>
  514. <li class="item">
  515. <div>
  516. <code>
  517. <a name="/s:9Alamofire21URLEncodedFormEncoderC12DateEncodingO"></a>
  518. <a name="//apple_ref/swift/Enum/DateEncoding" class="dashAnchor"></a>
  519. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DateEncodingO">DateEncoding</a>
  520. </code>
  521. </div>
  522. <div class="height-container">
  523. <div class="pointer-container"></div>
  524. <section class="section">
  525. <div class="pointer"></div>
  526. <div class="abstract">
  527. <p>Encoding to use for <code>Date</code> values.</p>
  528. <a href="../Classes/URLEncodedFormEncoder/DateEncoding.html" class="slightly-smaller">See more</a>
  529. </div>
  530. <div class="declaration">
  531. <h4>Declaration</h4>
  532. <div class="language">
  533. <p class="aside-title">Swift</p>
  534. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DateEncoding</span></code></pre>
  535. </div>
  536. </div>
  537. </section>
  538. </div>
  539. </li>
  540. <li class="item">
  541. <div>
  542. <code>
  543. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO"></a>
  544. <a name="//apple_ref/swift/Enum/KeyEncoding" class="dashAnchor"></a>
  545. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO">KeyEncoding</a>
  546. </code>
  547. </div>
  548. <div class="height-container">
  549. <div class="pointer-container"></div>
  550. <section class="section">
  551. <div class="pointer"></div>
  552. <div class="abstract">
  553. <p>Encoding to use for keys.</p>
  554. <p>This type is derived from <a href="https://github.com/apple/swift/blob/6aa313b8dd5f05135f7f878eccc1db6f9fbe34ff/stdlib/public/Darwin/Foundation/JSONEncoder.swift#L128"><code>JSONEncoder</code>&lsquo;s <code>KeyEncodingStrategy</code></a>
  555. and <a href="https://github.com/MaxDesiatov/XMLCoder/blob/master/Sources/XMLCoder/Encoder/XMLEncoder.swift#L102"><code>XMLEncoder</code>s <code>KeyEncodingStrategy</code></a>.</p>
  556. <a href="../Classes/URLEncodedFormEncoder/KeyEncoding.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">enum</span> <span class="kt">KeyEncoding</span></code></pre>
  563. </div>
  564. </div>
  565. </section>
  566. </div>
  567. </li>
  568. <li class="item">
  569. <div>
  570. <code>
  571. <a name="/s:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO"></a>
  572. <a name="//apple_ref/swift/Enum/SpaceEncoding" class="dashAnchor"></a>
  573. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO">SpaceEncoding</a>
  574. </code>
  575. </div>
  576. <div class="height-container">
  577. <div class="pointer-container"></div>
  578. <section class="section">
  579. <div class="pointer"></div>
  580. <div class="abstract">
  581. <p>Encoding to use for spaces.</p>
  582. <a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html" class="slightly-smaller">See more</a>
  583. </div>
  584. <div class="declaration">
  585. <h4>Declaration</h4>
  586. <div class="language">
  587. <p class="aside-title">Swift</p>
  588. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SpaceEncoding</span></code></pre>
  589. </div>
  590. </div>
  591. </section>
  592. </div>
  593. </li>
  594. <li class="item">
  595. <div>
  596. <code>
  597. <a name="/s:9Alamofire21URLEncodedFormEncoderC5ErrorO"></a>
  598. <a name="//apple_ref/swift/Enum/Error" class="dashAnchor"></a>
  599. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC5ErrorO">Error</a>
  600. </code>
  601. </div>
  602. <div class="height-container">
  603. <div class="pointer-container"></div>
  604. <section class="section">
  605. <div class="pointer"></div>
  606. <div class="abstract">
  607. <p><code><a href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a></code> error.</p>
  608. <a href="../Classes/URLEncodedFormEncoder/Error.html" class="slightly-smaller">See more</a>
  609. </div>
  610. <div class="declaration">
  611. <h4>Declaration</h4>
  612. <div class="language">
  613. <p class="aside-title">Swift</p>
  614. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Error</span> <span class="p">:</span> <span class="kt">Swift</span><span class="o">.</span><span class="kt">Error</span></code></pre>
  615. </div>
  616. </div>
  617. </section>
  618. </div>
  619. </li>
  620. <li class="item">
  621. <div>
  622. <code>
  623. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp"></a>
  624. <a name="//apple_ref/swift/Property/alphabetizeKeyValuePairs" class="dashAnchor"></a>
  625. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp">alphabetizeKeyValuePairs</a>
  626. </code>
  627. </div>
  628. <div class="height-container">
  629. <div class="pointer-container"></div>
  630. <section class="section">
  631. <div class="pointer"></div>
  632. <div class="abstract">
  633. <p>Whether or not to sort the encoded key value pairs.</p>
  634. <div class="aside aside-note">
  635. <p class="aside-title">Note</p>
  636. This setting ensures a consistent ordering for all encodings of the same parameters. When set to <code>false</code>,
  637. encoded <code>Dictionary</code> values may have a different encoded order each time they&rsquo;re encoded due to
  638. <code>Dictionary</code>&lsquo;s random storage order, but <code>Encodable</code> types will maintain their encoded order.
  639. </div>
  640. </div>
  641. <div class="declaration">
  642. <h4>Declaration</h4>
  643. <div class="language">
  644. <p class="aside-title">Swift</p>
  645. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">alphabetizeKeyValuePairs</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  646. </div>
  647. </div>
  648. </section>
  649. </div>
  650. </li>
  651. <li class="item">
  652. <div>
  653. <code>
  654. <a name="/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp"></a>
  655. <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
  656. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp">arrayEncoding</a>
  657. </code>
  658. </div>
  659. <div class="height-container">
  660. <div class="pointer-container"></div>
  661. <section class="section">
  662. <div class="pointer"></div>
  663. <div class="abstract">
  664. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use.</p>
  665. </div>
  666. <div class="declaration">
  667. <h4>Declaration</h4>
  668. <div class="language">
  669. <p class="aside-title">Swift</p>
  670. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">arrayEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></span></code></pre>
  671. </div>
  672. </div>
  673. </section>
  674. </div>
  675. </li>
  676. <li class="item">
  677. <div>
  678. <code>
  679. <a name="/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp"></a>
  680. <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
  681. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp">boolEncoding</a>
  682. </code>
  683. </div>
  684. <div class="height-container">
  685. <div class="pointer-container"></div>
  686. <section class="section">
  687. <div class="pointer"></div>
  688. <div class="abstract">
  689. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use.</p>
  690. </div>
  691. <div class="declaration">
  692. <h4>Declaration</h4>
  693. <div class="language">
  694. <p class="aside-title">Swift</p>
  695. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">boolEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></span></code></pre>
  696. </div>
  697. </div>
  698. </section>
  699. </div>
  700. </li>
  701. <li class="item">
  702. <div>
  703. <code>
  704. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp"></a>
  705. <a name="//apple_ref/swift/Property/dataEncoding" class="dashAnchor"></a>
  706. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp">dataEncoding</a>
  707. </code>
  708. </div>
  709. <div class="height-container">
  710. <div class="pointer-container"></div>
  711. <section class="section">
  712. <div class="pointer"></div>
  713. <div class="abstract">
  714. <p>THe <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use.</p>
  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="k">let</span> <span class="nv">dataEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></span></code></pre>
  721. </div>
  722. </div>
  723. </section>
  724. </div>
  725. </li>
  726. <li class="item">
  727. <div>
  728. <code>
  729. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp"></a>
  730. <a name="//apple_ref/swift/Property/dateEncoding" class="dashAnchor"></a>
  731. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp">dateEncoding</a>
  732. </code>
  733. </div>
  734. <div class="height-container">
  735. <div class="pointer-container"></div>
  736. <section class="section">
  737. <div class="pointer"></div>
  738. <div class="abstract">
  739. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use.</p>
  740. </div>
  741. <div class="declaration">
  742. <h4>Declaration</h4>
  743. <div class="language">
  744. <p class="aside-title">Swift</p>
  745. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">dateEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></span></code></pre>
  746. </div>
  747. </div>
  748. </section>
  749. </div>
  750. </li>
  751. <li class="item">
  752. <div>
  753. <code>
  754. <a name="/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp"></a>
  755. <a name="//apple_ref/swift/Property/keyEncoding" class="dashAnchor"></a>
  756. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp">keyEncoding</a>
  757. </code>
  758. </div>
  759. <div class="height-container">
  760. <div class="pointer-container"></div>
  761. <section class="section">
  762. <div class="pointer"></div>
  763. <div class="abstract">
  764. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use.</p>
  765. </div>
  766. <div class="declaration">
  767. <h4>Declaration</h4>
  768. <div class="language">
  769. <p class="aside-title">Swift</p>
  770. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">keyEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></span></code></pre>
  771. </div>
  772. </div>
  773. </section>
  774. </div>
  775. </li>
  776. <li class="item">
  777. <div>
  778. <code>
  779. <a name="/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp"></a>
  780. <a name="//apple_ref/swift/Property/spaceEncoding" class="dashAnchor"></a>
  781. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp">spaceEncoding</a>
  782. </code>
  783. </div>
  784. <div class="height-container">
  785. <div class="pointer-container"></div>
  786. <section class="section">
  787. <div class="pointer"></div>
  788. <div class="abstract">
  789. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use.</p>
  790. </div>
  791. <div class="declaration">
  792. <h4>Declaration</h4>
  793. <div class="language">
  794. <p class="aside-title">Swift</p>
  795. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">spaceEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></span></code></pre>
  796. </div>
  797. </div>
  798. </section>
  799. </div>
  800. </li>
  801. <li class="item">
  802. <div>
  803. <code>
  804. <a name="/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp"></a>
  805. <a name="//apple_ref/swift/Property/allowedCharacters" class="dashAnchor"></a>
  806. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp">allowedCharacters</a>
  807. </code>
  808. </div>
  809. <div class="height-container">
  810. <div class="pointer-container"></div>
  811. <section class="section">
  812. <div class="pointer"></div>
  813. <div class="abstract">
  814. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters.</p>
  815. </div>
  816. <div class="declaration">
  817. <h4>Declaration</h4>
  818. <div class="language">
  819. <p class="aside-title">Swift</p>
  820. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">allowedCharacters</span><span class="p">:</span> <span class="kt">CharacterSet</span></code></pre>
  821. </div>
  822. </div>
  823. </section>
  824. </div>
  825. </li>
  826. <li class="item">
  827. <div>
  828. <code>
  829. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC05SpaceJ0O10Foundation12CharacterSetVtcfc"></a>
  830. <a name="//apple_ref/swift/Method/init(alphabetizeKeyValuePairs:arrayEncoding:boolEncoding:dataEncoding:dateEncoding:keyEncoding:spaceEncoding:allowedCharacters:)" class="dashAnchor"></a>
  831. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC05SpaceJ0O10Foundation12CharacterSetVtcfc">init(alphabetizeKeyValuePairs:arrayEncoding:boolEncoding:dataEncoding:dateEncoding:keyEncoding:spaceEncoding:allowedCharacters:)</a>
  832. </code>
  833. </div>
  834. <div class="height-container">
  835. <div class="pointer-container"></div>
  836. <section class="section">
  837. <div class="pointer"></div>
  838. <div class="abstract">
  839. <p>Creates an instance from the supplied parameters.</p>
  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="nf">init</span><span class="p">(</span><span class="nv">alphabetizeKeyValuePairs</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
  846. <span class="nv">arrayEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">brackets</span><span class="p">,</span>
  847. <span class="nv">boolEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">numeric</span><span class="p">,</span>
  848. <span class="nv">dataEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">base64</span><span class="p">,</span>
  849. <span class="nv">dateEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">deferredToDate</span><span class="p">,</span>
  850. <span class="nv">keyEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">useDefaultKeys</span><span class="p">,</span>
  851. <span class="nv">spaceEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">percentEscaped</span><span class="p">,</span>
  852. <span class="nv">allowedCharacters</span><span class="p">:</span> <span class="kt">CharacterSet</span> <span class="o">=</span> <span class="o">.</span><span class="n">afURLQueryAllowed</span><span class="p">)</span></code></pre>
  853. </div>
  854. </div>
  855. <div>
  856. <h4>Parameters</h4>
  857. <table class="graybox">
  858. <tbody>
  859. <tr>
  860. <td>
  861. <code>
  862. <em>alphabetizeKeyValuePairs</em>
  863. </code>
  864. </td>
  865. <td>
  866. <div>
  867. <p>Whether or not to sort the encoded key value pairs. <code>true</code> by default.</p>
  868. </div>
  869. </td>
  870. </tr>
  871. <tr>
  872. <td>
  873. <code>
  874. <em>arrayEncoding</em>
  875. </code>
  876. </td>
  877. <td>
  878. <div>
  879. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
  880. </div>
  881. </td>
  882. </tr>
  883. <tr>
  884. <td>
  885. <code>
  886. <em>boolEncoding</em>
  887. </code>
  888. </td>
  889. <td>
  890. <div>
  891. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
  892. </div>
  893. </td>
  894. </tr>
  895. <tr>
  896. <td>
  897. <code>
  898. <em>dataEncoding</em>
  899. </code>
  900. </td>
  901. <td>
  902. <div>
  903. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use. <code>.base64</code> by default.</p>
  904. </div>
  905. </td>
  906. </tr>
  907. <tr>
  908. <td>
  909. <code>
  910. <em>dateEncoding</em>
  911. </code>
  912. </td>
  913. <td>
  914. <div>
  915. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use. <code>.deferredToDate</code> by default.</p>
  916. </div>
  917. </td>
  918. </tr>
  919. <tr>
  920. <td>
  921. <code>
  922. <em>keyEncoding</em>
  923. </code>
  924. </td>
  925. <td>
  926. <div>
  927. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use. <code>.useDefaultKeys</code> by default.</p>
  928. </div>
  929. </td>
  930. </tr>
  931. <tr>
  932. <td>
  933. <code>
  934. <em>spaceEncoding</em>
  935. </code>
  936. </td>
  937. <td>
  938. <div>
  939. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use. <code>.percentEscaped</code> by default.</p>
  940. </div>
  941. </td>
  942. </tr>
  943. <tr>
  944. <td>
  945. <code>
  946. <em>allowedCharacters</em>
  947. </code>
  948. </td>
  949. <td>
  950. <div>
  951. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters. <code>.afURLQueryAllowed</code> by
  952. default.</p>
  953. </div>
  954. </td>
  955. </tr>
  956. </tbody>
  957. </table>
  958. </div>
  959. </section>
  960. </div>
  961. </li>
  962. <li class="item">
  963. <div>
  964. <code>
  965. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF"></a>
  966. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  967. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF">encode(_:)</a>
  968. </code>
  969. </div>
  970. <div class="height-container">
  971. <div class="pointer-container"></div>
  972. <section class="section">
  973. <div class="pointer"></div>
  974. <div class="abstract">
  975. <p>Encodes the <code>value</code> as a URL form encoded <code>String</code>.</p>
  976. <div class="aside aside-throws">
  977. <p class="aside-title">Throws</p>
  978. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  979. </div>
  980. </div>
  981. <div class="declaration">
  982. <h4>Declaration</h4>
  983. <div class="language">
  984. <p class="aside-title">Swift</p>
  985. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Encodable</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
  986. </div>
  987. </div>
  988. <div>
  989. <h4>Parameters</h4>
  990. <table class="graybox">
  991. <tbody>
  992. <tr>
  993. <td>
  994. <code>
  995. <em>value</em>
  996. </code>
  997. </td>
  998. <td>
  999. <div>
  1000. <p>The <code>Encodable</code> value.`</p>
  1001. </div>
  1002. </td>
  1003. </tr>
  1004. </tbody>
  1005. </table>
  1006. </div>
  1007. <div>
  1008. <h4>Return Value</h4>
  1009. <p>The encoded <code>String</code>.</p>
  1010. </div>
  1011. </section>
  1012. </div>
  1013. </li>
  1014. <li class="item">
  1015. <div>
  1016. <code>
  1017. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF"></a>
  1018. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  1019. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF">encode(_:)</a>
  1020. </code>
  1021. </div>
  1022. <div class="height-container">
  1023. <div class="pointer-container"></div>
  1024. <section class="section">
  1025. <div class="pointer"></div>
  1026. <div class="abstract">
  1027. <p>Encodes the value as <code>Data</code>. This is performed by first creating an encoded <code>String</code> and then returning the
  1028. <code>.utf8</code> data.</p>
  1029. <div class="aside aside-throws">
  1030. <p class="aside-title">Throws</p>
  1031. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  1032. </div>
  1033. </div>
  1034. <div class="declaration">
  1035. <h4>Declaration</h4>
  1036. <div class="language">
  1037. <p class="aside-title">Swift</p>
  1038. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Encodable</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
  1039. </div>
  1040. </div>
  1041. <div>
  1042. <h4>Parameters</h4>
  1043. <table class="graybox">
  1044. <tbody>
  1045. <tr>
  1046. <td>
  1047. <code>
  1048. <em>value</em>
  1049. </code>
  1050. </td>
  1051. <td>
  1052. <div>
  1053. <p>The <code>Encodable</code> value.</p>
  1054. </div>
  1055. </td>
  1056. </tr>
  1057. </tbody>
  1058. </table>
  1059. </div>
  1060. <div>
  1061. <h4>Return Value</h4>
  1062. <p>The encoded <code>Data</code>.</p>
  1063. </div>
  1064. </section>
  1065. </div>
  1066. </li>
  1067. </ul>
  1068. </div>
  1069. </div>
  1070. </section>
  1071. </article>
  1072. </div>
  1073. <section class="footer">
  1074. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-26)</p>
  1075. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1076. </section>
  1077. </body>
  1078. </div>
  1079. </html>