URLEncodedFormEncoder.html 78 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425
  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 5.10.1 Docs
  21. </a>
  22. (96% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire</a>
  44. <img class="carat" src="../img/carat.png" alt=""/>
  45. <a class="breadcrumb" href="../Classes.html">Classes</a>
  46. <img class="carat" src="../img/carat.png" alt=""/>
  47. URLEncodedFormEncoder Class Reference
  48. </p>
  49. <div class="content-wrapper">
  50. <nav class="navigation">
  51. <ul class="nav-groups">
  52. <li class="nav-group-name">
  53. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  54. <ul class="nav-group-tasks">
  55. <li class="nav-group-task">
  56. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  57. </li>
  58. <li class="nav-group-task">
  59. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  60. </li>
  61. <li class="nav-group-task">
  62. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  66. </li>
  67. <li class="nav-group-task">
  68. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  69. </li>
  70. <li class="nav-group-task">
  71. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  72. </li>
  73. <li class="nav-group-task">
  74. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  75. </li>
  76. <li class="nav-group-task">
  77. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  78. </li>
  79. <li class="nav-group-task">
  80. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  81. </li>
  82. <li class="nav-group-task">
  83. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  84. </li>
  85. <li class="nav-group-task">
  86. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  87. </li>
  88. <li class="nav-group-task">
  89. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  90. </li>
  91. <li class="nav-group-task">
  92. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  93. </li>
  94. <li class="nav-group-task">
  95. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  96. </li>
  97. <li class="nav-group-task">
  98. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  99. </li>
  100. <li class="nav-group-task">
  101. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  102. </li>
  103. <li class="nav-group-task">
  104. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  105. </li>
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  129. </li>
  130. <li class="nav-group-task">
  131. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  132. </li>
  133. <li class="nav-group-task">
  134. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  135. </li>
  136. <li class="nav-group-task">
  137. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  138. </li>
  139. <li class="nav-group-task">
  140. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  141. </li>
  142. <li class="nav-group-task">
  143. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  144. </li>
  145. <li class="nav-group-task">
  146. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  147. </li>
  148. <li class="nav-group-task">
  149. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  150. </li>
  151. <li class="nav-group-task">
  152. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  153. </li>
  154. <li class="nav-group-task">
  155. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  156. </li>
  157. <li class="nav-group-task">
  158. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  159. </li>
  160. <li class="nav-group-task">
  161. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  162. </li>
  163. <li class="nav-group-task">
  164. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  165. </li>
  166. <li class="nav-group-task">
  167. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  168. </li>
  169. <li class="nav-group-task">
  170. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  171. </li>
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  216. </li>
  217. </ul>
  218. </li>
  219. <li class="nav-group-name">
  220. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  221. <ul class="nav-group-tasks">
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  265. </li>
  266. </ul>
  267. </li>
  268. <li class="nav-group-name">
  269. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  270. <ul class="nav-group-tasks">
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Extensions.html#/Protected">Protected</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  330. </li>
  331. </ul>
  332. </li>
  333. <li class="nav-group-name">
  334. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  335. <ul class="nav-group-tasks">
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  410. </li>
  411. </ul>
  412. </li>
  413. <li class="nav-group-name">
  414. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  415. <ul class="nav-group-tasks">
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  430. </li>
  431. <li class="nav-group-task">
  432. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  433. </li>
  434. <li class="nav-group-task">
  435. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  436. </li>
  437. <li class="nav-group-task">
  438. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  439. </li>
  440. <li class="nav-group-task">
  441. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  442. </li>
  443. <li class="nav-group-task">
  444. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  445. </li>
  446. <li class="nav-group-task">
  447. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  448. </li>
  449. <li class="nav-group-task">
  450. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  451. </li>
  452. <li class="nav-group-task">
  453. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  454. </li>
  455. <li class="nav-group-task">
  456. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  457. </li>
  458. <li class="nav-group-task">
  459. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  460. </li>
  461. <li class="nav-group-task">
  462. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  463. </li>
  464. <li class="nav-group-task">
  465. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  466. </li>
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  490. </li>
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  526. </li>
  527. </ul>
  528. </li>
  529. <li class="nav-group-name">
  530. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  531. <ul class="nav-group-tasks">
  532. <li class="nav-group-task">
  533. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  534. </li>
  535. <li class="nav-group-task">
  536. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  537. </li>
  538. <li class="nav-group-task">
  539. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  540. </li>
  541. <li class="nav-group-task">
  542. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  543. </li>
  544. <li class="nav-group-task">
  545. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  546. </li>
  547. <li class="nav-group-task">
  548. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  549. </li>
  550. <li class="nav-group-task">
  551. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  552. </li>
  553. </ul>
  554. </li>
  555. </ul>
  556. </nav>
  557. <article class="main-content">
  558. <section class="section">
  559. <div class="section-content top-matter">
  560. <h1>URLEncodedFormEncoder</h1>
  561. <div class="declaration">
  562. <div class="language">
  563. <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>
  564. </div>
  565. </div>
  566. <p>An object that encodes instances into URL-encoded query strings.</p>
  567. <p><code>ArrayEncoding</code> can be used to configure how <code>Array</code> values are encoded. By default, the <code>.brackets</code> encoding is
  568. used, encoding array values with brackets for each value. e.g <code>array[]=1&amp;array[]=2</code>.</p>
  569. <p><code>BoolEncoding</code> can be used to configure how <code>Bool</code> values are encoded. By default, the <code>.numeric</code> encoding is used,
  570. encoding <code>true</code> as <code>1</code> and <code>false</code> as <code>0</code>.</p>
  571. <p><code>DataEncoding</code> can be used to configure how <code>Data</code> values are encoded. By default, the <code>.deferredToData</code> encoding is
  572. used, which encodes <code>Data</code> values using their default <code>Encodable</code> implementation.</p>
  573. <p><code>DateEncoding</code> can be used to configure how <code>Date</code> values are encoded. By default, the <code>.deferredToDate</code>
  574. encoding is used, which encodes <code>Date</code>s using their default <code>Encodable</code> implementation.</p>
  575. <p><code>KeyEncoding</code> can be used to configure how keys are encoded. By default, the <code>.useDefaultKeys</code> encoding is used,
  576. which encodes the keys directly from the <code>Encodable</code> implementation.</p>
  577. <p><code>KeyPathEncoding</code> can be used to configure how paths within nested objects are encoded. By default, the <code>.brackets</code>
  578. encoding is used, which encodes each sub-key in brackets. e.g. <code>parent[child][grandchild]=value</code>.</p>
  579. <p><code>NilEncoding</code> can be used to configure how <code>nil</code> <code>Optional</code> values are encoded. By default, the <code>.dropKey</code> encoding
  580. is used, which drops <code>nil</code> key / value pairs from the output entirely.</p>
  581. <p><code>SpaceEncoding</code> can be used to configure how spaces are encoded. By default, the <code>.percentEscaped</code> encoding is used,
  582. replacing spaces with <code>%20</code>.</p>
  583. <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>
  584. </div>
  585. </section>
  586. <section class="section">
  587. <div class="section-content">
  588. <div class="task-group">
  589. <ul class="item-container">
  590. <li class="item">
  591. <div>
  592. <code>
  593. <a name="/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO"></a>
  594. <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
  595. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13ArrayEncodingO">ArrayEncoding</a>
  596. </code>
  597. </div>
  598. <div class="height-container">
  599. <div class="pointer-container"></div>
  600. <section class="section">
  601. <div class="pointer"></div>
  602. <div class="abstract">
  603. <p>Encoding to use for <code>Array</code> values.</p>
  604. <a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html" class="slightly-smaller">See more</a>
  605. </div>
  606. <div class="declaration">
  607. <h4>Declaration</h4>
  608. <div class="language">
  609. <p class="aside-title">Swift</p>
  610. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ArrayEncoding</span></code></pre>
  611. </div>
  612. </div>
  613. </section>
  614. </div>
  615. </li>
  616. <li class="item">
  617. <div>
  618. <code>
  619. <a name="/s:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO"></a>
  620. <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
  621. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12BoolEncodingO">BoolEncoding</a>
  622. </code>
  623. </div>
  624. <div class="height-container">
  625. <div class="pointer-container"></div>
  626. <section class="section">
  627. <div class="pointer"></div>
  628. <div class="abstract">
  629. <p>Encoding to use for <code>Bool</code> values.</p>
  630. <a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html" class="slightly-smaller">See more</a>
  631. </div>
  632. <div class="declaration">
  633. <h4>Declaration</h4>
  634. <div class="language">
  635. <p class="aside-title">Swift</p>
  636. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BoolEncoding</span></code></pre>
  637. </div>
  638. </div>
  639. </section>
  640. </div>
  641. </li>
  642. <li class="item">
  643. <div>
  644. <code>
  645. <a name="/s:9Alamofire21URLEncodedFormEncoderC12DataEncodingO"></a>
  646. <a name="//apple_ref/swift/Enum/DataEncoding" class="dashAnchor"></a>
  647. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DataEncodingO">DataEncoding</a>
  648. </code>
  649. </div>
  650. <div class="height-container">
  651. <div class="pointer-container"></div>
  652. <section class="section">
  653. <div class="pointer"></div>
  654. <div class="abstract">
  655. <p>Encoding to use for <code>Data</code> values.</p>
  656. <a href="../Classes/URLEncodedFormEncoder/DataEncoding.html" class="slightly-smaller">See more</a>
  657. </div>
  658. <div class="declaration">
  659. <h4>Declaration</h4>
  660. <div class="language">
  661. <p class="aside-title">Swift</p>
  662. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DataEncoding</span></code></pre>
  663. </div>
  664. </div>
  665. </section>
  666. </div>
  667. </li>
  668. <li class="item">
  669. <div>
  670. <code>
  671. <a name="/s:9Alamofire21URLEncodedFormEncoderC12DateEncodingO"></a>
  672. <a name="//apple_ref/swift/Enum/DateEncoding" class="dashAnchor"></a>
  673. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12DateEncodingO">DateEncoding</a>
  674. </code>
  675. </div>
  676. <div class="height-container">
  677. <div class="pointer-container"></div>
  678. <section class="section">
  679. <div class="pointer"></div>
  680. <div class="abstract">
  681. <p>Encoding to use for <code>Date</code> values.</p>
  682. <a href="../Classes/URLEncodedFormEncoder/DateEncoding.html" class="slightly-smaller">See more</a>
  683. </div>
  684. <div class="declaration">
  685. <h4>Declaration</h4>
  686. <div class="language">
  687. <p class="aside-title">Swift</p>
  688. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DateEncoding</span></code></pre>
  689. </div>
  690. </div>
  691. </section>
  692. </div>
  693. </li>
  694. <li class="item">
  695. <div>
  696. <code>
  697. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO"></a>
  698. <a name="//apple_ref/swift/Enum/KeyEncoding" class="dashAnchor"></a>
  699. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO">KeyEncoding</a>
  700. </code>
  701. </div>
  702. <div class="height-container">
  703. <div class="pointer-container"></div>
  704. <section class="section">
  705. <div class="pointer"></div>
  706. <div class="abstract">
  707. <p>Encoding to use for keys.</p>
  708. <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>
  709. 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>
  710. <a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html" class="slightly-smaller">See more</a>
  711. </div>
  712. <div class="declaration">
  713. <h4>Declaration</h4>
  714. <div class="language">
  715. <p class="aside-title">Swift</p>
  716. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">KeyEncoding</span></code></pre>
  717. </div>
  718. </div>
  719. </section>
  720. </div>
  721. </li>
  722. <li class="item">
  723. <div>
  724. <code>
  725. <a name="/s:9Alamofire21URLEncodedFormEncoderC15KeyPathEncodingV"></a>
  726. <a name="//apple_ref/swift/Struct/KeyPathEncoding" class="dashAnchor"></a>
  727. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC15KeyPathEncodingV">KeyPathEncoding</a>
  728. </code>
  729. </div>
  730. <div class="height-container">
  731. <div class="pointer-container"></div>
  732. <section class="section">
  733. <div class="pointer"></div>
  734. <div class="abstract">
  735. <p>Encoding to use for nested object and <code>Encodable</code> value key paths.</p>
  736. <pre class="highlight swift"><code><span class="p">[</span><span class="s">"parent"</span> <span class="p">:</span> <span class="p">[</span><span class="s">"child"</span> <span class="p">:</span> <span class="p">[</span><span class="s">"grandchild"</span><span class="p">:</span> <span class="s">"value"</span><span class="p">]]]</span>
  737. </code></pre>
  738. <p>This encoding affects how the <code>parent</code>, <code>child</code>, <code>grandchild</code> path is encoded. Brackets are used by default.
  739. e.g. <code>parent[child][grandchild]=value</code>.</p>
  740. <a href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html" class="slightly-smaller">See more</a>
  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="kd">struct</span> <span class="kt">KeyPathEncoding</span> <span class="p">:</span> <span class="kt">Sendable</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:9Alamofire21URLEncodedFormEncoderC11NilEncodingV"></a>
  756. <a name="//apple_ref/swift/Struct/NilEncoding" class="dashAnchor"></a>
  757. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11NilEncodingV">NilEncoding</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>Encoding to use for <code>nil</code> values.</p>
  766. <a href="../Classes/URLEncodedFormEncoder/NilEncoding.html" class="slightly-smaller">See more</a>
  767. </div>
  768. <div class="declaration">
  769. <h4>Declaration</h4>
  770. <div class="language">
  771. <p class="aside-title">Swift</p>
  772. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">NilEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  773. </div>
  774. </div>
  775. </section>
  776. </div>
  777. </li>
  778. <li class="item">
  779. <div>
  780. <code>
  781. <a name="/s:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO"></a>
  782. <a name="//apple_ref/swift/Enum/SpaceEncoding" class="dashAnchor"></a>
  783. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13SpaceEncodingO">SpaceEncoding</a>
  784. </code>
  785. </div>
  786. <div class="height-container">
  787. <div class="pointer-container"></div>
  788. <section class="section">
  789. <div class="pointer"></div>
  790. <div class="abstract">
  791. <p>Encoding to use for spaces.</p>
  792. <a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html" class="slightly-smaller">See more</a>
  793. </div>
  794. <div class="declaration">
  795. <h4>Declaration</h4>
  796. <div class="language">
  797. <p class="aside-title">Swift</p>
  798. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SpaceEncoding</span></code></pre>
  799. </div>
  800. </div>
  801. </section>
  802. </div>
  803. </li>
  804. <li class="item">
  805. <div>
  806. <code>
  807. <a name="/s:9Alamofire21URLEncodedFormEncoderC5ErrorO"></a>
  808. <a name="//apple_ref/swift/Enum/Error" class="dashAnchor"></a>
  809. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC5ErrorO">Error</a>
  810. </code>
  811. </div>
  812. <div class="height-container">
  813. <div class="pointer-container"></div>
  814. <section class="section">
  815. <div class="pointer"></div>
  816. <div class="abstract">
  817. <p><code><a href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a></code> error.</p>
  818. <a href="../Classes/URLEncodedFormEncoder/Error.html" class="slightly-smaller">See more</a>
  819. </div>
  820. <div class="declaration">
  821. <h4>Declaration</h4>
  822. <div class="language">
  823. <p class="aside-title">Swift</p>
  824. <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>
  825. </div>
  826. </div>
  827. </section>
  828. </div>
  829. </li>
  830. <li class="item">
  831. <div>
  832. <code>
  833. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp"></a>
  834. <a name="//apple_ref/swift/Property/alphabetizeKeyValuePairs" class="dashAnchor"></a>
  835. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairsSbvp">alphabetizeKeyValuePairs</a>
  836. </code>
  837. </div>
  838. <div class="height-container">
  839. <div class="pointer-container"></div>
  840. <section class="section">
  841. <div class="pointer"></div>
  842. <div class="abstract">
  843. <p>Whether or not to sort the encoded key value pairs.</p>
  844. <div class="aside aside-note">
  845. <p class="aside-title">Note</p>
  846. This setting ensures a consistent ordering for all encodings of the same parameters. When set to <code>false</code>,
  847. encoded <code>Dictionary</code> values may have a different encoded order each time they&rsquo;re encoded due to
  848. <code>Dictionary</code>&lsquo;s random storage order, but <code>Encodable</code> types will maintain their encoded order.
  849. </div>
  850. </div>
  851. <div class="declaration">
  852. <h4>Declaration</h4>
  853. <div class="language">
  854. <p class="aside-title">Swift</p>
  855. <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>
  856. </div>
  857. </div>
  858. </section>
  859. </div>
  860. </li>
  861. <li class="item">
  862. <div>
  863. <code>
  864. <a name="/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp"></a>
  865. <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
  866. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13arrayEncodingAC05ArrayF0Ovp">arrayEncoding</a>
  867. </code>
  868. </div>
  869. <div class="height-container">
  870. <div class="pointer-container"></div>
  871. <section class="section">
  872. <div class="pointer"></div>
  873. <div class="abstract">
  874. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use.</p>
  875. </div>
  876. <div class="declaration">
  877. <h4>Declaration</h4>
  878. <div class="language">
  879. <p class="aside-title">Swift</p>
  880. <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>
  881. </div>
  882. </div>
  883. </section>
  884. </div>
  885. </li>
  886. <li class="item">
  887. <div>
  888. <code>
  889. <a name="/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp"></a>
  890. <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
  891. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12boolEncodingAC04BoolF0Ovp">boolEncoding</a>
  892. </code>
  893. </div>
  894. <div class="height-container">
  895. <div class="pointer-container"></div>
  896. <section class="section">
  897. <div class="pointer"></div>
  898. <div class="abstract">
  899. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use.</p>
  900. </div>
  901. <div class="declaration">
  902. <h4>Declaration</h4>
  903. <div class="language">
  904. <p class="aside-title">Swift</p>
  905. <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>
  906. </div>
  907. </div>
  908. </section>
  909. </div>
  910. </li>
  911. <li class="item">
  912. <div>
  913. <code>
  914. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp"></a>
  915. <a name="//apple_ref/swift/Property/dataEncoding" class="dashAnchor"></a>
  916. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dataEncodingAC04DataF0Ovp">dataEncoding</a>
  917. </code>
  918. </div>
  919. <div class="height-container">
  920. <div class="pointer-container"></div>
  921. <section class="section">
  922. <div class="pointer"></div>
  923. <div class="abstract">
  924. <p>THe <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use.</p>
  925. </div>
  926. <div class="declaration">
  927. <h4>Declaration</h4>
  928. <div class="language">
  929. <p class="aside-title">Swift</p>
  930. <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>
  931. </div>
  932. </div>
  933. </section>
  934. </div>
  935. </li>
  936. <li class="item">
  937. <div>
  938. <code>
  939. <a name="/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp"></a>
  940. <a name="//apple_ref/swift/Property/dateEncoding" class="dashAnchor"></a>
  941. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC12dateEncodingAC04DateF0Ovp">dateEncoding</a>
  942. </code>
  943. </div>
  944. <div class="height-container">
  945. <div class="pointer-container"></div>
  946. <section class="section">
  947. <div class="pointer"></div>
  948. <div class="abstract">
  949. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use.</p>
  950. </div>
  951. <div class="declaration">
  952. <h4>Declaration</h4>
  953. <div class="language">
  954. <p class="aside-title">Swift</p>
  955. <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>
  956. </div>
  957. </div>
  958. </section>
  959. </div>
  960. </li>
  961. <li class="item">
  962. <div>
  963. <code>
  964. <a name="/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp"></a>
  965. <a name="//apple_ref/swift/Property/keyEncoding" class="dashAnchor"></a>
  966. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11keyEncodingAC03KeyF0Ovp">keyEncoding</a>
  967. </code>
  968. </div>
  969. <div class="height-container">
  970. <div class="pointer-container"></div>
  971. <section class="section">
  972. <div class="pointer"></div>
  973. <div class="abstract">
  974. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use.</p>
  975. </div>
  976. <div class="declaration">
  977. <h4>Declaration</h4>
  978. <div class="language">
  979. <p class="aside-title">Swift</p>
  980. <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>
  981. </div>
  982. </div>
  983. </section>
  984. </div>
  985. </li>
  986. <li class="item">
  987. <div>
  988. <code>
  989. <a name="/s:9Alamofire21URLEncodedFormEncoderC15keyPathEncodingAC03KeyfG0Vvp"></a>
  990. <a name="//apple_ref/swift/Property/keyPathEncoding" class="dashAnchor"></a>
  991. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC15keyPathEncodingAC03KeyfG0Vvp">keyPathEncoding</a>
  992. </code>
  993. </div>
  994. <div class="height-container">
  995. <div class="pointer-container"></div>
  996. <section class="section">
  997. <div class="pointer"></div>
  998. <div class="abstract">
  999. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">KeyPathEncoding</a></code> to use.</p>
  1000. </div>
  1001. <div class="declaration">
  1002. <h4>Declaration</h4>
  1003. <div class="language">
  1004. <p class="aside-title">Swift</p>
  1005. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">keyPathEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">KeyPathEncoding</a></span></code></pre>
  1006. </div>
  1007. </div>
  1008. </section>
  1009. </div>
  1010. </li>
  1011. <li class="item">
  1012. <div>
  1013. <code>
  1014. <a name="/s:9Alamofire21URLEncodedFormEncoderC11nilEncodingAC03NilF0Vvp"></a>
  1015. <a name="//apple_ref/swift/Property/nilEncoding" class="dashAnchor"></a>
  1016. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11nilEncodingAC03NilF0Vvp">nilEncoding</a>
  1017. </code>
  1018. </div>
  1019. <div class="height-container">
  1020. <div class="pointer-container"></div>
  1021. <section class="section">
  1022. <div class="pointer"></div>
  1023. <div class="abstract">
  1024. <p>The <code><a href="../Classes/URLEncodedFormEncoder/NilEncoding.html">NilEncoding</a></code> to use.</p>
  1025. </div>
  1026. <div class="declaration">
  1027. <h4>Declaration</h4>
  1028. <div class="language">
  1029. <p class="aside-title">Swift</p>
  1030. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">nilEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/NilEncoding.html">NilEncoding</a></span></code></pre>
  1031. </div>
  1032. </div>
  1033. </section>
  1034. </div>
  1035. </li>
  1036. <li class="item">
  1037. <div>
  1038. <code>
  1039. <a name="/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp"></a>
  1040. <a name="//apple_ref/swift/Property/spaceEncoding" class="dashAnchor"></a>
  1041. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC13spaceEncodingAC05SpaceF0Ovp">spaceEncoding</a>
  1042. </code>
  1043. </div>
  1044. <div class="height-container">
  1045. <div class="pointer-container"></div>
  1046. <section class="section">
  1047. <div class="pointer"></div>
  1048. <div class="abstract">
  1049. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use.</p>
  1050. </div>
  1051. <div class="declaration">
  1052. <h4>Declaration</h4>
  1053. <div class="language">
  1054. <p class="aside-title">Swift</p>
  1055. <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>
  1056. </div>
  1057. </div>
  1058. </section>
  1059. </div>
  1060. </li>
  1061. <li class="item">
  1062. <div>
  1063. <code>
  1064. <a name="/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp"></a>
  1065. <a name="//apple_ref/swift/Property/allowedCharacters" class="dashAnchor"></a>
  1066. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC17allowedCharacters10Foundation12CharacterSetVvp">allowedCharacters</a>
  1067. </code>
  1068. </div>
  1069. <div class="height-container">
  1070. <div class="pointer-container"></div>
  1071. <section class="section">
  1072. <div class="pointer"></div>
  1073. <div class="abstract">
  1074. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters.</p>
  1075. </div>
  1076. <div class="declaration">
  1077. <h4>Declaration</h4>
  1078. <div class="language">
  1079. <p class="aside-title">Swift</p>
  1080. <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>
  1081. </div>
  1082. </div>
  1083. </section>
  1084. </div>
  1085. </li>
  1086. <li class="item">
  1087. <div>
  1088. <code>
  1089. <a name="/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ00n4PathJ003nilJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC0foJ0VAC03NilJ0VAC05SpaceJ0O10Foundation12CharacterSetVtcfc"></a>
  1090. <a name="//apple_ref/swift/Method/init(alphabetizeKeyValuePairs:arrayEncoding:boolEncoding:dataEncoding:dateEncoding:keyEncoding:keyPathEncoding:nilEncoding:spaceEncoding:allowedCharacters:)" class="dashAnchor"></a>
  1091. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC24alphabetizeKeyValuePairs13arrayEncoding04boolJ004dataJ004dateJ003keyJ00n4PathJ003nilJ005spaceJ017allowedCharactersACSb_AC05ArrayJ0OAC04BoolJ0OAC04DataJ0OAC04DateJ0OAC0fJ0OAC0foJ0VAC03NilJ0VAC05SpaceJ0O10Foundation12CharacterSetVtcfc">init(alphabetizeKeyValuePairs:<wbr>arrayEncoding:<wbr>boolEncoding:<wbr>dataEncoding:<wbr>dateEncoding:<wbr>keyEncoding:<wbr>keyPathEncoding:<wbr>nilEncoding:<wbr>spaceEncoding:<wbr>allowedCharacters:<wbr>)</a>
  1092. </code>
  1093. </div>
  1094. <div class="height-container">
  1095. <div class="pointer-container"></div>
  1096. <section class="section">
  1097. <div class="pointer"></div>
  1098. <div class="abstract">
  1099. <p>Creates an instance from the supplied parameters.</p>
  1100. </div>
  1101. <div class="declaration">
  1102. <h4>Declaration</h4>
  1103. <div class="language">
  1104. <p class="aside-title">Swift</p>
  1105. <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>
  1106. <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>
  1107. <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>
  1108. <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>
  1109. <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>
  1110. <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>
  1111. <span class="nv">keyPathEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">KeyPathEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">brackets</span><span class="p">,</span>
  1112. <span class="nv">nilEncoding</span><span class="p">:</span> <span class="kt"><a href="../Classes/URLEncodedFormEncoder/NilEncoding.html">NilEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">dropKey</span><span class="p">,</span>
  1113. <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>
  1114. <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>
  1115. </div>
  1116. </div>
  1117. <div>
  1118. <h4>Parameters</h4>
  1119. <table class="graybox">
  1120. <tbody>
  1121. <tr>
  1122. <td>
  1123. <code>
  1124. <em>alphabetizeKeyValuePairs</em>
  1125. </code>
  1126. </td>
  1127. <td>
  1128. <div>
  1129. <p>Whether or not to sort the encoded key value pairs. <code>true</code> by default.</p>
  1130. </div>
  1131. </td>
  1132. </tr>
  1133. <tr>
  1134. <td>
  1135. <code>
  1136. <em>arrayEncoding</em>
  1137. </code>
  1138. </td>
  1139. <td>
  1140. <div>
  1141. <p>The <code><a href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
  1142. </div>
  1143. </td>
  1144. </tr>
  1145. <tr>
  1146. <td>
  1147. <code>
  1148. <em>boolEncoding</em>
  1149. </code>
  1150. </td>
  1151. <td>
  1152. <div>
  1153. <p>The <code><a href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
  1154. </div>
  1155. </td>
  1156. </tr>
  1157. <tr>
  1158. <td>
  1159. <code>
  1160. <em>dataEncoding</em>
  1161. </code>
  1162. </td>
  1163. <td>
  1164. <div>
  1165. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DataEncoding.html">DataEncoding</a></code> to use. <code>.base64</code> by default.</p>
  1166. </div>
  1167. </td>
  1168. </tr>
  1169. <tr>
  1170. <td>
  1171. <code>
  1172. <em>dateEncoding</em>
  1173. </code>
  1174. </td>
  1175. <td>
  1176. <div>
  1177. <p>The <code><a href="../Classes/URLEncodedFormEncoder/DateEncoding.html">DateEncoding</a></code> to use. <code>.deferredToDate</code> by default.</p>
  1178. </div>
  1179. </td>
  1180. </tr>
  1181. <tr>
  1182. <td>
  1183. <code>
  1184. <em>keyEncoding</em>
  1185. </code>
  1186. </td>
  1187. <td>
  1188. <div>
  1189. <p>The <code><a href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">KeyEncoding</a></code> to use. <code>.useDefaultKeys</code> by default.</p>
  1190. </div>
  1191. </td>
  1192. </tr>
  1193. <tr>
  1194. <td>
  1195. <code>
  1196. <em>nilEncoding</em>
  1197. </code>
  1198. </td>
  1199. <td>
  1200. <div>
  1201. <p>The <code><a href="../Classes/URLEncodedFormEncoder/NilEncoding.html">NilEncoding</a></code> to use. <code>.drop</code> by default.</p>
  1202. </div>
  1203. </td>
  1204. </tr>
  1205. <tr>
  1206. <td>
  1207. <code>
  1208. <em>spaceEncoding</em>
  1209. </code>
  1210. </td>
  1211. <td>
  1212. <div>
  1213. <p>The <code><a href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">SpaceEncoding</a></code> to use. <code>.percentEscaped</code> by default.</p>
  1214. </div>
  1215. </td>
  1216. </tr>
  1217. <tr>
  1218. <td>
  1219. <code>
  1220. <em>allowedCharacters</em>
  1221. </code>
  1222. </td>
  1223. <td>
  1224. <div>
  1225. <p>The <code>CharacterSet</code> of allowed (non-escaped) characters. <code>.afURLQueryAllowed</code> by
  1226. default.</p>
  1227. </div>
  1228. </td>
  1229. </tr>
  1230. </tbody>
  1231. </table>
  1232. </div>
  1233. </section>
  1234. </div>
  1235. </li>
  1236. <li class="item">
  1237. <div>
  1238. <code>
  1239. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF"></a>
  1240. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  1241. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodeySSSE_pKF">encode(_:<wbr>)</a>
  1242. </code>
  1243. </div>
  1244. <div class="height-container">
  1245. <div class="pointer-container"></div>
  1246. <section class="section">
  1247. <div class="pointer"></div>
  1248. <div class="abstract">
  1249. <p>Encodes the <code>value</code> as a URL form encoded <code>String</code>.</p>
  1250. <div class="aside aside-throws">
  1251. <p class="aside-title">Throws</p>
  1252. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  1253. </div>
  1254. </div>
  1255. <div class="declaration">
  1256. <h4>Declaration</h4>
  1257. <div class="language">
  1258. <p class="aside-title">Swift</p>
  1259. <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="n">any</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>
  1260. </div>
  1261. </div>
  1262. <div>
  1263. <h4>Parameters</h4>
  1264. <table class="graybox">
  1265. <tbody>
  1266. <tr>
  1267. <td>
  1268. <code>
  1269. <em>value</em>
  1270. </code>
  1271. </td>
  1272. <td>
  1273. <div>
  1274. <p>The <code>Encodable</code> value.</p>
  1275. </div>
  1276. </td>
  1277. </tr>
  1278. </tbody>
  1279. </table>
  1280. </div>
  1281. <div>
  1282. <h4>Return Value</h4>
  1283. <p>The encoded <code>String</code>.</p>
  1284. </div>
  1285. </section>
  1286. </div>
  1287. </li>
  1288. <li class="item">
  1289. <div>
  1290. <code>
  1291. <a name="/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF"></a>
  1292. <a name="//apple_ref/swift/Method/encode(_:)" class="dashAnchor"></a>
  1293. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC6encodey10Foundation4DataVSE_pKF">encode(_:<wbr>)</a>
  1294. </code>
  1295. </div>
  1296. <div class="height-container">
  1297. <div class="pointer-container"></div>
  1298. <section class="section">
  1299. <div class="pointer"></div>
  1300. <div class="abstract">
  1301. <p>Encodes the value as <code>Data</code>. This is performed by first creating an encoded <code>String</code> and then returning the
  1302. <code>.utf8</code> data.</p>
  1303. <div class="aside aside-throws">
  1304. <p class="aside-title">Throws</p>
  1305. <p>An <code><a href="../Classes/URLEncodedFormEncoder/Error.html">Error</a></code> or <code>EncodingError</code> instance if encoding fails.</p>
  1306. </div>
  1307. </div>
  1308. <div class="declaration">
  1309. <h4>Declaration</h4>
  1310. <div class="language">
  1311. <p class="aside-title">Swift</p>
  1312. <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="n">any</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>
  1313. </div>
  1314. </div>
  1315. <div>
  1316. <h4>Parameters</h4>
  1317. <table class="graybox">
  1318. <tbody>
  1319. <tr>
  1320. <td>
  1321. <code>
  1322. <em>value</em>
  1323. </code>
  1324. </td>
  1325. <td>
  1326. <div>
  1327. <p>The <code>Encodable</code> value.</p>
  1328. </div>
  1329. </td>
  1330. </tr>
  1331. </tbody>
  1332. </table>
  1333. </div>
  1334. <div>
  1335. <h4>Return Value</h4>
  1336. <p>The encoded <code>Data</code>.</p>
  1337. </div>
  1338. </section>
  1339. </div>
  1340. </li>
  1341. </ul>
  1342. </div>
  1343. </div>
  1344. </section>
  1345. </article>
  1346. </div>
  1347. <section class="footer">
  1348. <p>&copy; 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-10-19)</p>
  1349. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1350. </section>
  1351. </body>
  1352. </html>