Home Explore Help
Sign In
mirror
/
Alamofire
mirror of https://github.com/Alamofire/Alamofire.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 354dda32d8
Branches Tags
Alamofire
/
docs
/
Protocols
/
ParameterEncoding.html

ParameterEncoding.html 33 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3.   <head>
    4. 

  4.     <title>ParameterEncoding Protocol Reference</title>
    5. 

  5.     <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    6. 

  6.     <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    7. 

  7.     <meta charset="utf-8">
    8. 

  8.     <script src="../js/jquery.min.js" defer></script>
    9. 

  9.     <script src="../js/jazzy.js" defer></script>
    10. 

  10.     
    11. 

  11.     <script src="../js/lunr.min.js" defer></script>
    12. 

  12.     <script src="../js/typeahead.jquery.js" defer></script>
    13. 

  13.     <script src="../js/jazzy.search.js" defer></script>
    14. 

  14.   </head>
    15. 

  15.   <body>
    16. 

  16. 

  17.     <a name="//apple_ref/swift/Protocol/ParameterEncoding" class="dashAnchor"></a>
    18. 

  18. 

  19.     <a title="ParameterEncoding Protocol Reference"></a>
    20. 

  20. 

  21.     <header class="header">
    22. 

  22.       <p class="header-col header-col--primary">
    23. 

  23.         <a class="header-link" href="../index.html">
    24. 

  24.           Alamofire 5.6.1 Docs
    25. 

  25.         </a>
    26. 

  26.          (97% documented)
    27. 

  27.       </p>
    28. 

  28.     
    29. 

  29.       <div class="header-col--secondary">
    30. 

  30.         <form role="search" action="../search.json">
    31. 

  31.           <input type="text" placeholder="Search documentation" data-typeahead>
    32. 

  32.         </form>
    33. 

  33.       </div>
    34. 

  34.     
    35. 

  35.         <p class="header-col header-col--secondary">
    36. 

  36.           <a class="header-link" href="https://github.com/Alamofire/Alamofire">
    37. 

  37.             <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
    38. 

  38.             View on GitHub
    39. 

  39.           </a>
    40. 

  40.         </p>
    41. 

  41.     
    42. 

  42.         <p class="header-col header-col--secondary">
    43. 

  43.           <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
    44. 

  44.             <img class="header-icon" src="../img/dash.png" alt="Dash"/>
    45. 

  45.             Install in Dash
    46. 

  46.           </a>
    47. 

  47.         </p>
    48. 

  48.     </header>
    49. 

  49. 

  50.     <p class="breadcrumbs">
    51. 

  51.       <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
    52. 

  52.       <img class="carat" src="../img/carat.png" alt=""/>
    53. 

  53.       ParameterEncoding Protocol Reference
    54. 

  54.     </p>
    55. 

  55. 

  56.     <div class="content-wrapper">
    57. 

  57.       <nav class="navigation">
    58. 

  58.         <ul class="nav-groups">
    59. 

  59.           <li class="nav-group-name">
    60. 

  60.             <a class="nav-group-name-link" href="../Classes.html">Classes</a>
    61. 

  61.             <ul class="nav-group-tasks">
    62. 

  62.               <li class="nav-group-task">
    63. 

  63.                 <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
    64. 

  64.               </li>
    65. 

  65.               <li class="nav-group-task">
    66. 

  66.                 <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
    67. 

  67.               </li>
    68. 

  68.               <li class="nav-group-task">
    69. 

  69.                 <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
    70. 

  70.               </li>
    71. 

  71.               <li class="nav-group-task">
    72. 

  72.                 <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
    73. 

  73.               </li>
    74. 

  74.               <li class="nav-group-task">
    75. 

  75.                 <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
    76. 

  76.               </li>
    77. 

  77.               <li class="nav-group-task">
    78. 

  78.                 <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
    79. 

  79.               </li>
    80. 

  80.               <li class="nav-group-task">
    81. 

  81.                 <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
    82. 

  82.               </li>
    83. 

  83.               <li class="nav-group-task">
    84. 

  84.                 <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
    85. 

  85.               </li>
    86. 

  86.               <li class="nav-group-task">
    87. 

  87.                 <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
    88. 

  88.               </li>
    89. 

  89.               <li class="nav-group-task">
    90. 

  90.                 <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
    91. 

  91.               </li>
    92. 

  92.               <li class="nav-group-task">
    93. 

  93.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
    94. 

  94.               </li>
    95. 

  95.               <li class="nav-group-task">
    96. 

  96.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
    97. 

  97.               </li>
    98. 

  98.               <li class="nav-group-task">
    99. 

  99.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
    100. 

  100.               </li>
    101. 

  101.               <li class="nav-group-task">
    102. 

  102.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
    103. 

  103.               </li>
    104. 

  104.               <li class="nav-group-task">
    105. 

  105.                 <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
    106. 

  106.               </li>
    107. 

  107.               <li class="nav-group-task">
    108. 

  108.                 <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
    109. 

  109.               </li>
    110. 

  110.               <li class="nav-group-task">
    111. 

  111.                 <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
    112. 

  112.               </li>
    113. 

  113.               <li class="nav-group-task">
    114. 

  114.                 <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
    115. 

  115.               </li>
    116. 

  116.               <li class="nav-group-task">
    117. 

  117.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
    118. 

  118.               </li>
    119. 

  119.               <li class="nav-group-task">
    120. 

  120.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
    121. 

  121.               </li>
    122. 

  122.               <li class="nav-group-task">
    123. 

  123.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
    124. 

  124.               </li>
    125. 

  125.               <li class="nav-group-task">
    126. 

  126.                 <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
    127. 

  127.               </li>
    128. 

  128.               <li class="nav-group-task">
    129. 

  129.                 <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
    130. 

  130.               </li>
    131. 

  131.               <li class="nav-group-task">
    132. 

  132.                 <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
    133. 

  133.               </li>
    134. 

  134.               <li class="nav-group-task">
    135. 

  135.                 <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
    136. 

  136.               </li>
    137. 

  137.               <li class="nav-group-task">
    138. 

  138.                 <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
    139. 

  139.               </li>
    140. 

  140.               <li class="nav-group-task">
    141. 

  141.                 <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
    142. 

  142.               </li>
    143. 

  143.               <li class="nav-group-task">
    144. 

  144.                 <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
    145. 

  145.               </li>
    146. 

  146.               <li class="nav-group-task">
    147. 

  147.                 <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
    148. 

  148.               </li>
    149. 

  149.               <li class="nav-group-task">
    150. 

  150.                 <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
    151. 

  151.               </li>
    152. 

  152.               <li class="nav-group-task">
    153. 

  153.                 <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
    154. 

  154.               </li>
    155. 

  155.               <li class="nav-group-task">
    156. 

  156.                 <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
    157. 

  157.               </li>
    158. 

  158.               <li class="nav-group-task">
    159. 

  159.                 <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
    160. 

  160.               </li>
    161. 

  161.               <li class="nav-group-task">
    162. 

  162.                 <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
    163. 

  163.               </li>
    164. 

  164.               <li class="nav-group-task">
    165. 

  165.                 <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
    166. 

  166.               </li>
    167. 

  167.               <li class="nav-group-task">
    168. 

  168.                 <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
    169. 

  169.               </li>
    170. 

  170.               <li class="nav-group-task">
    171. 

  171.                 <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
    172. 

  172.               </li>
    173. 

  173.               <li class="nav-group-task">
    174. 

  174.                 <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
    175. 

  175.               </li>
    176. 

  176.               <li class="nav-group-task">
    177. 

  177.                 <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
    178. 

  178.               </li>
    179. 

  179.               <li class="nav-group-task">
    180. 

  180.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
    181. 

  181.               </li>
    182. 

  182.               <li class="nav-group-task">
    183. 

  183.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
    184. 

  184.               </li>
    185. 

  185.               <li class="nav-group-task">
    186. 

  186.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
    187. 

  187.               </li>
    188. 

  188.               <li class="nav-group-task">
    189. 

  189.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
    190. 

  190.               </li>
    191. 

  191.               <li class="nav-group-task">
    192. 

  192.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
    193. 

  193.               </li>
    194. 

  194.               <li class="nav-group-task">
    195. 

  195.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
    196. 

  196.               </li>
    197. 

  197.               <li class="nav-group-task">
    198. 

  198.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
    199. 

  199.               </li>
    200. 

  200.               <li class="nav-group-task">
    201. 

  201.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
    202. 

  202.               </li>
    203. 

  203.               <li class="nav-group-task">
    204. 

  204.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
    205. 

  205.               </li>
    206. 

  206.               <li class="nav-group-task">
    207. 

  207.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
    208. 

  208.               </li>
    209. 

  209.               <li class="nav-group-task">
    210. 

  210.                 <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
    211. 

  211.               </li>
    212. 

  212.               <li class="nav-group-task">
    213. 

  213.                 <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
    214. 

  214.               </li>
    215. 

  215.             </ul>
    216. 

  216.           </li>
    217. 

  217.           <li class="nav-group-name">
    218. 

  218.             <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
    219. 

  219.             <ul class="nav-group-tasks">
    220. 

  220.               <li class="nav-group-task">
    221. 

  221.                 <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
    222. 

  222.               </li>
    223. 

  223.             </ul>
    224. 

  224.           </li>
    225. 

  225.           <li class="nav-group-name">
    226. 

  226.             <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
    227. 

  227.             <ul class="nav-group-tasks">
    228. 

  228.               <li class="nav-group-task">
    229. 

  229.                 <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
    230. 

  230.               </li>
    231. 

  231.               <li class="nav-group-task">
    232. 

  232.                 <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
    233. 

  233.               </li>
    234. 

  234.               <li class="nav-group-task">
    235. 

  235.                 <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
    236. 

  236.               </li>
    237. 

  237.               <li class="nav-group-task">
    238. 

  238.                 <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
    239. 

  239.               </li>
    240. 

  240.               <li class="nav-group-task">
    241. 

  241.                 <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
    242. 

  242.               </li>
    243. 

  243.               <li class="nav-group-task">
    244. 

  244.                 <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
    245. 

  245.               </li>
    246. 

  246.               <li class="nav-group-task">
    247. 

  247.                 <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
    248. 

  248.               </li>
    249. 

  249.               <li class="nav-group-task">
    250. 

  250.                 <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
    251. 

  251.               </li>
    252. 

  252.               <li class="nav-group-task">
    253. 

  253.                 <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
    254. 

  254.               </li>
    255. 

  255.               <li class="nav-group-task">
    256. 

  256.                 <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
    257. 

  257.               </li>
    258. 

  258.               <li class="nav-group-task">
    259. 

  259.                 <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
    260. 

  260.               </li>
    261. 

  261.             </ul>
    262. 

  262.           </li>
    263. 

  263.           <li class="nav-group-name">
    264. 

  264.             <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
    265. 

  265.             <ul class="nav-group-tasks">
    266. 

  266.               <li class="nav-group-task">
    267. 

  267.                 <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
    268. 

  268.               </li>
    269. 

  269.               <li class="nav-group-task">
    270. 

  270.                 <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
    271. 

  271.               </li>
    272. 

  272.               <li class="nav-group-task">
    273. 

  273.                 <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
    274. 

  274.               </li>
    275. 

  275.               <li class="nav-group-task">
    276. 

  276.                 <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
    277. 

  277.               </li>
    278. 

  278.               <li class="nav-group-task">
    279. 

  279.                 <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
    280. 

  280.               </li>
    281. 

  281.               <li class="nav-group-task">
    282. 

  282.                 <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
    283. 

  283.               </li>
    284. 

  284.               <li class="nav-group-task">
    285. 

  285.                 <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
    286. 

  286.               </li>
    287. 

  287.               <li class="nav-group-task">
    288. 

  288.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
    289. 

  289.               </li>
    290. 

  290.               <li class="nav-group-task">
    291. 

  291.                 <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
    292. 

  292.               </li>
    293. 

  293.               <li class="nav-group-task">
    294. 

  294.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
    295. 

  295.               </li>
    296. 

  296.               <li class="nav-group-task">
    297. 

  297.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
    298. 

  298.               </li>
    299. 

  299.               <li class="nav-group-task">
    300. 

  300.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
    301. 

  301.               </li>
    302. 

  302.               <li class="nav-group-task">
    303. 

  303.                 <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
    304. 

  304.               </li>
    305. 

  305.               <li class="nav-group-task">
    306. 

  306.                 <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
    307. 

  307.               </li>
    308. 

  308.               <li class="nav-group-task">
    309. 

  309.                 <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
    310. 

  310.               </li>
    311. 

  311.               <li class="nav-group-task">
    312. 

  312.                 <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
    313. 

  313.               </li>
    314. 

  314.               <li class="nav-group-task">
    315. 

  315.                 <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
    316. 

  316.               </li>
    317. 

  317.               <li class="nav-group-task">
    318. 

  318.                 <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
    319. 

  319.               </li>
    320. 

  320.             </ul>
    321. 

  321.           </li>
    322. 

  322.           <li class="nav-group-name">
    323. 

  323.             <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
    324. 

  324.             <ul class="nav-group-tasks">
    325. 

  325.               <li class="nav-group-task">
    326. 

  326.                 <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
    327. 

  327.               </li>
    328. 

  328.               <li class="nav-group-task">
    329. 

  329.                 <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
    330. 

  330.               </li>
    331. 

  331.               <li class="nav-group-task">
    332. 

  332.                 <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
    333. 

  333.               </li>
    334. 

  334.               <li class="nav-group-task">
    335. 

  335.                 <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
    336. 

  336.               </li>
    337. 

  337.               <li class="nav-group-task">
    338. 

  338.                 <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
    339. 

  339.               </li>
    340. 

  340.               <li class="nav-group-task">
    341. 

  341.                 <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
    342. 

  342.               </li>
    343. 

  343.               <li class="nav-group-task">
    344. 

  344.                 <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
    345. 

  345.               </li>
    346. 

  346.               <li class="nav-group-task">
    347. 

  347.                 <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
    348. 

  348.               </li>
    349. 

  349.               <li class="nav-group-task">
    350. 

  350.                 <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
    351. 

  351.               </li>
    352. 

  352.               <li class="nav-group-task">
    353. 

  353.                 <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
    354. 

  354.               </li>
    355. 

  355.               <li class="nav-group-task">
    356. 

  356.                 <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
    357. 

  357.               </li>
    358. 

  358.               <li class="nav-group-task">
    359. 

  359.                 <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
    360. 

  360.               </li>
    361. 

  361.               <li class="nav-group-task">
    362. 

  362.                 <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
    363. 

  363.               </li>
    364. 

  364.               <li class="nav-group-task">
    365. 

  365.                 <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
    366. 

  366.               </li>
    367. 

  367.               <li class="nav-group-task">
    368. 

  368.                 <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
    369. 

  369.               </li>
    370. 

  370.               <li class="nav-group-task">
    371. 

  371.                 <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
    372. 

  372.               </li>
    373. 

  373.               <li class="nav-group-task">
    374. 

  374.                 <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
    375. 

  375.               </li>
    376. 

  376.               <li class="nav-group-task">
    377. 

  377.                 <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
    378. 

  378.               </li>
    379. 

  379.               <li class="nav-group-task">
    380. 

  380.                 <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
    381. 

  381.               </li>
    382. 

  382.               <li class="nav-group-task">
    383. 

  383.                 <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
    384. 

  384.               </li>
    385. 

  385.               <li class="nav-group-task">
    386. 

  386.                 <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
    387. 

  387.               </li>
    388. 

  388.               <li class="nav-group-task">
    389. 

  389.                 <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
    390. 

  390.               </li>
    391. 

  391.               <li class="nav-group-task">
    392. 

  392.                 <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
    393. 

  393.               </li>
    394. 

  394.               <li class="nav-group-task">
    395. 

  395.                 <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
    396. 

  396.               </li>
    397. 

  397.             </ul>
    398. 

  398.           </li>
    399. 

  399.           <li class="nav-group-name">
    400. 

  400.             <a class="nav-group-name-link" href="../Structs.html">Structures</a>
    401. 

  401.             <ul class="nav-group-tasks">
    402. 

  402.               <li class="nav-group-task">
    403. 

  403.                 <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
    404. 

  404.               </li>
    405. 

  405.               <li class="nav-group-task">
    406. 

  406.                 <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
    407. 

  407.               </li>
    408. 

  408.               <li class="nav-group-task">
    409. 

  409.                 <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
    410. 

  410.               </li>
    411. 

  411.               <li class="nav-group-task">
    412. 

  412.                 <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
    413. 

  413.               </li>
    414. 

  414.               <li class="nav-group-task">
    415. 

  415.                 <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
    416. 

  416.               </li>
    417. 

  417.               <li class="nav-group-task">
    418. 

  418.                 <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
    419. 

  419.               </li>
    420. 

  420.               <li class="nav-group-task">
    421. 

  421.                 <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
    422. 

  422.               </li>
    423. 

  423.               <li class="nav-group-task">
    424. 

  424.                 <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
    425. 

  425.               </li>
    426. 

  426.               <li class="nav-group-task">
    427. 

  427.                 <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
    428. 

  428.               </li>
    429. 

  429.               <li class="nav-group-task">
    430. 

  430.                 <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
    431. 

  431.               </li>
    432. 

  432.               <li class="nav-group-task">
    433. 

  433.                 <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
    434. 

  434.               </li>
    435. 

  435.               <li class="nav-group-task">
    436. 

  436.                 <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
    437. 

  437.               </li>
    438. 

  438.               <li class="nav-group-task">
    439. 

  439.                 <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
    440. 

  440.               </li>
    441. 

  441.               <li class="nav-group-task">
    442. 

  442.                 <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
    443. 

  443.               </li>
    444. 

  444.               <li class="nav-group-task">
    445. 

  445.                 <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
    446. 

  446.               </li>
    447. 

  447.               <li class="nav-group-task">
    448. 

  448.                 <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
    449. 

  449.               </li>
    450. 

  450.               <li class="nav-group-task">
    451. 

  451.                 <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
    452. 

  452.               </li>
    453. 

  453.               <li class="nav-group-task">
    454. 

  454.                 <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
    455. 

  455.               </li>
    456. 

  456.               <li class="nav-group-task">
    457. 

  457.                 <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
    458. 

  458.               </li>
    459. 

  459.               <li class="nav-group-task">
    460. 

  460.                 <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
    461. 

  461.               </li>
    462. 

  462.               <li class="nav-group-task">
    463. 

  463.                 <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
    464. 

  464.               </li>
    465. 

  465.               <li class="nav-group-task">
    466. 

  466.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
    467. 

  467.               </li>
    468. 

  468.               <li class="nav-group-task">
    469. 

  469.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
    470. 

  470.               </li>
    471. 

  471.               <li class="nav-group-task">
    472. 

  472.                 <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
    473. 

  473.               </li>
    474. 

  474.               <li class="nav-group-task">
    475. 

  475.                 <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
    476. 

  476.               </li>
    477. 

  477.               <li class="nav-group-task">
    478. 

  478.                 <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
    479. 

  479.               </li>
    480. 

  480.               <li class="nav-group-task">
    481. 

  481.                 <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
    482. 

  482.               </li>
    483. 

  483.               <li class="nav-group-task">
    484. 

  484.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
    485. 

  485.               </li>
    486. 

  486.               <li class="nav-group-task">
    487. 

  487.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
    488. 

  488.               </li>
    489. 

  489.               <li class="nav-group-task">
    490. 

  490.                 <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
    491. 

  491.               </li>
    492. 

  492.               <li class="nav-group-task">
    493. 

  493.                 <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
    494. 

  494.               </li>
    495. 

  495.             </ul>
    496. 

  496.           </li>
    497. 

  497.           <li class="nav-group-name">
    498. 

  498.             <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
    499. 

  499.             <ul class="nav-group-tasks">
    500. 

  500.               <li class="nav-group-task">
    501. 

  501.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
    502. 

  502.               </li>
    503. 

  503.               <li class="nav-group-task">
    504. 

  504.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
    505. 

  505.               </li>
    506. 

  506.               <li class="nav-group-task">
    507. 

  507.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
    508. 

  508.               </li>
    509. 

  509.               <li class="nav-group-task">
    510. 

  510.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
    511. 

  511.               </li>
    512. 

  512.               <li class="nav-group-task">
    513. 

  513.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
    514. 

  514.               </li>
    515. 

  515.               <li class="nav-group-task">
    516. 

  516.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
    517. 

  517.               </li>
    518. 

  518.               <li class="nav-group-task">
    519. 

  519.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
    520. 

  520.               </li>
    521. 

  521.             </ul>
    522. 

  522.           </li>
    523. 

  523.         </ul>
    524. 

  524.       </nav>
    525. 

  525.       <article class="main-content">
    526. 

  526. 

  527.         <section class="section">
    528. 

  528.           <div class="section-content top-matter">
    529. 

  529.             <h1>ParameterEncoding</h1>
    530. 

  530.               <div class="declaration">
    531. 

  531.                 <div class="language">
    532. 

  532.                   
    533. 

  533.                   <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ParameterEncoding</span></code></pre>
    534. 

  534. 

  535.                 </div>
    536. 

  536.               </div>
    537. 

  537.             <p>A type used to define how a set of parameters are applied to a <code>URLRequest</code>.</p>
    538. 

  538. 

  539.           </div>
    540. 

  540.         </section>
    541. 

  541. 

  542.         <section class="section">
    543. 

  543.           <div class="section-content">
    544. 

  544.             <div class="task-group">
    545. 

  545.               <ul class="item-container">
    546. 

  546.                 <li class="item">
    547. 

  547.                   <div>
    548. 

  548.                     <code>
    549. 

  549.                     <a name="/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSypGSgtKF"></a>
    550. 

  550.                     <a name="//apple_ref/swift/Method/encode(_:with:)" class="dashAnchor"></a>
    551. 

  551.                     <a class="token" href="#/s:9Alamofire17ParameterEncodingP6encode_4with10Foundation10URLRequestVAA0G11Convertible_p_SDySSypGSgtKF">encode(_:<wbr>with:<wbr>)</a>
    552. 

  552.                     </code>
    553. 

  553.                   </div>
    554. 

  554.                   <div class="height-container">
    555. 

  555.                     <div class="pointer-container"></div>
    556. 

  556.                     <section class="section">
    557. 

  557.                       <div class="pointer"></div>
    558. 

  558.                       <div class="abstract">
    559. 

  559.                         <p>Creates a <code>URLRequest</code> by encoding parameters and applying them on the passed request.</p>
    560. 

  560. <div class="aside aside-throws">
    561. 

  561.     <p class="aside-title">Throws</p>
    562. 

  562.     <p>Any <code>Error</code> produced during parameter encoding.</p>
    563. 

  563. 

  564. </div>
    565. 

  565. 

  566.                       </div>
    567. 

  567.                       <div class="declaration">
    568. 

  568.                         <h4>Declaration</h4>
    569. 

  569.                         <div class="language">
    570. 

  570.                           <p class="aside-title">Swift</p>
    571. 

  571.                           <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">encode</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="n">with</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">URLRequest</span></code></pre>
    572. 

  572. 

  573.                         </div>
    574. 

  574.                       </div>
    575. 

  575.                       <div>
    576. 

  576.                         <h4>Parameters</h4>
    577. 

  577.                         <table class="graybox">
    578. 

  578.                           <tbody>
    579. 

  579.                             <tr>
    580. 

  580.                               <td>
    581. 

  581.                                 <code>
    582. 

  582.                                 <em>urlRequest</em>
    583. 

  583.                                 </code>
    584. 

  584.                               </td>
    585. 

  585.                               <td>
    586. 

  586.                                 <div>
    587. 

  587.                                   <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value onto which parameters will be encoded.</p>
    588. 

  588.                                 </div>
    589. 

  589.                               </td>
    590. 

  590.                             </tr>
    591. 

  591.                             <tr>
    592. 

  592.                               <td>
    593. 

  593.                                 <code>
    594. 

  594.                                 <em>parameters</em>
    595. 

  595.                                 </code>
    596. 

  596.                               </td>
    597. 

  597.                               <td>
    598. 

  598.                                 <div>
    599. 

  599.                                   <p><code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code> to encode onto the request.</p>
    600. 

  600.                                 </div>
    601. 

  601.                               </td>
    602. 

  602.                             </tr>
    603. 

  603.                           </tbody>
    604. 

  604.                         </table>
    605. 

  605.                       </div>
    606. 

  606.                       <div>
    607. 

  607.                         <h4>Return Value</h4>
    608. 

  608.                         <p>The encoded <code>URLRequest</code>.</p>
    609. 

  609.                       </div>
    610. 

  610.                     </section>
    611. 

  611.                   </div>
    612. 

  612.                 </li>
    613. 

  613.               </ul>
    614. 

  614.             </div>
    615. 

  615.           </div>
    616. 

  616.         </section>
    617. 

  617. 

  618.       </article>
    619. 

  619.     </div>
    620. 

  620.     <section class="footer">
    621. 

  621.       <p>&copy; 2022 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2022-04-17)</p>
    622. 

  622.       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
    623. 

  623.     </section>
    624. 

  624.   </body>
    625. 

  625. </html>
    626.