URLEncodedFormEncoder.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164
  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. (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. 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="../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>URLEncodedFormEncoder</h1>
  439. <div class="declaration">
  440. <div class="language">
  441. <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>
  442. </div>
  443. </div>
  444. <p>An object that encodes instances into URL-encoded query strings.</p>
  445. <p>There is no published specification for how to encode collection types. By default, the convention of appending
  446. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  447. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  448. square brackets appended to array keys.</p>
  449. <p><code>BoolEncoding</code> can be used to configure how <code>Bool</code> values are encoded. The default behavior is to encode
  450. <code>true</code> as 1 and <code>false</code> as 0.</p>
  451. <p><code>DateEncoding</code> can be used to configure how <code>Date</code> values are encoded. By default, the <code>.deferredToDate</code>
  452. strategy is used, which formats dates from their structure.</p>
  453. <p><code>SpaceEncoding</code> can be used to configure how spaces are encoded. Modern encodings use percent replacement (<code>%20</code>),
  454. while older encodings may expect spaces to be replaced with <code>+</code>.</p>
  455. <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>
  456. </div>
  457. </section>
  458. <section class="section">
  459. <div class="section-content">
  460. <div class="task-group">
  461. <ul class="item-container">
  462. <li class="item">
  463. <div>
  464. <code>
  465. <a name="/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO"></a>
  466. <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
  467. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO">ArrayEncoding</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>Array</code> values.</p>
  476. <a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.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">ArrayEncoding</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:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO"></a>
  492. <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
  493. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO">BoolEncoding</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>Bool</code> values.</p>
  502. <a href="../Classes/URLEncodedFormEncoder/BoolEncoding.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">BoolEncoding</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:9Alamofire21URLEncodedFormEncoderC12DataEncodingO"></a>
  518. <a name="//apple_ref/swift/Enum/DataEncoding" class="dashAnchor"></a>
  519. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DataEncodingO">DataEncoding</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>Data</code> values.</p>
  528. <a href="../Classes/URLEncodedFormEncoder/DataEncoding.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">DataEncoding</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:9Alamofire21URLEncodedFormEncoderC12DateEncodingO"></a>
  544. <a name="//apple_ref/swift/Enum/DateEncoding" class="dashAnchor"></a>
  545. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DateEncodingO">DateEncoding</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 <code>Date</code> values.</p>
  554. <a href="../Classes/URLEncodedFormEncoder/DateEncoding.html" class="slightly-smaller">See more</a>
  555. </div>
  556. <div class="declaration">
  557. <h4>Declaration</h4>
  558. <div class="language">
  559. <p class="aside-title">Swift</p>
  560. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DateEncoding</span></code></pre>
  561. </div>
  562. </div>
  563. </section>
  564. </div>
  565. </li>
  566. <li class="item">
  567. <div>
  568. <code>
  569. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO"></a>
  570. <a name="//apple_ref/swift/Enum/KeyEncoding" class="dashAnchor"></a>
  571. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO">KeyEncoding</a>
  572. </code>
  573. </div>
  574. <div class="height-container">
  575. <div class="pointer-container"></div>
  576. <section class="section">
  577. <div class="pointer"></div>
  578. <div class="abstract">
  579. <p>Encoding to use for keys.</p>
  580. <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>
  581. 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>
  582. <a href="../Classes/URLEncodedFormEncoder/KeyEncoding.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">KeyEncoding</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:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO"></a>
  598. <a name="//apple_ref/swift/Enum/SpaceEncoding" class="dashAnchor"></a>
  599. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO">SpaceEncoding</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>Encoding to use for spaces.</p>
  608. <a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.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">SpaceEncoding</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:9Alamofire21URLEncodedFormEncoderC5ErrorO"></a>
  624. <a name="//apple_ref/swift/Enum/Error" class="dashAnchor"></a>
  625. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC5ErrorO">Error</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><code><a href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a></code> error.</p>
  634. <a href="../Classes/URLEncodedFormEncoder/Error.html" class="slightly-smaller">See more</a>
  635. </div>
  636. <div class="declaration">
  637. <h4>Declaration</h4>
  638. <div class="language">
  639. <p class="aside-title">Swift</p>
  640. <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>
  641. </div>
  642. </div>
  643. </section>
  644. </div>
  645. </li>
  646. <li class="item">
  647. <div>
  648. <code>
  649. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp"></a>
  650. <a name="//apple_ref/swift/Property/alphabetizeKeyValuePairs" class="dashAnchor"></a>
  651. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp">alphabetizeKeyValuePairs</a>
  652. </code>
  653. </div>
  654. <div class="height-container">
  655. <div class="pointer-container"></div>
  656. <section class="section">
  657. <div class="pointer"></div>
  658. <div class="abstract">
  659. <p>Whether or not to sort the encoded key value pairs.</p>
  660. <div class="aside aside-note">
  661. <p class="aside-title">Note</p>
  662. This setting ensures a consistent ordering for all encodings of the same parameters. When set to <code>false</code>,
  663. encoded <code>Dictionary</code> values may have a different encoded order each time they&rsquo;re encoded due to
  664. <code>Dictionary</code>&lsquo;s random storage order, but <code>Encodable</code> types will maintain their encoded order.
  665. </div>
  666. </div>
  667. <div class="declaration">
  668. <h4>Declaration</h4>
  669. <div class="language">
  670. <p class="aside-title">Swift</p>
  671. <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>
  672. </div>
  673. </div>
  674. </section>
  675. </div>
  676. </li>
  677. <li class="item">
  678. <div>
  679. <code>
  680. <a name="/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp"></a>
  681. <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
  682. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp">arrayEncoding</a>
  683. </code>
  684. </div>
  685. <div class="height-container">
  686. <div class="pointer-container"></div>
  687. <section class="section">
  688. <div class="pointer"></div>
  689. <div class="abstract">
  690. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use.</p>
  691. </div>
  692. <div class="declaration">
  693. <h4>Declaration</h4>
  694. <div class="language">
  695. <p class="aside-title">Swift</p>
  696. <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>
  697. </div>
  698. </div>
  699. </section>
  700. </div>
  701. </li>
  702. <li class="item">
  703. <div>
  704. <code>
  705. <a name="/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp"></a>
  706. <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
  707. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp">boolEncoding</a>
  708. </code>
  709. </div>
  710. <div class="height-container">
  711. <div class="pointer-container"></div>
  712. <section class="section">
  713. <div class="pointer"></div>
  714. <div class="abstract">
  715. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use.</p>
  716. </div>
  717. <div class="declaration">
  718. <h4>Declaration</h4>
  719. <div class="language">
  720. <p class="aside-title">Swift</p>
  721. <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>
  722. </div>
  723. </div>
  724. </section>
  725. </div>
  726. </li>
  727. <li class="item">
  728. <div>
  729. <code>
  730. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp"></a>
  731. <a name="//apple_ref/swift/Property/dataEncoding" class="dashAnchor"></a>
  732. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp">dataEncoding</a>
  733. </code>
  734. </div>
  735. <div class="height-container">
  736. <div class="pointer-container"></div>
  737. <section class="section">
  738. <div class="pointer"></div>
  739. <div class="abstract">
  740. <p>THe <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use.</p>
  741. </div>
  742. <div class="declaration">
  743. <h4>Declaration</h4>
  744. <div class="language">
  745. <p class="aside-title">Swift</p>
  746. <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>
  747. </div>
  748. </div>
  749. </section>
  750. </div>
  751. </li>
  752. <li class="item">
  753. <div>
  754. <code>
  755. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp"></a>
  756. <a name="//apple_ref/swift/Property/dateEncoding" class="dashAnchor"></a>
  757. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp">dateEncoding</a>
  758. </code>
  759. </div>
  760. <div class="height-container">
  761. <div class="pointer-container"></div>
  762. <section class="section">
  763. <div class="pointer"></div>
  764. <div class="abstract">
  765. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use.</p>
  766. </div>
  767. <div class="declaration">
  768. <h4>Declaration</h4>
  769. <div class="language">
  770. <p class="aside-title">Swift</p>
  771. <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>
  772. </div>
  773. </div>
  774. </section>
  775. </div>
  776. </li>
  777. <li class="item">
  778. <div>
  779. <code>
  780. <a name="/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp"></a>
  781. <a name="//apple_ref/swift/Property/keyEncoding" class="dashAnchor"></a>
  782. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp">keyEncoding</a>
  783. </code>
  784. </div>
  785. <div class="height-container">
  786. <div class="pointer-container"></div>
  787. <section class="section">
  788. <div class="pointer"></div>
  789. <div class="abstract">
  790. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use.</p>
  791. </div>
  792. <div class="declaration">
  793. <h4>Declaration</h4>
  794. <div class="language">
  795. <p class="aside-title">Swift</p>
  796. <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>
  797. </div>
  798. </div>
  799. </section>
  800. </div>
  801. </li>
  802. <li class="item">
  803. <div>
  804. <code>
  805. <a name="/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp"></a>
  806. <a name="//apple_ref/swift/Property/spaceEncoding" class="dashAnchor"></a>
  807. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp">spaceEncoding</a>
  808. </code>
  809. </div>
  810. <div class="height-container">
  811. <div class="pointer-container"></div>
  812. <section class="section">
  813. <div class="pointer"></div>
  814. <div class="abstract">
  815. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use.</p>
  816. </div>
  817. <div class="declaration">
  818. <h4>Declaration</h4>
  819. <div class="language">
  820. <p class="aside-title">Swift</p>
  821. <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>
  822. </div>
  823. </div>
  824. </section>
  825. </div>
  826. </li>
  827. <li class="item">
  828. <div>
  829. <code>
  830. <a name="/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp"></a>
  831. <a name="//apple_ref/swift/Property/allowedCharacters" class="dashAnchor"></a>
  832. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp">allowedCharacters</a>
  833. </code>
  834. </div>
  835. <div class="height-container">
  836. <div class="pointer-container"></div>
  837. <section class="section">
  838. <div class="pointer"></div>
  839. <div class="abstract">
  840. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters.</p>
  841. </div>
  842. <div class="declaration">
  843. <h4>Declaration</h4>
  844. <div class="language">
  845. <p class="aside-title">Swift</p>
  846. <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>
  847. </div>
  848. </div>
  849. </section>
  850. </div>
  851. </li>
  852. <li class="item">
  853. <div>
  854. <code>
  855. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC05SpaceJ0O10Foundation12CharacterSetVtcfc"></a>
  856. <a name="//apple_ref/swift/Method/init(alphabetizeKeyValuePairs:arrayEncoding:boolEncoding:dataEncoding:dateEncoding:keyEncoding:spaceEncoding:allowedCharacters:)" class="dashAnchor"></a>
  857. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC05SpaceJ0O10Foundation12CharacterSetVtcfc">init(alphabetizeKeyValuePairs:arrayEncoding:boolEncoding:dataEncoding:dateEncoding:keyEncoding:spaceEncoding:allowedCharacters:)</a>
  858. </code>
  859. </div>
  860. <div class="height-container">
  861. <div class="pointer-container"></div>
  862. <section class="section">
  863. <div class="pointer"></div>
  864. <div class="abstract">
  865. <p>Creates an instance from the supplied parameters.</p>
  866. </div>
  867. <div class="declaration">
  868. <h4>Declaration</h4>
  869. <div class="language">
  870. <p class="aside-title">Swift</p>
  871. <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>
  872. <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>
  873. <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>
  874. <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>
  875. <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>
  876. <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>
  877. <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>
  878. <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>
  879. </div>
  880. </div>
  881. <div>
  882. <h4>Parameters</h4>
  883. <table class="graybox">
  884. <tbody>
  885. <tr>
  886. <td>
  887. <code>
  888. <em>alphabetizeKeyValuePairs</em>
  889. </code>
  890. </td>
  891. <td>
  892. <div>
  893. <p>Whether or not to sort the encoded key value pairs. <code>true</code> by default.</p>
  894. </div>
  895. </td>
  896. </tr>
  897. <tr>
  898. <td>
  899. <code>
  900. <em>arrayEncoding</em>
  901. </code>
  902. </td>
  903. <td>
  904. <div>
  905. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
  906. </div>
  907. </td>
  908. </tr>
  909. <tr>
  910. <td>
  911. <code>
  912. <em>boolEncoding</em>
  913. </code>
  914. </td>
  915. <td>
  916. <div>
  917. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
  918. </div>
  919. </td>
  920. </tr>
  921. <tr>
  922. <td>
  923. <code>
  924. <em>dataEncoding</em>
  925. </code>
  926. </td>
  927. <td>
  928. <div>
  929. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use. <code>.base64</code> by default.</p>
  930. </div>
  931. </td>
  932. </tr>
  933. <tr>
  934. <td>
  935. <code>
  936. <em>dateEncoding</em>
  937. </code>
  938. </td>
  939. <td>
  940. <div>
  941. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use. <code>.deferredToDate</code> by default.</p>
  942. </div>
  943. </td>
  944. </tr>
  945. <tr>
  946. <td>
  947. <code>
  948. <em>keyEncoding</em>
  949. </code>
  950. </td>
  951. <td>
  952. <div>
  953. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use. <code>.useDefaultKeys</code> by default.</p>
  954. </div>
  955. </td>
  956. </tr>
  957. <tr>
  958. <td>
  959. <code>
  960. <em>spaceEncoding</em>
  961. </code>
  962. </td>
  963. <td>
  964. <div>
  965. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use. <code>.percentEscaped</code> by default.</p>
  966. </div>
  967. </td>
  968. </tr>
  969. <tr>
  970. <td>
  971. <code>
  972. <em>allowedCharacters</em>
  973. </code>
  974. </td>
  975. <td>
  976. <div>
  977. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters. <code>.afURLQueryAllowed</code> by
  978. default.</p>
  979. </div>
  980. </td>
  981. </tr>
  982. </tbody>
  983. </table>
  984. </div>
  985. </section>
  986. </div>
  987. </li>
  988. <li class="item">
  989. <div>
  990. <code>
  991. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF"></a>
  992. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  993. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF">encode(_:)</a>
  994. </code>
  995. </div>
  996. <div class="height-container">
  997. <div class="pointer-container"></div>
  998. <section class="section">
  999. <div class="pointer"></div>
  1000. <div class="abstract">
  1001. <p>Encodes the <code>value</code> as a URL form encoded <code>String</code>.</p>
  1002. <div class="aside aside-throws">
  1003. <p class="aside-title">Throws</p>
  1004. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  1005. </div>
  1006. </div>
  1007. <div class="declaration">
  1008. <h4>Declaration</h4>
  1009. <div class="language">
  1010. <p class="aside-title">Swift</p>
  1011. <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>
  1012. </div>
  1013. </div>
  1014. <div>
  1015. <h4>Parameters</h4>
  1016. <table class="graybox">
  1017. <tbody>
  1018. <tr>
  1019. <td>
  1020. <code>
  1021. <em>value</em>
  1022. </code>
  1023. </td>
  1024. <td>
  1025. <div>
  1026. <p>The <code>Encodable</code> value.`</p>
  1027. </div>
  1028. </td>
  1029. </tr>
  1030. </tbody>
  1031. </table>
  1032. </div>
  1033. <div>
  1034. <h4>Return Value</h4>
  1035. <p>The encoded <code>String</code>.</p>
  1036. </div>
  1037. </section>
  1038. </div>
  1039. </li>
  1040. <li class="item">
  1041. <div>
  1042. <code>
  1043. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF"></a>
  1044. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  1045. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF">encode(_:)</a>
  1046. </code>
  1047. </div>
  1048. <div class="height-container">
  1049. <div class="pointer-container"></div>
  1050. <section class="section">
  1051. <div class="pointer"></div>
  1052. <div class="abstract">
  1053. <p>Encodes the value as <code>Data</code>. This is performed by first creating an encoded <code>String</code> and then returning the
  1054. <code>.utf8</code> data.</p>
  1055. <div class="aside aside-throws">
  1056. <p class="aside-title">Throws</p>
  1057. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  1058. </div>
  1059. </div>
  1060. <div class="declaration">
  1061. <h4>Declaration</h4>
  1062. <div class="language">
  1063. <p class="aside-title">Swift</p>
  1064. <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>
  1065. </div>
  1066. </div>
  1067. <div>
  1068. <h4>Parameters</h4>
  1069. <table class="graybox">
  1070. <tbody>
  1071. <tr>
  1072. <td>
  1073. <code>
  1074. <em>value</em>
  1075. </code>
  1076. </td>
  1077. <td>
  1078. <div>
  1079. <p>The <code>Encodable</code> value.</p>
  1080. </div>
  1081. </td>
  1082. </tr>
  1083. </tbody>
  1084. </table>
  1085. </div>
  1086. <div>
  1087. <h4>Return Value</h4>
  1088. <p>The encoded <code>Data</code>.</p>
  1089. </div>
  1090. </section>
  1091. </div>
  1092. </li>
  1093. </ul>
  1094. </div>
  1095. </div>
  1096. </section>
  1097. </article>
  1098. </div>
  1099. <section class="footer">
  1100. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-03-23)</p>
  1101. <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>
  1102. </section>
  1103. </body>
  1104. </div>
  1105. </html>