URLEncoding.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118
  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.10.2 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="../Structs.html">Structures</a>
  46. <img class="carat" src="../img/carat.png" alt=""/>
  47. URLEncoding Structure 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>URLEncoding</h1>
  561. <div class="declaration">
  562. <div class="language">
  563. <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>
  564. </div>
  565. </div>
  566. <p>Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP
  567. body of the URL request. Whether the query string is set or appended to any existing URL query string or set as
  568. the HTTP body depends on the destination of the encoding.</p>
  569. <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
  570. <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
  571. <p>There is no published specification for how to encode collection types. By default the convention of appending
  572. <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for
  573. nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
  574. square brackets appended to array keys.</p>
  575. <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
  576. <code>true</code> as 1 and <code>false</code> as 0.</p>
  577. </div>
  578. </section>
  579. <section class="section">
  580. <div class="section-content">
  581. <div class="task-group">
  582. <div class="task-name-container">
  583. <a name="/Helper%20Types"></a>
  584. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  585. <div class="section-name-container">
  586. <a class="section-name-link" href="#/Helper%20Types"></a>
  587. <h3 class="section-name"><span>Helper Types</span>
  588. </h3>
  589. </div>
  590. </div>
  591. <ul class="item-container">
  592. <li class="item">
  593. <div>
  594. <code>
  595. <a name="/s:9Alamofire11URLEncodingV11DestinationO"></a>
  596. <a name="//apple_ref/swift/Enum/Destination" class="dashAnchor"></a>
  597. <a class="token" href="#/s:9Alamofire11URLEncodingV11DestinationO">Destination</a>
  598. </code>
  599. </div>
  600. <div class="height-container">
  601. <div class="pointer-container"></div>
  602. <section class="section">
  603. <div class="pointer"></div>
  604. <div class="abstract">
  605. <p>Defines whether the url-encoded query string is applied to the existing query string or HTTP body of the
  606. resulting URL request.</p>
  607. <a href="../Structs/URLEncoding/Destination.html" class="slightly-smaller">See more</a>
  608. </div>
  609. <div class="declaration">
  610. <h4>Declaration</h4>
  611. <div class="language">
  612. <p class="aside-title">Swift</p>
  613. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Destination</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  614. </div>
  615. </div>
  616. </section>
  617. </div>
  618. </li>
  619. <li class="item">
  620. <div>
  621. <code>
  622. <a name="/s:9Alamofire11URLEncodingV13ArrayEncodingO"></a>
  623. <a name="//apple_ref/swift/Enum/ArrayEncoding" class="dashAnchor"></a>
  624. <a class="token" href="#/s:9Alamofire11URLEncodingV13ArrayEncodingO">ArrayEncoding</a>
  625. </code>
  626. </div>
  627. <div class="height-container">
  628. <div class="pointer-container"></div>
  629. <section class="section">
  630. <div class="pointer"></div>
  631. <div class="abstract">
  632. <p>Configures how <code>Array</code> parameters are encoded.</p>
  633. <a href="../Structs/URLEncoding/ArrayEncoding.html" class="slightly-smaller">See more</a>
  634. </div>
  635. <div class="declaration">
  636. <h4>Declaration</h4>
  637. <div class="language">
  638. <p class="aside-title">Swift</p>
  639. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ArrayEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  640. </div>
  641. </div>
  642. </section>
  643. </div>
  644. </li>
  645. <li class="item">
  646. <div>
  647. <code>
  648. <a name="/s:9Alamofire11URLEncodingV12BoolEncodingO"></a>
  649. <a name="//apple_ref/swift/Enum/BoolEncoding" class="dashAnchor"></a>
  650. <a class="token" href="#/s:9Alamofire11URLEncodingV12BoolEncodingO">BoolEncoding</a>
  651. </code>
  652. </div>
  653. <div class="height-container">
  654. <div class="pointer-container"></div>
  655. <section class="section">
  656. <div class="pointer"></div>
  657. <div class="abstract">
  658. <p>Configures how <code>Bool</code> parameters are encoded.</p>
  659. <a href="../Structs/URLEncoding/BoolEncoding.html" class="slightly-smaller">See more</a>
  660. </div>
  661. <div class="declaration">
  662. <h4>Declaration</h4>
  663. <div class="language">
  664. <p class="aside-title">Swift</p>
  665. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">BoolEncoding</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
  666. </div>
  667. </div>
  668. </section>
  669. </div>
  670. </li>
  671. </ul>
  672. </div>
  673. <div class="task-group">
  674. <div class="task-name-container">
  675. <a name="/Properties"></a>
  676. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  677. <div class="section-name-container">
  678. <a class="section-name-link" href="#/Properties"></a>
  679. <h3 class="section-name"><span>Properties</span>
  680. </h3>
  681. </div>
  682. </div>
  683. <ul class="item-container">
  684. <li class="item">
  685. <div>
  686. <code>
  687. <a name="/s:9Alamofire11URLEncodingV7defaultACvpZ"></a>
  688. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  689. <a class="token" href="#/s:9Alamofire11URLEncodingV7defaultACvpZ">default</a>
  690. </code>
  691. </div>
  692. <div class="height-container">
  693. <div class="pointer-container"></div>
  694. <section class="section">
  695. <div class="pointer"></div>
  696. <div class="abstract">
  697. <p>Returns a default <code>URLEncoding</code> instance with a <code>.methodDependent</code> destination.</p>
  698. </div>
  699. <div class="declaration">
  700. <h4>Declaration</h4>
  701. <div class="language">
  702. <p class="aside-title">Swift</p>
  703. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">var</span> <span class="p">`</span><span class="nv">default</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>
  704. </div>
  705. </div>
  706. </section>
  707. </div>
  708. </li>
  709. <li class="item">
  710. <div>
  711. <code>
  712. <a name="/s:9Alamofire11URLEncodingV11queryStringACvpZ"></a>
  713. <a name="//apple_ref/swift/Variable/queryString" class="dashAnchor"></a>
  714. <a class="token" href="#/s:9Alamofire11URLEncodingV11queryStringACvpZ">queryString</a>
  715. </code>
  716. </div>
  717. <div class="height-container">
  718. <div class="pointer-container"></div>
  719. <section class="section">
  720. <div class="pointer"></div>
  721. <div class="abstract">
  722. <p>Returns a <code>URLEncoding</code> instance with a <code>.queryString</code> destination.</p>
  723. </div>
  724. <div class="declaration">
  725. <h4>Declaration</h4>
  726. <div class="language">
  727. <p class="aside-title">Swift</p>
  728. <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>
  729. </div>
  730. </div>
  731. </section>
  732. </div>
  733. </li>
  734. <li class="item">
  735. <div>
  736. <code>
  737. <a name="/s:9Alamofire11URLEncodingV8httpBodyACvpZ"></a>
  738. <a name="//apple_ref/swift/Variable/httpBody" class="dashAnchor"></a>
  739. <a class="token" href="#/s:9Alamofire11URLEncodingV8httpBodyACvpZ">httpBody</a>
  740. </code>
  741. </div>
  742. <div class="height-container">
  743. <div class="pointer-container"></div>
  744. <section class="section">
  745. <div class="pointer"></div>
  746. <div class="abstract">
  747. <p>Returns a <code>URLEncoding</code> instance with an <code>.httpBody</code> destination.</p>
  748. </div>
  749. <div class="declaration">
  750. <h4>Declaration</h4>
  751. <div class="language">
  752. <p class="aside-title">Swift</p>
  753. <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>
  754. </div>
  755. </div>
  756. </section>
  757. </div>
  758. </li>
  759. <li class="item">
  760. <div>
  761. <code>
  762. <a name="/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp"></a>
  763. <a name="//apple_ref/swift/Property/destination" class="dashAnchor"></a>
  764. <a class="token" href="#/s:9Alamofire11URLEncodingV11destinationAC11DestinationOvp">destination</a>
  765. </code>
  766. </div>
  767. <div class="height-container">
  768. <div class="pointer-container"></div>
  769. <section class="section">
  770. <div class="pointer"></div>
  771. <div class="abstract">
  772. <p>The destination defining where the encoded query string is to be applied to the URL request.</p>
  773. </div>
  774. <div class="declaration">
  775. <h4>Declaration</h4>
  776. <div class="language">
  777. <p class="aside-title">Swift</p>
  778. <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>
  779. </div>
  780. </div>
  781. </section>
  782. </div>
  783. </li>
  784. <li class="item">
  785. <div>
  786. <code>
  787. <a name="/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp"></a>
  788. <a name="//apple_ref/swift/Property/arrayEncoding" class="dashAnchor"></a>
  789. <a class="token" href="#/s:9Alamofire11URLEncodingV13arrayEncodingAC05ArrayD0Ovp">arrayEncoding</a>
  790. </code>
  791. </div>
  792. <div class="height-container">
  793. <div class="pointer-container"></div>
  794. <section class="section">
  795. <div class="pointer"></div>
  796. <div class="abstract">
  797. <p>The encoding to use for <code>Array</code> parameters.</p>
  798. </div>
  799. <div class="declaration">
  800. <h4>Declaration</h4>
  801. <div class="language">
  802. <p class="aside-title">Swift</p>
  803. <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>
  804. </div>
  805. </div>
  806. </section>
  807. </div>
  808. </li>
  809. <li class="item">
  810. <div>
  811. <code>
  812. <a name="/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp"></a>
  813. <a name="//apple_ref/swift/Property/boolEncoding" class="dashAnchor"></a>
  814. <a class="token" href="#/s:9Alamofire11URLEncodingV12boolEncodingAC04BoolD0Ovp">boolEncoding</a>
  815. </code>
  816. </div>
  817. <div class="height-container">
  818. <div class="pointer-container"></div>
  819. <section class="section">
  820. <div class="pointer"></div>
  821. <div class="abstract">
  822. <p>The encoding to use for <code>Bool</code> parameters.</p>
  823. </div>
  824. <div class="declaration">
  825. <h4>Declaration</h4>
  826. <div class="language">
  827. <p class="aside-title">Swift</p>
  828. <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>
  829. </div>
  830. </div>
  831. </section>
  832. </div>
  833. </li>
  834. </ul>
  835. </div>
  836. <div class="task-group">
  837. <div class="task-name-container">
  838. <a name="/Initialization"></a>
  839. <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a>
  840. <div class="section-name-container">
  841. <a class="section-name-link" href="#/Initialization"></a>
  842. <h3 class="section-name"><span>Initialization</span>
  843. </h3>
  844. </div>
  845. </div>
  846. <ul class="item-container">
  847. <li class="item">
  848. <div>
  849. <code>
  850. <a name="/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc"></a>
  851. <a name="//apple_ref/swift/Method/init(destination:arrayEncoding:boolEncoding:)" class="dashAnchor"></a>
  852. <a class="token" href="#/s:9Alamofire11URLEncodingV11destination13arrayEncoding04boolE0A2C11DestinationO_AC05ArrayE0OAC04BoolE0Otcfc">init(destination:<wbr>arrayEncoding:<wbr>boolEncoding:<wbr>)</a>
  853. </code>
  854. </div>
  855. <div class="height-container">
  856. <div class="pointer-container"></div>
  857. <section class="section">
  858. <div class="pointer"></div>
  859. <div class="abstract">
  860. <p>Creates an instance using the specified parameters.</p>
  861. </div>
  862. <div class="declaration">
  863. <h4>Declaration</h4>
  864. <div class="language">
  865. <p class="aside-title">Swift</p>
  866. <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>
  867. <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>
  868. <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>
  869. </div>
  870. </div>
  871. <div>
  872. <h4>Parameters</h4>
  873. <table class="graybox">
  874. <tbody>
  875. <tr>
  876. <td>
  877. <code>
  878. <em>destination</em>
  879. </code>
  880. </td>
  881. <td>
  882. <div>
  883. <p><code><a href="../Structs/URLEncoding/Destination.html">Destination</a></code> defining where the encoded query string will be applied. <code>.methodDependent</code> by
  884. default.</p>
  885. </div>
  886. </td>
  887. </tr>
  888. <tr>
  889. <td>
  890. <code>
  891. <em>arrayEncoding</em>
  892. </code>
  893. </td>
  894. <td>
  895. <div>
  896. <p><code><a href="../Structs/URLEncoding/ArrayEncoding.html">ArrayEncoding</a></code> to use. <code>.brackets</code> by default.</p>
  897. </div>
  898. </td>
  899. </tr>
  900. <tr>
  901. <td>
  902. <code>
  903. <em>boolEncoding</em>
  904. </code>
  905. </td>
  906. <td>
  907. <div>
  908. <p><code><a href="../Structs/URLEncoding/BoolEncoding.html">BoolEncoding</a></code> to use. <code>.numeric</code> by default.</p>
  909. </div>
  910. </td>
  911. </tr>
  912. </tbody>
  913. </table>
  914. </div>
  915. </section>
  916. </div>
  917. </li>
  918. </ul>
  919. </div>
  920. <div class="task-group">
  921. <div class="task-name-container">
  922. <a name="/Encoding"></a>
  923. <a name="//apple_ref/swift/Section/Encoding" class="dashAnchor"></a>
  924. <div class="section-name-container">
  925. <a class="section-name-link" href="#/Encoding"></a>
  926. <h3 class="section-name"><span>Encoding</span>
  927. </h3>
  928. </div>
  929. </div>
  930. <ul class="item-container">
  931. <li class="item">
  932. <div>
  933. <code>
  934. <a name="/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSs8Sendable_pGSgtKF"></a>
  935. <a name="//apple_ref/swift/Method/encode(_:with:)" class="dashAnchor"></a>
  936. <a class="token" href="#/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSs8Sendable_pGSgtKF">encode(_:<wbr>with:<wbr>)</a>
  937. </code>
  938. </div>
  939. <div class="height-container">
  940. <div class="pointer-container"></div>
  941. <section class="section">
  942. <div class="pointer"></div>
  943. <div class="abstract">
  944. </div>
  945. <div class="declaration">
  946. <h4>Declaration</h4>
  947. <div class="language">
  948. <p class="aside-title">Swift</p>
  949. <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="kd">any</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>
  950. </div>
  951. </div>
  952. </section>
  953. </div>
  954. </li>
  955. <li class="item">
  956. <div>
  957. <code>
  958. <a name="/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF"></a>
  959. <a name="//apple_ref/swift/Method/queryComponents(fromKey:value:)" class="dashAnchor"></a>
  960. <a class="token" href="#/s:9Alamofire11URLEncodingV15queryComponents7fromKey5valueSaySS_SStGSS_yptF">queryComponents(fromKey:<wbr>value:<wbr>)</a>
  961. </code>
  962. </div>
  963. <div class="height-container">
  964. <div class="pointer-container"></div>
  965. <section class="section">
  966. <div class="pointer"></div>
  967. <div class="abstract">
  968. <p>Creates a percent-escaped, URL encoded query string components from the given key-value pair recursively.</p>
  969. </div>
  970. <div class="declaration">
  971. <h4>Declaration</h4>
  972. <div class="language">
  973. <p class="aside-title">Swift</p>
  974. <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>
  975. </div>
  976. </div>
  977. <div>
  978. <h4>Parameters</h4>
  979. <table class="graybox">
  980. <tbody>
  981. <tr>
  982. <td>
  983. <code>
  984. <em>key</em>
  985. </code>
  986. </td>
  987. <td>
  988. <div>
  989. <p>Key of the query component.</p>
  990. </div>
  991. </td>
  992. </tr>
  993. <tr>
  994. <td>
  995. <code>
  996. <em>value</em>
  997. </code>
  998. </td>
  999. <td>
  1000. <div>
  1001. <p>Value of the query component.</p>
  1002. </div>
  1003. </td>
  1004. </tr>
  1005. </tbody>
  1006. </table>
  1007. </div>
  1008. <div>
  1009. <h4>Return Value</h4>
  1010. <p>The percent-escaped, URL encoded query string components.</p>
  1011. </div>
  1012. </section>
  1013. </div>
  1014. </li>
  1015. <li class="item">
  1016. <div>
  1017. <code>
  1018. <a name="/s:9Alamofire11URLEncodingV6escapeyS2SF"></a>
  1019. <a name="//apple_ref/swift/Method/escape(_:)" class="dashAnchor"></a>
  1020. <a class="token" href="#/s:9Alamofire11URLEncodingV6escapeyS2SF">escape(_:<wbr>)</a>
  1021. </code>
  1022. </div>
  1023. <div class="height-container">
  1024. <div class="pointer-container"></div>
  1025. <section class="section">
  1026. <div class="pointer"></div>
  1027. <div class="abstract">
  1028. <p>Creates a percent-escaped string following RFC 3986 for a query string key or value.</p>
  1029. </div>
  1030. <div class="declaration">
  1031. <h4>Declaration</h4>
  1032. <div class="language">
  1033. <p class="aside-title">Swift</p>
  1034. <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>
  1035. </div>
  1036. </div>
  1037. <div>
  1038. <h4>Parameters</h4>
  1039. <table class="graybox">
  1040. <tbody>
  1041. <tr>
  1042. <td>
  1043. <code>
  1044. <em>string</em>
  1045. </code>
  1046. </td>
  1047. <td>
  1048. <div>
  1049. <p><code>String</code> to be percent-escaped.</p>
  1050. </div>
  1051. </td>
  1052. </tr>
  1053. </tbody>
  1054. </table>
  1055. </div>
  1056. <div>
  1057. <h4>Return Value</h4>
  1058. <p>The percent-escaped <code>String</code>.</p>
  1059. </div>
  1060. </section>
  1061. </div>
  1062. </li>
  1063. </ul>
  1064. </div>
  1065. </div>
  1066. </section>
  1067. </article>
  1068. </div>
  1069. <section class="footer">
  1070. <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-11-24)</p>
  1071. <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>
  1072. </section>
  1073. </body>
  1074. </html>