URLEncoding.html 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>URLEncoding Structure 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/Struct/URLEncoding" class="dashAnchor"></a>
  16. <a title="URLEncoding Structure 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.8.0 Docs
  21. </a>
  22. (97% 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 Reference</a>
  44. <img class="carat" src="../img/carat.png" alt=""/>
  45. URLEncoding Structure 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/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  260. </li>
  261. </ul>
  262. </li>
  263. <li class="nav-group-name">
  264. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  265. <ul class="nav-group-tasks">
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  319. </li>
  320. </ul>
  321. </li>
  322. <li class="nav-group-name">
  323. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  324. <ul class="nav-group-tasks">
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  396. </li>
  397. </ul>
  398. </li>
  399. <li class="nav-group-name">
  400. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  401. <ul class="nav-group-tasks">
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  506. </li>
  507. </ul>
  508. </li>
  509. <li class="nav-group-name">
  510. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  511. <ul class="nav-group-tasks">
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  529. </li>
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  532. </li>
  533. </ul>
  534. </li>
  535. </ul>
  536. </nav>
  537. <article class="main-content">
  538. <section class="section">
  539. <div class="section-content top-matter">
  540. <h1>URLEncoding</h1>
  541. <div class="declaration">
  542. <div class="language">
  543. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">URLEncoding</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
  544. </div>
  545. </div>
  546. <p>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
  547. body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
  548. the HTTP body depends on the destination of the encoding.</p>
  549. <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
  550. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  551. <p>There is no published specification for how to encode collection types. By default the convention of appending
  552. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  553. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  554. square brackets appended to array keys.</p>
  555. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  556. <code>true</code> as 1 and <code>false</code> as 0.</p>
  557. </div>
  558. </section>
  559. <section class="section">
  560. <div class="section-content">
  561. <div class="task-group">
  562. <div class="task-name-container">
  563. <a name="/Helper%20Types"></a>
  564. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  565. <div class="section-name-container">
  566. <a class="section-name-link" href="#/Helper%20Types"></a>
  567. <h3 class="section-name"><span>Helper Types</span>
  568. </h3>
  569. </div>
  570. </div>
  571. <ul class="item-container">
  572. <li class="item">
  573. <div>
  574. <code>
  575. <a name="/s:9Alamofire11URLEncodingV11DestinationO"></a>
  576. <a name="//apple_ref/swift/Enum/Destination" class="dashAnchor"></a>
  577. <a class="token" href="#/s:9Alamofire11URLEncodingV11DestinationO">Destination</a>
  578. </code>
  579. </div>
  580. <div class="height-container">
  581. <div class="pointer-container"></div>
  582. <section class="section">
  583. <div class="pointer"></div>
  584. <div class="abstract">
  585. <p>Defines whether the url-encoded query string is applied to the existing query string or HTTP body of the
  586. resulting URL request.</p>
  587. <a href="../Structs/URLEncoding/Destination.html" class="slightly-smaller">See more</a>
  588. </div>
  589. <div class="declaration">
  590. <h4>Declaration</h4>
  591. <div class="language">
  592. <p class="aside-title">Swift</p>
  593. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Destination</span></code></pre>
  594. </div>
  595. </div>
  596. </section>
  597. </div>
  598. </li>
  599. <li class="item">
  600. <div>
  601. <code>
  602. <a name="/s:9Alamofire11URLEncodingV13ArrayEncodingO"></a>
  603. <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
  604. <a class="token" href="#/s:9Alamofire11URLEncodingV13ArrayEncodingO">ArrayEncoding</a>
  605. </code>
  606. </div>
  607. <div class="height-container">
  608. <div class="pointer-container"></div>
  609. <section class="section">
  610. <div class="pointer"></div>
  611. <div class="abstract">
  612. <p>Configures how <code>Array</code> parameters are encoded.</p>
  613. <a href="../Structs/URLEncoding/ArrayEncoding.html" class="slightly-smaller">See more</a>
  614. </div>
  615. <div class="declaration">
  616. <h4>Declaration</h4>
  617. <div class="language">
  618. <p class="aside-title">Swift</p>
  619. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ArrayEncoding</span></code></pre>
  620. </div>
  621. </div>
  622. </section>
  623. </div>
  624. </li>
  625. <li class="item">
  626. <div>
  627. <code>
  628. <a name="/s:9Alamofire11URLEncodingV12BoolEncodingO"></a>
  629. <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
  630. <a class="token" href="#/s:9Alamofire11URLEncodingV12BoolEncodingO">BoolEncoding</a>
  631. </code>
  632. </div>
  633. <div class="height-container">
  634. <div class="pointer-container"></div>
  635. <section class="section">
  636. <div class="pointer"></div>
  637. <div class="abstract">
  638. <p>Configures how <code>Bool</code> parameters are encoded.</p>
  639. <a href="../Structs/URLEncoding/BoolEncoding.html" class="slightly-smaller">See more</a>
  640. </div>
  641. <div class="declaration">
  642. <h4>Declaration</h4>
  643. <div class="language">
  644. <p class="aside-title">Swift</p>
  645. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BoolEncoding</span></code></pre>
  646. </div>
  647. </div>
  648. </section>
  649. </div>
  650. </li>
  651. </ul>
  652. </div>
  653. <div class="task-group">
  654. <div class="task-name-container">
  655. <a name="/Properties"></a>
  656. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  657. <div class="section-name-container">
  658. <a class="section-name-link" href="#/Properties"></a>
  659. <h3 class="section-name"><span>Properties</span>
  660. </h3>
  661. </div>
  662. </div>
  663. <ul class="item-container">
  664. <li class="item">
  665. <div>
  666. <code>
  667. <a name="/s:9Alamofire11URLEncodingV7defaultACvpZ"></a>
  668. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  669. <a class="token" href="#/s:9Alamofire11URLEncodingV7defaultACvpZ">default</a>
  670. </code>
  671. </div>
  672. <div class="height-container">
  673. <div class="pointer-container"></div>
  674. <section class="section">
  675. <div class="pointer"></div>
  676. <div class="abstract">
  677. <p>Returns a default <code>URLEncoding</code> instance with a <code>.methodDependent</code> destination.</p>
  678. </div>
  679. <div class="declaration">
  680. <h4>Declaration</h4>
  681. <div class="language">
  682. <p class="aside-title">Swift</p>
  683. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">var</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  684. </div>
  685. </div>
  686. </section>
  687. </div>
  688. </li>
  689. <li class="item">
  690. <div>
  691. <code>
  692. <a name="/s:9Alamofire11URLEncodingV11queryStringACvpZ"></a>
  693. <a name="//apple_ref/swift/Variable/queryString" class="dashAnchor"></a>
  694. <a class="token" href="#/s:9Alamofire11URLEncodingV11queryStringACvpZ">queryString</a>
  695. </code>
  696. </div>
  697. <div class="height-container">
  698. <div class="pointer-container"></div>
  699. <section class="section">
  700. <div class="pointer"></div>
  701. <div class="abstract">
  702. <p>Returns a <code>URLEncoding</code> instance with a <code>.queryString</code> destination.</p>
  703. </div>
  704. <div class="declaration">
  705. <h4>Declaration</h4>
  706. <div class="language">
  707. <p class="aside-title">Swift</p>
  708. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">queryString</span><span class="p">:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  709. </div>
  710. </div>
  711. </section>
  712. </div>
  713. </li>
  714. <li class="item">
  715. <div>
  716. <code>
  717. <a name="/s:9Alamofire11URLEncodingV8httpBodyACvpZ"></a>
  718. <a name="//apple_ref/swift/Variable/httpBody" class="dashAnchor"></a>
  719. <a class="token" href="#/s:9Alamofire11URLEncodingV8httpBodyACvpZ">httpBody</a>
  720. </code>
  721. </div>
  722. <div class="height-container">
  723. <div class="pointer-container"></div>
  724. <section class="section">
  725. <div class="pointer"></div>
  726. <div class="abstract">
  727. <p>Returns a <code>URLEncoding</code> instance with an <code>.httpBody</code> destination.</p>
  728. </div>
  729. <div class="declaration">
  730. <h4>Declaration</h4>
  731. <div class="language">
  732. <p class="aside-title">Swift</p>
  733. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">httpBody</span><span class="p">:</span> <span class="kt">URLEncoding</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  734. </div>
  735. </div>
  736. </section>
  737. </div>
  738. </li>
  739. <li class="item">
  740. <div>
  741. <code>
  742. <a name="/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp"></a>
  743. <a name="//apple_ref/swift/Property/destination" class="dashAnchor"></a>
  744. <a class="token" href="#/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp">destination</a>
  745. </code>
  746. </div>
  747. <div class="height-container">
  748. <div class="pointer-container"></div>
  749. <section class="section">
  750. <div class="pointer"></div>
  751. <div class="abstract">
  752. <p>The destination defining where the encoded query string is to be applied to the URL request.</p>
  753. </div>
  754. <div class="declaration">
  755. <h4>Declaration</h4>
  756. <div class="language">
  757. <p class="aside-title">Swift</p>
  758. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/Destination.html">Destination</a></span></code></pre>
  759. </div>
  760. </div>
  761. </section>
  762. </div>
  763. </li>
  764. <li class="item">
  765. <div>
  766. <code>
  767. <a name="/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp"></a>
  768. <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
  769. <a class="token" href="#/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp">arrayEncoding</a>
  770. </code>
  771. </div>
  772. <div class="height-container">
  773. <div class="pointer-container"></div>
  774. <section class="section">
  775. <div class="pointer"></div>
  776. <div class="abstract">
  777. <p>The encoding to use for <code>Array</code> parameters.</p>
  778. </div>
  779. <div class="declaration">
  780. <h4>Declaration</h4>
  781. <div class="language">
  782. <p class="aside-title">Swift</p>
  783. <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="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></span></code></pre>
  784. </div>
  785. </div>
  786. </section>
  787. </div>
  788. </li>
  789. <li class="item">
  790. <div>
  791. <code>
  792. <a name="/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp"></a>
  793. <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
  794. <a class="token" href="#/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp">boolEncoding</a>
  795. </code>
  796. </div>
  797. <div class="height-container">
  798. <div class="pointer-container"></div>
  799. <section class="section">
  800. <div class="pointer"></div>
  801. <div class="abstract">
  802. <p>The encoding to use for <code>Bool</code> parameters.</p>
  803. </div>
  804. <div class="declaration">
  805. <h4>Declaration</h4>
  806. <div class="language">
  807. <p class="aside-title">Swift</p>
  808. <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="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></span></code></pre>
  809. </div>
  810. </div>
  811. </section>
  812. </div>
  813. </li>
  814. </ul>
  815. </div>
  816. <div class="task-group">
  817. <div class="task-name-container">
  818. <a name="/Initialization"></a>
  819. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  820. <div class="section-name-container">
  821. <a class="section-name-link" href="#/Initialization"></a>
  822. <h3 class="section-name"><span>Initialization</span>
  823. </h3>
  824. </div>
  825. </div>
  826. <ul class="item-container">
  827. <li class="item">
  828. <div>
  829. <code>
  830. <a name="/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc"></a>
  831. <a name="//apple_ref/swift/Method/init(destination:arrayEncoding:boolEncoding:)" class="dashAnchor"></a>
  832. <a class="token" href="#/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc">init(destination:<wbr>arrayEncoding:<wbr>boolEncoding:<wbr>)</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>Creates an instance using the specified parameters.</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="nf">init</span><span class="p">(</span><span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/Destination.html">Destination</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">methodDependent</span><span class="p">,</span>
  847. <span class="nv">arrayEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">brackets</span><span class="p">,</span>
  848. <span class="nv">boolEncoding</span><span class="p">:</span> <span class="kt"><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">numeric</span><span class="p">)</span></code></pre>
  849. </div>
  850. </div>
  851. <div>
  852. <h4>Parameters</h4>
  853. <table class="graybox">
  854. <tbody>
  855. <tr>
  856. <td>
  857. <code>
  858. <em>destination</em>
  859. </code>
  860. </td>
  861. <td>
  862. <div>
  863. <p><code><a href="../Structs/URLEncoding/Destination.html">Destination</a></code> defining where the encoded query string will be applied. <code>.methodDependent</code> by
  864. default.</p>
  865. </div>
  866. </td>
  867. </tr>
  868. <tr>
  869. <td>
  870. <code>
  871. <em>arrayEncoding</em>
  872. </code>
  873. </td>
  874. <td>
  875. <div>
  876. <p><code><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
  877. </div>
  878. </td>
  879. </tr>
  880. <tr>
  881. <td>
  882. <code>
  883. <em>boolEncoding</em>
  884. </code>
  885. </td>
  886. <td>
  887. <div>
  888. <p><code><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
  889. </div>
  890. </td>
  891. </tr>
  892. </tbody>
  893. </table>
  894. </div>
  895. </section>
  896. </div>
  897. </li>
  898. </ul>
  899. </div>
  900. <div class="task-group">
  901. <div class="task-name-container">
  902. <a name="/Encoding"></a>
  903. <a name="//apple_ref/swift/Section/Encoding" class="dashAnchor"></a>
  904. <div class="section-name-container">
  905. <a class="section-name-link" href="#/Encoding"></a>
  906. <h3 class="section-name"><span>Encoding</span>
  907. </h3>
  908. </div>
  909. </div>
  910. <ul class="item-container">
  911. <li class="item">
  912. <div>
  913. <code>
  914. <a name="/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSypGSgtKF"></a>
  915. <a name="//apple_ref/swift/Method/encode(_:with:)" class="dashAnchor"></a>
  916. <a class="token" href="#/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSypGSgtKF">encode(_:<wbr>with:<wbr>)</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. </div>
  925. <div class="declaration">
  926. <h4>Declaration</h4>
  927. <div class="language">
  928. <p class="aside-title">Swift</p>
  929. <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">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="n">with</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">URLRequest</span></code></pre>
  930. </div>
  931. </div>
  932. </section>
  933. </div>
  934. </li>
  935. <li class="item">
  936. <div>
  937. <code>
  938. <a name="/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF"></a>
  939. <a name="//apple_ref/swift/Method/queryComponents(fromKey:value:)" class="dashAnchor"></a>
  940. <a class="token" href="#/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF">queryComponents(fromKey:<wbr>value:<wbr>)</a>
  941. </code>
  942. </div>
  943. <div class="height-container">
  944. <div class="pointer-container"></div>
  945. <section class="section">
  946. <div class="pointer"></div>
  947. <div class="abstract">
  948. <p>Creates a percent-escaped, URL encoded query string components from the given key-value pair recursively.</p>
  949. </div>
  950. <div class="declaration">
  951. <h4>Declaration</h4>
  952. <div class="language">
  953. <p class="aside-title">Swift</p>
  954. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">queryComponents</span><span class="p">(</span><span class="n">fromKey</span> <span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span></code></pre>
  955. </div>
  956. </div>
  957. <div>
  958. <h4>Parameters</h4>
  959. <table class="graybox">
  960. <tbody>
  961. <tr>
  962. <td>
  963. <code>
  964. <em>key</em>
  965. </code>
  966. </td>
  967. <td>
  968. <div>
  969. <p>Key of the query component.</p>
  970. </div>
  971. </td>
  972. </tr>
  973. <tr>
  974. <td>
  975. <code>
  976. <em>value</em>
  977. </code>
  978. </td>
  979. <td>
  980. <div>
  981. <p>Value of the query component.</p>
  982. </div>
  983. </td>
  984. </tr>
  985. </tbody>
  986. </table>
  987. </div>
  988. <div>
  989. <h4>Return Value</h4>
  990. <p>The percent-escaped, URL encoded query string components.</p>
  991. </div>
  992. </section>
  993. </div>
  994. </li>
  995. <li class="item">
  996. <div>
  997. <code>
  998. <a name="/s:9Alamofire11URLEncodingV6escapeyS2SF"></a>
  999. <a name="//apple_ref/swift/Method/escape(_:)" class="dashAnchor"></a>
  1000. <a class="token" href="#/s:9Alamofire11URLEncodingV6escapeyS2SF">escape(_:<wbr>)</a>
  1001. </code>
  1002. </div>
  1003. <div class="height-container">
  1004. <div class="pointer-container"></div>
  1005. <section class="section">
  1006. <div class="pointer"></div>
  1007. <div class="abstract">
  1008. <p>Creates a percent-escaped string following RFC 3986 for a query string key or value.</p>
  1009. </div>
  1010. <div class="declaration">
  1011. <h4>Declaration</h4>
  1012. <div class="language">
  1013. <p class="aside-title">Swift</p>
  1014. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">escape</span><span class="p">(</span><span class="n">_</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
  1015. </div>
  1016. </div>
  1017. <div>
  1018. <h4>Parameters</h4>
  1019. <table class="graybox">
  1020. <tbody>
  1021. <tr>
  1022. <td>
  1023. <code>
  1024. <em>string</em>
  1025. </code>
  1026. </td>
  1027. <td>
  1028. <div>
  1029. <p><code>String</code> to be percent-escaped.</p>
  1030. </div>
  1031. </td>
  1032. </tr>
  1033. </tbody>
  1034. </table>
  1035. </div>
  1036. <div>
  1037. <h4>Return Value</h4>
  1038. <p>The percent-escaped <code>String</code>.</p>
  1039. </div>
  1040. </section>
  1041. </div>
  1042. </li>
  1043. </ul>
  1044. </div>
  1045. </div>
  1046. </section>
  1047. </article>
  1048. </div>
  1049. <section class="footer">
  1050. <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-08-31)</p>
  1051. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1052. </section>
  1053. </body>
  1054. </html>