KeyEncoding.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>KeyEncoding Enumeration 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/Enum/KeyEncoding" class="dashAnchor"></a>
  16. <a title="KeyEncoding Enumeration Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../../index.html">
  20. Alamofire 5.10.1 Docs
  21. </a>
  22. (96% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../../img/gh.png" alt="GitHub"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../../img/dash.png" alt="Dash"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../../index.html">Alamofire</a>
  44. <img class="carat" src="../../img/carat.png" alt=""/>
  45. <a class="breadcrumb" href="../../Classes.html">Classes</a>
  46. <img class="carat" src="../../img/carat.png" alt=""/>
  47. <a class="breadcrumb" href="../../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  48. <img class="carat" src="../../img/carat.png" alt=""/>
  49. KeyEncoding Enumeration Reference
  50. </p>
  51. <div class="content-wrapper">
  52. <nav class="navigation">
  53. <ul class="nav-groups">
  54. <li class="nav-group-name">
  55. <a class="nav-group-name-link" href="../../Classes.html">Classes</a>
  56. <ul class="nav-group-tasks">
  57. <li class="nav-group-task">
  58. <a class="nav-group-task-link" href="../../Classes/Adapter.html">Adapter</a>
  59. </li>
  60. <li class="nav-group-task">
  61. <a class="nav-group-task-link" href="../../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  62. </li>
  63. <li class="nav-group-task">
  64. <a class="nav-group-task-link" href="../../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  65. </li>
  66. <li class="nav-group-task">
  67. <a class="nav-group-task-link" href="../../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  68. </li>
  69. <li class="nav-group-task">
  70. <a class="nav-group-task-link" href="../../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  71. </li>
  72. <li class="nav-group-task">
  73. <a class="nav-group-task-link" href="../../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  74. </li>
  75. <li class="nav-group-task">
  76. <a class="nav-group-task-link" href="../../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  77. </li>
  78. <li class="nav-group-task">
  79. <a class="nav-group-task-link" href="../../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  80. </li>
  81. <li class="nav-group-task">
  82. <a class="nav-group-task-link" href="../../Classes/DataRequest.html">DataRequest</a>
  83. </li>
  84. <li class="nav-group-task">
  85. <a class="nav-group-task-link" href="../../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  86. </li>
  87. <li class="nav-group-task">
  88. <a class="nav-group-task-link" href="../../Classes/DataStreamRequest.html">DataStreamRequest</a>
  89. </li>
  90. <li class="nav-group-task">
  91. <a class="nav-group-task-link" href="../../Classes/DataStreamRequest/Stream.html">– Stream</a>
  92. </li>
  93. <li class="nav-group-task">
  94. <a class="nav-group-task-link" href="../../Classes/DataStreamRequest/Event.html">– Event</a>
  95. </li>
  96. <li class="nav-group-task">
  97. <a class="nav-group-task-link" href="../../Classes/DataStreamRequest/Completion.html">– Completion</a>
  98. </li>
  99. <li class="nav-group-task">
  100. <a class="nav-group-task-link" href="../../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  101. </li>
  102. <li class="nav-group-task">
  103. <a class="nav-group-task-link" href="../../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  104. </li>
  105. <li class="nav-group-task">
  106. <a class="nav-group-task-link" href="../../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  107. </li>
  108. <li class="nav-group-task">
  109. <a class="nav-group-task-link" href="../../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  110. </li>
  111. <li class="nav-group-task">
  112. <a class="nav-group-task-link" href="../../Classes/DownloadRequest.html">DownloadRequest</a>
  113. </li>
  114. <li class="nav-group-task">
  115. <a class="nav-group-task-link" href="../../Classes/DownloadRequest/Options.html">– Options</a>
  116. </li>
  117. <li class="nav-group-task">
  118. <a class="nav-group-task-link" href="../../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  119. </li>
  120. <li class="nav-group-task">
  121. <a class="nav-group-task-link" href="../../Classes/Interceptor.html">Interceptor</a>
  122. </li>
  123. <li class="nav-group-task">
  124. <a class="nav-group-task-link" href="../../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  125. </li>
  126. <li class="nav-group-task">
  127. <a class="nav-group-task-link" href="../../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  128. </li>
  129. <li class="nav-group-task">
  130. <a class="nav-group-task-link" href="../../Classes/MultipartFormData.html">MultipartFormData</a>
  131. </li>
  132. <li class="nav-group-task">
  133. <a class="nav-group-task-link" href="../../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  134. </li>
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../../Classes/Request.html">Request</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../../Classes/Request/State.html">– State</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../../Classes/Retrier.html">Retrier</a>
  155. </li>
  156. <li class="nav-group-task">
  157. <a class="nav-group-task-link" href="../../Classes/RetryPolicy.html">RetryPolicy</a>
  158. </li>
  159. <li class="nav-group-task">
  160. <a class="nav-group-task-link" href="../../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  161. </li>
  162. <li class="nav-group-task">
  163. <a class="nav-group-task-link" href="../../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  164. </li>
  165. <li class="nav-group-task">
  166. <a class="nav-group-task-link" href="../../Classes/ServerTrustManager.html">ServerTrustManager</a>
  167. </li>
  168. <li class="nav-group-task">
  169. <a class="nav-group-task-link" href="../../Classes/Session.html">Session</a>
  170. </li>
  171. <li class="nav-group-task">
  172. <a class="nav-group-task-link" href="../../Classes/SessionDelegate.html">SessionDelegate</a>
  173. </li>
  174. <li class="nav-group-task">
  175. <a class="nav-group-task-link" href="../../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  176. </li>
  177. <li class="nav-group-task">
  178. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  179. </li>
  180. <li class="nav-group-task">
  181. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  182. </li>
  183. <li class="nav-group-task">
  184. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  185. </li>
  186. <li class="nav-group-task">
  187. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  188. </li>
  189. <li class="nav-group-task">
  190. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  191. </li>
  192. <li class="nav-group-task">
  193. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  194. </li>
  195. <li class="nav-group-task">
  196. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  197. </li>
  198. <li class="nav-group-task">
  199. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  200. </li>
  201. <li class="nav-group-task">
  202. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  203. </li>
  204. <li class="nav-group-task">
  205. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  206. </li>
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="../../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="../../Classes/UploadRequest.html">UploadRequest</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="../../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  218. </li>
  219. </ul>
  220. </li>
  221. <li class="nav-group-name">
  222. <a class="nav-group-name-link" href="../../Global%20Variables.html">Global Variables</a>
  223. <ul class="nav-group-tasks">
  224. <li class="nav-group-task">
  225. <a class="nav-group-task-link" href="../../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  226. </li>
  227. </ul>
  228. </li>
  229. <li class="nav-group-name">
  230. <a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
  231. <ul class="nav-group-tasks">
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../../Enums/AFError.html">AFError</a>
  234. </li>
  235. <li class="nav-group-task">
  236. <a class="nav-group-task-link" href="../../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  237. </li>
  238. <li class="nav-group-task">
  239. <a class="nav-group-task-link" href="../../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  240. </li>
  241. <li class="nav-group-task">
  242. <a class="nav-group-task-link" href="../../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  243. </li>
  244. <li class="nav-group-task">
  245. <a class="nav-group-task-link" href="../../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  246. </li>
  247. <li class="nav-group-task">
  248. <a class="nav-group-task-link" href="../../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  249. </li>
  250. <li class="nav-group-task">
  251. <a class="nav-group-task-link" href="../../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  252. </li>
  253. <li class="nav-group-task">
  254. <a class="nav-group-task-link" href="../../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  255. </li>
  256. <li class="nav-group-task">
  257. <a class="nav-group-task-link" href="../../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  258. </li>
  259. <li class="nav-group-task">
  260. <a class="nav-group-task-link" href="../../Enums/AFInfo.html">AFInfo</a>
  261. </li>
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="../../Enums/AuthenticationError.html">AuthenticationError</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../../Enums/RetryResult.html">RetryResult</a>
  267. </li>
  268. </ul>
  269. </li>
  270. <li class="nav-group-name">
  271. <a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
  272. <ul class="nav-group-tasks">
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../../Extensions.html#/s:Sa">Array</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  278. </li>
  279. <li class="nav-group-task">
  280. <a class="nav-group-task-link" href="../../Extensions/CharacterSet.html">CharacterSet</a>
  281. </li>
  282. <li class="nav-group-task">
  283. <a class="nav-group-task-link" href="../../Extensions/Error.html">Error</a>
  284. </li>
  285. <li class="nav-group-task">
  286. <a class="nav-group-task-link" href="../../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  287. </li>
  288. <li class="nav-group-task">
  289. <a class="nav-group-task-link" href="../../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  290. </li>
  291. <li class="nav-group-task">
  292. <a class="nav-group-task-link" href="../../Extensions/Notification.html">Notification</a>
  293. </li>
  294. <li class="nav-group-task">
  295. <a class="nav-group-task-link" href="../../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  296. </li>
  297. <li class="nav-group-task">
  298. <a class="nav-group-task-link" href="../../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  299. </li>
  300. <li class="nav-group-task">
  301. <a class="nav-group-task-link" href="../../Extensions.html#/Protected">Protected</a>
  302. </li>
  303. <li class="nav-group-task">
  304. <a class="nav-group-task-link" href="../../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  305. </li>
  306. <li class="nav-group-task">
  307. <a class="nav-group-task-link" href="../../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  308. </li>
  309. <li class="nav-group-task">
  310. <a class="nav-group-task-link" href="../../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  311. </li>
  312. <li class="nav-group-task">
  313. <a class="nav-group-task-link" href="../../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  314. </li>
  315. <li class="nav-group-task">
  316. <a class="nav-group-task-link" href="../../Extensions/String.html">String</a>
  317. </li>
  318. <li class="nav-group-task">
  319. <a class="nav-group-task-link" href="../../Extensions/URL.html">URL</a>
  320. </li>
  321. <li class="nav-group-task">
  322. <a class="nav-group-task-link" href="../../Extensions/URLComponents.html">URLComponents</a>
  323. </li>
  324. <li class="nav-group-task">
  325. <a class="nav-group-task-link" href="../../Extensions/URLRequest.html">URLRequest</a>
  326. </li>
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="../../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="../../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  332. </li>
  333. </ul>
  334. </li>
  335. <li class="nav-group-name">
  336. <a class="nav-group-name-link" href="../../Protocols.html">Protocols</a>
  337. <ul class="nav-group-tasks">
  338. <li class="nav-group-task">
  339. <a class="nav-group-task-link" href="../../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  340. </li>
  341. <li class="nav-group-task">
  342. <a class="nav-group-task-link" href="../../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  343. </li>
  344. <li class="nav-group-task">
  345. <a class="nav-group-task-link" href="../../Protocols/Authenticator.html">Authenticator</a>
  346. </li>
  347. <li class="nav-group-task">
  348. <a class="nav-group-task-link" href="../../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  349. </li>
  350. <li class="nav-group-task">
  351. <a class="nav-group-task-link" href="../../Protocols/DataDecoder.html">DataDecoder</a>
  352. </li>
  353. <li class="nav-group-task">
  354. <a class="nav-group-task-link" href="../../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  355. </li>
  356. <li class="nav-group-task">
  357. <a class="nav-group-task-link" href="../../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  358. </li>
  359. <li class="nav-group-task">
  360. <a class="nav-group-task-link" href="../../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  361. </li>
  362. <li class="nav-group-task">
  363. <a class="nav-group-task-link" href="../../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  364. </li>
  365. <li class="nav-group-task">
  366. <a class="nav-group-task-link" href="../../Protocols/EmptyResponse.html">EmptyResponse</a>
  367. </li>
  368. <li class="nav-group-task">
  369. <a class="nav-group-task-link" href="../../Protocols/EventMonitor.html">EventMonitor</a>
  370. </li>
  371. <li class="nav-group-task">
  372. <a class="nav-group-task-link" href="../../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  373. </li>
  374. <li class="nav-group-task">
  375. <a class="nav-group-task-link" href="../../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  376. </li>
  377. <li class="nav-group-task">
  378. <a class="nav-group-task-link" href="../../Protocols/RedirectHandler.html">RedirectHandler</a>
  379. </li>
  380. <li class="nav-group-task">
  381. <a class="nav-group-task-link" href="../../Protocols/RequestAdapter.html">RequestAdapter</a>
  382. </li>
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../../Protocols/RequestDelegate.html">RequestDelegate</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  388. </li>
  389. <li class="nav-group-task">
  390. <a class="nav-group-task-link" href="../../Protocols/RequestRetrier.html">RequestRetrier</a>
  391. </li>
  392. <li class="nav-group-task">
  393. <a class="nav-group-task-link" href="../../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  394. </li>
  395. <li class="nav-group-task">
  396. <a class="nav-group-task-link" href="../../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  397. </li>
  398. <li class="nav-group-task">
  399. <a class="nav-group-task-link" href="../../Protocols/URLConvertible.html">URLConvertible</a>
  400. </li>
  401. <li class="nav-group-task">
  402. <a class="nav-group-task-link" href="../../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  403. </li>
  404. <li class="nav-group-task">
  405. <a class="nav-group-task-link" href="../../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  406. </li>
  407. <li class="nav-group-task">
  408. <a class="nav-group-task-link" href="../../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  409. </li>
  410. <li class="nav-group-task">
  411. <a class="nav-group-task-link" href="../../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  412. </li>
  413. </ul>
  414. </li>
  415. <li class="nav-group-name">
  416. <a class="nav-group-name-link" href="../../Structs.html">Structures</a>
  417. <ul class="nav-group-tasks">
  418. <li class="nav-group-task">
  419. <a class="nav-group-task-link" href="../../Structs/AlamofireExtension.html">AlamofireExtension</a>
  420. </li>
  421. <li class="nav-group-task">
  422. <a class="nav-group-task-link" href="../../Structs/DataResponse.html">DataResponse</a>
  423. </li>
  424. <li class="nav-group-task">
  425. <a class="nav-group-task-link" href="../../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  426. </li>
  427. <li class="nav-group-task">
  428. <a class="nav-group-task-link" href="../../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  429. </li>
  430. <li class="nav-group-task">
  431. <a class="nav-group-task-link" href="../../Structs/DataStreamTask.html">DataStreamTask</a>
  432. </li>
  433. <li class="nav-group-task">
  434. <a class="nav-group-task-link" href="../../Structs/DataTask.html">DataTask</a>
  435. </li>
  436. <li class="nav-group-task">
  437. <a class="nav-group-task-link" href="../../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  438. </li>
  439. <li class="nav-group-task">
  440. <a class="nav-group-task-link" href="../../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  441. </li>
  442. <li class="nav-group-task">
  443. <a class="nav-group-task-link" href="../../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  444. </li>
  445. <li class="nav-group-task">
  446. <a class="nav-group-task-link" href="../../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  447. </li>
  448. <li class="nav-group-task">
  449. <a class="nav-group-task-link" href="../../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  450. </li>
  451. <li class="nav-group-task">
  452. <a class="nav-group-task-link" href="../../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  453. </li>
  454. <li class="nav-group-task">
  455. <a class="nav-group-task-link" href="../../Structs/DownloadResponse.html">DownloadResponse</a>
  456. </li>
  457. <li class="nav-group-task">
  458. <a class="nav-group-task-link" href="../../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  459. </li>
  460. <li class="nav-group-task">
  461. <a class="nav-group-task-link" href="../../Structs/DownloadTask.html">DownloadTask</a>
  462. </li>
  463. <li class="nav-group-task">
  464. <a class="nav-group-task-link" href="../../Structs/Empty.html">Empty</a>
  465. </li>
  466. <li class="nav-group-task">
  467. <a class="nav-group-task-link" href="../../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  468. </li>
  469. <li class="nav-group-task">
  470. <a class="nav-group-task-link" href="../../Structs/HTTPHeader.html">HTTPHeader</a>
  471. </li>
  472. <li class="nav-group-task">
  473. <a class="nav-group-task-link" href="../../Structs/HTTPHeaders.html">HTTPHeaders</a>
  474. </li>
  475. <li class="nav-group-task">
  476. <a class="nav-group-task-link" href="../../Structs/HTTPMethod.html">HTTPMethod</a>
  477. </li>
  478. <li class="nav-group-task">
  479. <a class="nav-group-task-link" href="../../Structs/JSONEncoding.html">JSONEncoding</a>
  480. </li>
  481. <li class="nav-group-task">
  482. <a class="nav-group-task-link" href="../../Structs/JSONEncoding/Error.html">– Error</a>
  483. </li>
  484. <li class="nav-group-task">
  485. <a class="nav-group-task-link" href="../../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  486. </li>
  487. <li class="nav-group-task">
  488. <a class="nav-group-task-link" href="../../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  489. </li>
  490. <li class="nav-group-task">
  491. <a class="nav-group-task-link" href="../../Structs/Redirector.html">Redirector</a>
  492. </li>
  493. <li class="nav-group-task">
  494. <a class="nav-group-task-link" href="../../Structs/Redirector/Behavior.html">– Behavior</a>
  495. </li>
  496. <li class="nav-group-task">
  497. <a class="nav-group-task-link" href="../../Structs/RequestAdapterState.html">RequestAdapterState</a>
  498. </li>
  499. <li class="nav-group-task">
  500. <a class="nav-group-task-link" href="../../Structs/ResponseCacher.html">ResponseCacher</a>
  501. </li>
  502. <li class="nav-group-task">
  503. <a class="nav-group-task-link" href="../../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  504. </li>
  505. <li class="nav-group-task">
  506. <a class="nav-group-task-link" href="../../Structs/StreamOf.html">StreamOf</a>
  507. </li>
  508. <li class="nav-group-task">
  509. <a class="nav-group-task-link" href="../../Structs/StreamOf/Iterator.html">– Iterator</a>
  510. </li>
  511. <li class="nav-group-task">
  512. <a class="nav-group-task-link" href="../../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  513. </li>
  514. <li class="nav-group-task">
  515. <a class="nav-group-task-link" href="../../Structs/URLEncoding.html">URLEncoding</a>
  516. </li>
  517. <li class="nav-group-task">
  518. <a class="nav-group-task-link" href="../../Structs/URLEncoding/Destination.html">– Destination</a>
  519. </li>
  520. <li class="nav-group-task">
  521. <a class="nav-group-task-link" href="../../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  522. </li>
  523. <li class="nav-group-task">
  524. <a class="nav-group-task-link" href="../../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  525. </li>
  526. <li class="nav-group-task">
  527. <a class="nav-group-task-link" href="../../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  528. </li>
  529. </ul>
  530. </li>
  531. <li class="nav-group-name">
  532. <a class="nav-group-name-link" href="../../Typealiases.html">Type Aliases</a>
  533. <ul class="nav-group-tasks">
  534. <li class="nav-group-task">
  535. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  536. </li>
  537. <li class="nav-group-task">
  538. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  539. </li>
  540. <li class="nav-group-task">
  541. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  542. </li>
  543. <li class="nav-group-task">
  544. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  545. </li>
  546. <li class="nav-group-task">
  547. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  548. </li>
  549. <li class="nav-group-task">
  550. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  551. </li>
  552. <li class="nav-group-task">
  553. <a class="nav-group-task-link" href="../../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  554. </li>
  555. </ul>
  556. </li>
  557. </ul>
  558. </nav>
  559. <article class="main-content">
  560. <section class="section">
  561. <div class="section-content top-matter">
  562. <h1>KeyEncoding</h1>
  563. <div class="declaration">
  564. <div class="language">
  565. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">KeyEncoding</span></code></pre>
  566. </div>
  567. </div>
  568. <p>Encoding to use for keys.</p>
  569. <p>This type is derived from <a href="https://github.com/apple/swift/blob/6aa313b8dd5f05135f7f878eccc1db6f9fbe34ff/stdlib/public/Darwin/Foundation/JSONEncoder.swift#L128"><code>JSONEncoder</code>&lsquo;s <code>KeyEncodingStrategy</code></a>
  570. and <a href="https://github.com/MaxDesiatov/XMLCoder/blob/master/Sources/XMLCoder/Encoder/XMLEncoder.swift#L102"><code>XMLEncoder</code>s <code>KeyEncodingStrategy</code></a>.</p>
  571. </div>
  572. </section>
  573. <section class="section">
  574. <div class="section-content">
  575. <div class="task-group">
  576. <ul class="item-container">
  577. <li class="item">
  578. <div>
  579. <code>
  580. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO14useDefaultKeysyA2EmF"></a>
  581. <a name="//apple_ref/swift/Element/useDefaultKeys" class="dashAnchor"></a>
  582. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO14useDefaultKeysyA2EmF">useDefaultKeys</a>
  583. </code>
  584. </div>
  585. <div class="height-container">
  586. <div class="pointer-container"></div>
  587. <section class="section">
  588. <div class="pointer"></div>
  589. <div class="abstract">
  590. <p>Use the keys specified by each type. This is the default encoding.</p>
  591. </div>
  592. <div class="declaration">
  593. <h4>Declaration</h4>
  594. <div class="language">
  595. <p class="aside-title">Swift</p>
  596. <pre class="highlight swift"><code><span class="k">case</span> <span class="n">useDefaultKeys</span></code></pre>
  597. </div>
  598. </div>
  599. </section>
  600. </div>
  601. </li>
  602. <li class="item">
  603. <div>
  604. <code>
  605. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO18convertToSnakeCaseyA2EmF"></a>
  606. <a name="//apple_ref/swift/Element/convertToSnakeCase" class="dashAnchor"></a>
  607. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO18convertToSnakeCaseyA2EmF">convertToSnakeCase</a>
  608. </code>
  609. </div>
  610. <div class="height-container">
  611. <div class="pointer-container"></div>
  612. <section class="section">
  613. <div class="pointer"></div>
  614. <div class="abstract">
  615. <p>Convert from &ldquo;camelCaseKeys&rdquo; to &ldquo;snake_case_keys&rdquo; before writing a key.</p>
  616. <p>Capital characters are determined by testing membership in
  617. <code>CharacterSet.uppercaseLetters</code> and <code>CharacterSet.lowercaseLetters</code>
  618. (Unicode General Categories Lu and Lt).
  619. The conversion to lower case uses <code>Locale.system</code>, also known as
  620. the ICU &ldquo;root&rdquo; locale. This means the result is consistent
  621. regardless of the current user&rsquo;s locale and language preferences.</p>
  622. <p>Converting from camel case to snake case:</p>
  623. <ol>
  624. <li>Splits words at the boundary of lower-case to upper-case</li>
  625. <li>Inserts <code>_</code> between words</li>
  626. <li>Lowercases the entire string</li>
  627. <li>Preserves starting and ending <code>_</code>.</li>
  628. </ol>
  629. <p>For example, <code>oneTwoThree</code> becomes <code>one_two_three</code>. <code>_oneTwoThree_</code> becomes <code>_one_two_three_</code>.</p>
  630. <div class="aside aside-note">
  631. <p class="aside-title">Note</p>
  632. Using a key encoding strategy has a nominal performance cost, as each string key has to be converted.
  633. </div>
  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="k">case</span> <span class="n">convertToSnakeCase</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:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO18convertToKebabCaseyA2EmF"></a>
  649. <a name="//apple_ref/swift/Element/convertToKebabCase" class="dashAnchor"></a>
  650. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO18convertToKebabCaseyA2EmF">convertToKebabCase</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>Same as convertToSnakeCase, but using <code>-</code> instead of <code>_</code>.
  659. For example <code>oneTwoThree</code> becomes <code>one-two-three</code>.</p>
  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="k">case</span> <span class="n">convertToKebabCase</span></code></pre>
  666. </div>
  667. </div>
  668. </section>
  669. </div>
  670. </li>
  671. <li class="item">
  672. <div>
  673. <code>
  674. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO11capitalizedyA2EmF"></a>
  675. <a name="//apple_ref/swift/Element/capitalized" class="dashAnchor"></a>
  676. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO11capitalizedyA2EmF">capitalized</a>
  677. </code>
  678. </div>
  679. <div class="height-container">
  680. <div class="pointer-container"></div>
  681. <section class="section">
  682. <div class="pointer"></div>
  683. <div class="abstract">
  684. <p>Capitalize the first letter only.
  685. For example <code>oneTwoThree</code> becomes <code>OneTwoThree</code>.</p>
  686. </div>
  687. <div class="declaration">
  688. <h4>Declaration</h4>
  689. <div class="language">
  690. <p class="aside-title">Swift</p>
  691. <pre class="highlight swift"><code><span class="k">case</span> <span class="n">capitalized</span></code></pre>
  692. </div>
  693. </div>
  694. </section>
  695. </div>
  696. </li>
  697. <li class="item">
  698. <div>
  699. <code>
  700. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO10uppercasedyA2EmF"></a>
  701. <a name="//apple_ref/swift/Element/uppercased" class="dashAnchor"></a>
  702. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO10uppercasedyA2EmF">uppercased</a>
  703. </code>
  704. </div>
  705. <div class="height-container">
  706. <div class="pointer-container"></div>
  707. <section class="section">
  708. <div class="pointer"></div>
  709. <div class="abstract">
  710. <p>Uppercase all letters.
  711. For example <code>oneTwoThree</code> becomes <code>ONETWOTHREE</code>.</p>
  712. </div>
  713. <div class="declaration">
  714. <h4>Declaration</h4>
  715. <div class="language">
  716. <p class="aside-title">Swift</p>
  717. <pre class="highlight swift"><code><span class="k">case</span> <span class="n">uppercased</span></code></pre>
  718. </div>
  719. </div>
  720. </section>
  721. </div>
  722. </li>
  723. <li class="item">
  724. <div>
  725. <code>
  726. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO10lowercasedyA2EmF"></a>
  727. <a name="//apple_ref/swift/Element/lowercased" class="dashAnchor"></a>
  728. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO10lowercasedyA2EmF">lowercased</a>
  729. </code>
  730. </div>
  731. <div class="height-container">
  732. <div class="pointer-container"></div>
  733. <section class="section">
  734. <div class="pointer"></div>
  735. <div class="abstract">
  736. <p>Lowercase all letters.
  737. For example <code>oneTwoThree</code> becomes <code>onetwothree</code>.</p>
  738. </div>
  739. <div class="declaration">
  740. <h4>Declaration</h4>
  741. <div class="language">
  742. <p class="aside-title">Swift</p>
  743. <pre class="highlight swift"><code><span class="k">case</span> <span class="n">lowercased</span></code></pre>
  744. </div>
  745. </div>
  746. </section>
  747. </div>
  748. </li>
  749. <li class="item">
  750. <div>
  751. <code>
  752. <a name="/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO6customyAES2SccAEmF"></a>
  753. <a name="//apple_ref/swift/Element/custom(_:)" class="dashAnchor"></a>
  754. <a class="token" href="#/s:9Alamofire21URLEncodedFormEncoderC11KeyEncodingO6customyAES2SccAEmF">custom(_:<wbr>)</a>
  755. </code>
  756. </div>
  757. <div class="height-container">
  758. <div class="pointer-container"></div>
  759. <section class="section">
  760. <div class="pointer"></div>
  761. <div class="abstract">
  762. <p>A custom encoding using the provided closure.</p>
  763. </div>
  764. <div class="declaration">
  765. <h4>Declaration</h4>
  766. <div class="language">
  767. <p class="aside-title">Swift</p>
  768. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">custom</span><span class="p">((</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  769. </div>
  770. </div>
  771. </section>
  772. </div>
  773. </li>
  774. </ul>
  775. </div>
  776. </div>
  777. </section>
  778. </article>
  779. </div>
  780. <section class="footer">
  781. <p>&copy; 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-10-19)</p>
  782. <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>
  783. </section>
  784. </body>
  785. </html>