HTTPHeaders.html 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>HTTPHeaders 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/HTTPHeaders" class="dashAnchor"></a>
  16. <a title="HTTPHeaders 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.4.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  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"/>
  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"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. HTTPHeaders Structure Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  464. </li>
  465. </ul>
  466. </li>
  467. <li class="nav-group-name">
  468. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  469. <ul class="nav-group-tasks">
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </nav>
  495. <article class="main-content">
  496. <section class="section">
  497. <div class="section-content top-matter">
  498. <h1>HTTPHeaders</h1>
  499. <div class="declaration">
  500. <div class="language">
  501. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeaders</span></code></pre>
  502. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByDictionaryLiteral</span></code></pre>
  503. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByArrayLiteral</span></code></pre>
  504. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
  505. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Collection</span></code></pre>
  506. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  507. </div>
  508. </div>
  509. <p>An order-preserving and case-insensitive representation of HTTP headers.</p>
  510. </div>
  511. </section>
  512. <section class="section">
  513. <div class="section-content">
  514. <div class="task-group">
  515. <ul class="item-container">
  516. <li class="item">
  517. <div>
  518. <code>
  519. <a name="/s:9Alamofire11HTTPHeadersVACycfc"></a>
  520. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  521. <a class="token" href="#/s:9Alamofire11HTTPHeadersVACycfc">init()</a>
  522. </code>
  523. </div>
  524. <div class="height-container">
  525. <div class="pointer-container"></div>
  526. <section class="section">
  527. <div class="pointer"></div>
  528. <div class="abstract">
  529. <p>Creates an empty instance.</p>
  530. </div>
  531. <div class="declaration">
  532. <h4>Declaration</h4>
  533. <div class="language">
  534. <p class="aside-title">Swift</p>
  535. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
  536. </div>
  537. </div>
  538. </section>
  539. </div>
  540. </li>
  541. <li class="item">
  542. <div>
  543. <code>
  544. <a name="/s:9Alamofire11HTTPHeadersVyACSayAA10HTTPHeaderVGcfc"></a>
  545. <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
  546. <a class="token" href="#/s:9Alamofire11HTTPHeadersVyACSayAA10HTTPHeaderVGcfc">init(_:<wbr>)</a>
  547. </code>
  548. </div>
  549. <div class="height-container">
  550. <div class="pointer-container"></div>
  551. <section class="section">
  552. <div class="pointer"></div>
  553. <div class="abstract">
  554. <p>Creates an instance from an array of <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code>s. Duplicate case-insensitive names are collapsed into the last
  555. name and value encountered.</p>
  556. </div>
  557. <div class="declaration">
  558. <h4>Declaration</h4>
  559. <div class="language">
  560. <p class="aside-title">Swift</p>
  561. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">_</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span><span class="p">])</span></code></pre>
  562. </div>
  563. </div>
  564. </section>
  565. </div>
  566. </li>
  567. <li class="item">
  568. <div>
  569. <code>
  570. <a name="/s:9Alamofire11HTTPHeadersVyACSDyS2SGcfc"></a>
  571. <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
  572. <a class="token" href="#/s:9Alamofire11HTTPHeadersVyACSDyS2SGcfc">init(_:<wbr>)</a>
  573. </code>
  574. </div>
  575. <div class="height-container">
  576. <div class="pointer-container"></div>
  577. <section class="section">
  578. <div class="pointer"></div>
  579. <div class="abstract">
  580. <p>Creates an instance from a <code>[String: String]</code>. Duplicate case-insensitive names are collapsed into the last name
  581. and value encountered.</p>
  582. </div>
  583. <div class="declaration">
  584. <h4>Declaration</h4>
  585. <div class="language">
  586. <p class="aside-title">Swift</p>
  587. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">_</span> <span class="nv">dictionary</span><span class="p">:</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>
  588. </div>
  589. </div>
  590. </section>
  591. </div>
  592. </li>
  593. <li class="item">
  594. <div>
  595. <code>
  596. <a name="/s:9Alamofire11HTTPHeadersV3add4name5valueySS_SStF"></a>
  597. <a name="//apple_ref/swift/Method/add(name:value:)" class="dashAnchor"></a>
  598. <a class="token" href="#/s:9Alamofire11HTTPHeadersV3add4name5valueySS_SStF">add(name:<wbr>value:<wbr>)</a>
  599. </code>
  600. </div>
  601. <div class="height-container">
  602. <div class="pointer-container"></div>
  603. <section class="section">
  604. <div class="pointer"></div>
  605. <div class="abstract">
  606. <p>Case-insensitively updates or appends an <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> into the instance using the provided <code>name</code> and <code>value</code>.</p>
  607. </div>
  608. <div class="declaration">
  609. <h4>Declaration</h4>
  610. <div class="language">
  611. <p class="aside-title">Swift</p>
  612. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">add</span><span class="p">(</span><span class="nv">name</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">String</span><span class="p">)</span></code></pre>
  613. </div>
  614. </div>
  615. <div>
  616. <h4>Parameters</h4>
  617. <table class="graybox">
  618. <tbody>
  619. <tr>
  620. <td>
  621. <code>
  622. <em>name</em>
  623. </code>
  624. </td>
  625. <td>
  626. <div>
  627. <p>The <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> name.</p>
  628. </div>
  629. </td>
  630. </tr>
  631. <tr>
  632. <td>
  633. <code>
  634. <em>value</em>
  635. </code>
  636. </td>
  637. <td>
  638. <div>
  639. <p>The `HTTPHeader value.</p>
  640. </div>
  641. </td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. </div>
  646. </section>
  647. </div>
  648. </li>
  649. <li class="item">
  650. <div>
  651. <code>
  652. <a name="/s:9Alamofire11HTTPHeadersV3addyyAA10HTTPHeaderVF"></a>
  653. <a name="//apple_ref/swift/Method/add(_:)" class="dashAnchor"></a>
  654. <a class="token" href="#/s:9Alamofire11HTTPHeadersV3addyyAA10HTTPHeaderVF">add(_:<wbr>)</a>
  655. </code>
  656. </div>
  657. <div class="height-container">
  658. <div class="pointer-container"></div>
  659. <section class="section">
  660. <div class="pointer"></div>
  661. <div class="abstract">
  662. <p>Case-insensitively updates or appends the provided <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> into the instance.</p>
  663. </div>
  664. <div class="declaration">
  665. <h4>Declaration</h4>
  666. <div class="language">
  667. <p class="aside-title">Swift</p>
  668. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">add</span><span class="p">(</span><span class="n">_</span> <span class="nv">header</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span><span class="p">)</span></code></pre>
  669. </div>
  670. </div>
  671. <div>
  672. <h4>Parameters</h4>
  673. <table class="graybox">
  674. <tbody>
  675. <tr>
  676. <td>
  677. <code>
  678. <em>header</em>
  679. </code>
  680. </td>
  681. <td>
  682. <div>
  683. <p>The <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> to update or append.</p>
  684. </div>
  685. </td>
  686. </tr>
  687. </tbody>
  688. </table>
  689. </div>
  690. </section>
  691. </div>
  692. </li>
  693. <li class="item">
  694. <div>
  695. <code>
  696. <a name="/s:9Alamofire11HTTPHeadersV6update4name5valueySS_SStF"></a>
  697. <a name="//apple_ref/swift/Method/update(name:value:)" class="dashAnchor"></a>
  698. <a class="token" href="#/s:9Alamofire11HTTPHeadersV6update4name5valueySS_SStF">update(name:<wbr>value:<wbr>)</a>
  699. </code>
  700. </div>
  701. <div class="height-container">
  702. <div class="pointer-container"></div>
  703. <section class="section">
  704. <div class="pointer"></div>
  705. <div class="abstract">
  706. <p>Case-insensitively updates or appends an <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> into the instance using the provided <code>name</code> and <code>value</code>.</p>
  707. </div>
  708. <div class="declaration">
  709. <h4>Declaration</h4>
  710. <div class="language">
  711. <p class="aside-title">Swift</p>
  712. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">update</span><span class="p">(</span><span class="nv">name</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">String</span><span class="p">)</span></code></pre>
  713. </div>
  714. </div>
  715. <div>
  716. <h4>Parameters</h4>
  717. <table class="graybox">
  718. <tbody>
  719. <tr>
  720. <td>
  721. <code>
  722. <em>name</em>
  723. </code>
  724. </td>
  725. <td>
  726. <div>
  727. <p>The <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> name.</p>
  728. </div>
  729. </td>
  730. </tr>
  731. <tr>
  732. <td>
  733. <code>
  734. <em>value</em>
  735. </code>
  736. </td>
  737. <td>
  738. <div>
  739. <p>The `HTTPHeader value.</p>
  740. </div>
  741. </td>
  742. </tr>
  743. </tbody>
  744. </table>
  745. </div>
  746. </section>
  747. </div>
  748. </li>
  749. <li class="item">
  750. <div>
  751. <code>
  752. <a name="/s:9Alamofire11HTTPHeadersV6updateyyAA10HTTPHeaderVF"></a>
  753. <a name="//apple_ref/swift/Method/update(_:)" class="dashAnchor"></a>
  754. <a class="token" href="#/s:9Alamofire11HTTPHeadersV6updateyyAA10HTTPHeaderVF">update(_:<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>Case-insensitively updates or appends the provided <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> into the instance.</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="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">update</span><span class="p">(</span><span class="n">_</span> <span class="nv">header</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span><span class="p">)</span></code></pre>
  769. </div>
  770. </div>
  771. <div>
  772. <h4>Parameters</h4>
  773. <table class="graybox">
  774. <tbody>
  775. <tr>
  776. <td>
  777. <code>
  778. <em>header</em>
  779. </code>
  780. </td>
  781. <td>
  782. <div>
  783. <p>The <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> to update or append.</p>
  784. </div>
  785. </td>
  786. </tr>
  787. </tbody>
  788. </table>
  789. </div>
  790. </section>
  791. </div>
  792. </li>
  793. <li class="item">
  794. <div>
  795. <code>
  796. <a name="/s:9Alamofire11HTTPHeadersV6remove4nameySS_tF"></a>
  797. <a name="//apple_ref/swift/Method/remove(name:)" class="dashAnchor"></a>
  798. <a class="token" href="#/s:9Alamofire11HTTPHeadersV6remove4nameySS_tF">remove(name:<wbr>)</a>
  799. </code>
  800. </div>
  801. <div class="height-container">
  802. <div class="pointer-container"></div>
  803. <section class="section">
  804. <div class="pointer"></div>
  805. <div class="abstract">
  806. <p>Case-insensitively removes an <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code>, if it exists, from the instance.</p>
  807. </div>
  808. <div class="declaration">
  809. <h4>Declaration</h4>
  810. <div class="language">
  811. <p class="aside-title">Swift</p>
  812. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">remove</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  813. </div>
  814. </div>
  815. <div>
  816. <h4>Parameters</h4>
  817. <table class="graybox">
  818. <tbody>
  819. <tr>
  820. <td>
  821. <code>
  822. <em>name</em>
  823. </code>
  824. </td>
  825. <td>
  826. <div>
  827. <p>The name of the <code><a href="../Structs/HTTPHeader.html">HTTPHeader</a></code> to remove.</p>
  828. </div>
  829. </td>
  830. </tr>
  831. </tbody>
  832. </table>
  833. </div>
  834. </section>
  835. </div>
  836. </li>
  837. <li class="item">
  838. <div>
  839. <code>
  840. <a name="/s:9Alamofire11HTTPHeadersV4sortyyF"></a>
  841. <a name="//apple_ref/swift/Method/sort()" class="dashAnchor"></a>
  842. <a class="token" href="#/s:9Alamofire11HTTPHeadersV4sortyyF">sort()</a>
  843. </code>
  844. </div>
  845. <div class="height-container">
  846. <div class="pointer-container"></div>
  847. <section class="section">
  848. <div class="pointer"></div>
  849. <div class="abstract">
  850. <p>Sort the current instance by header name, case insensitively.</p>
  851. </div>
  852. <div class="declaration">
  853. <h4>Declaration</h4>
  854. <div class="language">
  855. <p class="aside-title">Swift</p>
  856. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">sort</span><span class="p">()</span></code></pre>
  857. </div>
  858. </div>
  859. </section>
  860. </div>
  861. </li>
  862. <li class="item">
  863. <div>
  864. <code>
  865. <a name="/s:9Alamofire11HTTPHeadersV6sortedACyF"></a>
  866. <a name="//apple_ref/swift/Method/sorted()" class="dashAnchor"></a>
  867. <a class="token" href="#/s:9Alamofire11HTTPHeadersV6sortedACyF">sorted()</a>
  868. </code>
  869. </div>
  870. <div class="height-container">
  871. <div class="pointer-container"></div>
  872. <section class="section">
  873. <div class="pointer"></div>
  874. <div class="abstract">
  875. <p>Returns an instance sorted by header name.</p>
  876. </div>
  877. <div class="declaration">
  878. <h4>Declaration</h4>
  879. <div class="language">
  880. <p class="aside-title">Swift</p>
  881. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">sorted</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeaders</span></code></pre>
  882. </div>
  883. </div>
  884. <div>
  885. <h4>Return Value</h4>
  886. <p>A copy of the current instance sorted by name.</p>
  887. </div>
  888. </section>
  889. </div>
  890. </li>
  891. <li class="item">
  892. <div>
  893. <code>
  894. <a name="/s:9Alamofire11HTTPHeadersV5value3forSSSgSS_tF"></a>
  895. <a name="//apple_ref/swift/Method/value(for:)" class="dashAnchor"></a>
  896. <a class="token" href="#/s:9Alamofire11HTTPHeadersV5value3forSSSgSS_tF">value(for:<wbr>)</a>
  897. </code>
  898. </div>
  899. <div class="height-container">
  900. <div class="pointer-container"></div>
  901. <section class="section">
  902. <div class="pointer"></div>
  903. <div class="abstract">
  904. <p>Case-insensitively find a header&rsquo;s value by name.</p>
  905. </div>
  906. <div class="declaration">
  907. <h4>Declaration</h4>
  908. <div class="language">
  909. <p class="aside-title">Swift</p>
  910. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="k">for</span> <span class="nv">name</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>
  911. </div>
  912. </div>
  913. <div>
  914. <h4>Parameters</h4>
  915. <table class="graybox">
  916. <tbody>
  917. <tr>
  918. <td>
  919. <code>
  920. <em>name</em>
  921. </code>
  922. </td>
  923. <td>
  924. <div>
  925. <p>The name of the header to search for, case-insensitively.</p>
  926. </div>
  927. </td>
  928. </tr>
  929. </tbody>
  930. </table>
  931. </div>
  932. <div>
  933. <h4>Return Value</h4>
  934. <p>The value of header, if it exists.</p>
  935. </div>
  936. </section>
  937. </div>
  938. </li>
  939. <li class="item">
  940. <div>
  941. <code>
  942. <a name="/s:9Alamofire11HTTPHeadersVySSSgSScip"></a>
  943. <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
  944. <a class="token" href="#/s:9Alamofire11HTTPHeadersVySSSgSScip">subscript(_:<wbr>)</a>
  945. </code>
  946. </div>
  947. <div class="height-container">
  948. <div class="pointer-container"></div>
  949. <section class="section">
  950. <div class="pointer"></div>
  951. <div class="abstract">
  952. <p>Case-insensitively access the header with the given name.</p>
  953. </div>
  954. <div class="declaration">
  955. <h4>Declaration</h4>
  956. <div class="language">
  957. <p class="aside-title">Swift</p>
  958. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">name</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> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  959. </div>
  960. </div>
  961. <div>
  962. <h4>Parameters</h4>
  963. <table class="graybox">
  964. <tbody>
  965. <tr>
  966. <td>
  967. <code>
  968. <em>name</em>
  969. </code>
  970. </td>
  971. <td>
  972. <div>
  973. <p>The name of the header.</p>
  974. </div>
  975. </td>
  976. </tr>
  977. </tbody>
  978. </table>
  979. </div>
  980. </section>
  981. </div>
  982. </li>
  983. <li class="item">
  984. <div>
  985. <code>
  986. <a name="/s:9Alamofire11HTTPHeadersV10dictionarySDyS2SGvp"></a>
  987. <a name="//apple_ref/swift/Property/dictionary" class="dashAnchor"></a>
  988. <a class="token" href="#/s:9Alamofire11HTTPHeadersV10dictionarySDyS2SGvp">dictionary</a>
  989. </code>
  990. </div>
  991. <div class="height-container">
  992. <div class="pointer-container"></div>
  993. <section class="section">
  994. <div class="pointer"></div>
  995. <div class="abstract">
  996. <p>The dictionary representation of all headers.</p>
  997. <p>This representation does not preserve the current order of the instance.</p>
  998. </div>
  999. <div class="declaration">
  1000. <h4>Declaration</h4>
  1001. <div class="language">
  1002. <p class="aside-title">Swift</p>
  1003. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">dictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">String</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1004. </div>
  1005. </div>
  1006. </section>
  1007. </div>
  1008. </li>
  1009. <li class="item">
  1010. <div>
  1011. <code>
  1012. <a name="/s:s30ExpressibleByDictionaryLiteralP010dictionaryD0x3KeyQz_5ValueQztd_tcfc"></a>
  1013. <a name="//apple_ref/swift/Method/init(dictionaryLiteral:)" class="dashAnchor"></a>
  1014. <a class="token" href="#/s:s30ExpressibleByDictionaryLiteralP010dictionaryD0x3KeyQz_5ValueQztd_tcfc">init(dictionaryLiteral:<wbr>)</a>
  1015. </code>
  1016. </div>
  1017. <div class="height-container">
  1018. <div class="pointer-container"></div>
  1019. <section class="section">
  1020. <div class="pointer"></div>
  1021. <div class="abstract">
  1022. </div>
  1023. <div class="declaration">
  1024. <h4>Declaration</h4>
  1025. <div class="language">
  1026. <p class="aside-title">Swift</p>
  1027. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">dictionaryLiteral</span> <span class="nv">elements</span><span class="p">:</span> <span class="p">(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)</span><span class="o">...</span><span class="p">)</span></code></pre>
  1028. </div>
  1029. </div>
  1030. </section>
  1031. </div>
  1032. </li>
  1033. <li class="item">
  1034. <div>
  1035. <code>
  1036. <a name="/s:s25ExpressibleByArrayLiteralP05arrayD0x0cD7ElementQzd_tcfc"></a>
  1037. <a name="//apple_ref/swift/Method/init(arrayLiteral:)" class="dashAnchor"></a>
  1038. <a class="token" href="#/s:s25ExpressibleByArrayLiteralP05arrayD0x0cD7ElementQzd_tcfc">init(arrayLiteral:<wbr>)</a>
  1039. </code>
  1040. </div>
  1041. <div class="height-container">
  1042. <div class="pointer-container"></div>
  1043. <section class="section">
  1044. <div class="pointer"></div>
  1045. <div class="abstract">
  1046. </div>
  1047. <div class="declaration">
  1048. <h4>Declaration</h4>
  1049. <div class="language">
  1050. <p class="aside-title">Swift</p>
  1051. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">arrayLiteral</span> <span class="nv">elements</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span><span class="o">...</span><span class="p">)</span></code></pre>
  1052. </div>
  1053. </div>
  1054. </section>
  1055. </div>
  1056. </li>
  1057. <li class="item">
  1058. <div>
  1059. <code>
  1060. <a name="/s:ST12makeIterator0B0QzyF"></a>
  1061. <a name="//apple_ref/swift/Method/makeIterator()" class="dashAnchor"></a>
  1062. <a class="token" href="#/s:ST12makeIterator0B0QzyF">makeIterator()</a>
  1063. </code>
  1064. </div>
  1065. <div class="height-container">
  1066. <div class="pointer-container"></div>
  1067. <section class="section">
  1068. <div class="pointer"></div>
  1069. <div class="abstract">
  1070. </div>
  1071. <div class="declaration">
  1072. <h4>Declaration</h4>
  1073. <div class="language">
  1074. <p class="aside-title">Swift</p>
  1075. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">makeIterator</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">IndexingIterator</span><span class="o">&lt;</span><span class="p">[</span><span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span><span class="p">]</span><span class="o">&gt;</span></code></pre>
  1076. </div>
  1077. </div>
  1078. </section>
  1079. </div>
  1080. </li>
  1081. <li class="item">
  1082. <div>
  1083. <code>
  1084. <a name="/s:Sl10startIndex0B0Qzvp"></a>
  1085. <a name="//apple_ref/swift/Property/startIndex" class="dashAnchor"></a>
  1086. <a class="token" href="#/s:Sl10startIndex0B0Qzvp">startIndex</a>
  1087. </code>
  1088. </div>
  1089. <div class="height-container">
  1090. <div class="pointer-container"></div>
  1091. <section class="section">
  1092. <div class="pointer"></div>
  1093. <div class="abstract">
  1094. </div>
  1095. <div class="declaration">
  1096. <h4>Declaration</h4>
  1097. <div class="language">
  1098. <p class="aside-title">Swift</p>
  1099. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startIndex</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1100. </div>
  1101. </div>
  1102. </section>
  1103. </div>
  1104. </li>
  1105. <li class="item">
  1106. <div>
  1107. <code>
  1108. <a name="/s:Sl8endIndex0B0Qzvp"></a>
  1109. <a name="//apple_ref/swift/Property/endIndex" class="dashAnchor"></a>
  1110. <a class="token" href="#/s:Sl8endIndex0B0Qzvp">endIndex</a>
  1111. </code>
  1112. </div>
  1113. <div class="height-container">
  1114. <div class="pointer-container"></div>
  1115. <section class="section">
  1116. <div class="pointer"></div>
  1117. <div class="abstract">
  1118. </div>
  1119. <div class="declaration">
  1120. <h4>Declaration</h4>
  1121. <div class="language">
  1122. <p class="aside-title">Swift</p>
  1123. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">endIndex</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1124. </div>
  1125. </div>
  1126. </section>
  1127. </div>
  1128. </li>
  1129. <li class="item">
  1130. <div>
  1131. <code>
  1132. <a name="/s:Sly7ElementQz5IndexQzcip"></a>
  1133. <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
  1134. <a class="token" href="#/s:Sly7ElementQz5IndexQzcip">subscript(_:<wbr>)</a>
  1135. </code>
  1136. </div>
  1137. <div class="height-container">
  1138. <div class="pointer-container"></div>
  1139. <section class="section">
  1140. <div class="pointer"></div>
  1141. <div class="abstract">
  1142. </div>
  1143. <div class="declaration">
  1144. <h4>Declaration</h4>
  1145. <div class="language">
  1146. <p class="aside-title">Swift</p>
  1147. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">position</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/HTTPHeader.html">HTTPHeader</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1148. </div>
  1149. </div>
  1150. </section>
  1151. </div>
  1152. </li>
  1153. <li class="item">
  1154. <div>
  1155. <code>
  1156. <a name="/s:Sl5index5after5IndexQzAD_tF"></a>
  1157. <a name="//apple_ref/swift/Method/index(after:)" class="dashAnchor"></a>
  1158. <a class="token" href="#/s:Sl5index5after5IndexQzAD_tF">index(after:<wbr>)</a>
  1159. </code>
  1160. </div>
  1161. <div class="height-container">
  1162. <div class="pointer-container"></div>
  1163. <section class="section">
  1164. <div class="pointer"></div>
  1165. <div class="abstract">
  1166. </div>
  1167. <div class="declaration">
  1168. <h4>Declaration</h4>
  1169. <div class="language">
  1170. <p class="aside-title">Swift</p>
  1171. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">index</span><span class="p">(</span><span class="n">after</span> <span class="nv">i</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Int</span></code></pre>
  1172. </div>
  1173. </div>
  1174. </section>
  1175. </div>
  1176. </li>
  1177. <li class="item">
  1178. <div>
  1179. <code>
  1180. <a name="/s:s23CustomStringConvertibleP11descriptionSSvp"></a>
  1181. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  1182. <a class="token" href="#/s:s23CustomStringConvertibleP11descriptionSSvp">description</a>
  1183. </code>
  1184. </div>
  1185. <div class="height-container">
  1186. <div class="pointer-container"></div>
  1187. <section class="section">
  1188. <div class="pointer"></div>
  1189. <div class="abstract">
  1190. </div>
  1191. <div class="declaration">
  1192. <h4>Declaration</h4>
  1193. <div class="language">
  1194. <p class="aside-title">Swift</p>
  1195. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1196. </div>
  1197. </div>
  1198. </section>
  1199. </div>
  1200. </li>
  1201. </ul>
  1202. </div>
  1203. <div class="task-group">
  1204. <div class="task-name-container">
  1205. <a name="/Defaults"></a>
  1206. <a name="//apple_ref/swift/Section/Defaults" class="dashAnchor"></a>
  1207. <div class="section-name-container">
  1208. <a class="section-name-link" href="#/Defaults"></a>
  1209. <h3 class="section-name"><p>Defaults</p>
  1210. </h3>
  1211. </div>
  1212. </div>
  1213. <ul class="item-container">
  1214. <li class="item">
  1215. <div>
  1216. <code>
  1217. <a name="/s:9Alamofire11HTTPHeadersV7defaultACvpZ"></a>
  1218. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  1219. <a class="token" href="#/s:9Alamofire11HTTPHeadersV7defaultACvpZ">default</a>
  1220. </code>
  1221. </div>
  1222. <div class="height-container">
  1223. <div class="pointer-container"></div>
  1224. <section class="section">
  1225. <div class="pointer"></div>
  1226. <div class="abstract">
  1227. <p>The default set of <code>HTTPHeaders</code> used by Alamofire. Includes <code>Accept-Encoding</code>, <code>Accept-Language</code>, and
  1228. <code>User-Agent</code>.</p>
  1229. </div>
  1230. <div class="declaration">
  1231. <h4>Declaration</h4>
  1232. <div class="language">
  1233. <p class="aside-title">Swift</p>
  1234. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">let</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">HTTPHeaders</span></code></pre>
  1235. </div>
  1236. </div>
  1237. </section>
  1238. </div>
  1239. </li>
  1240. </ul>
  1241. </div>
  1242. </div>
  1243. </section>
  1244. </article>
  1245. </div>
  1246. <section class="footer">
  1247. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-12-20)</p>
  1248. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1249. </section>
  1250. </body>
  1251. </div>
  1252. </html>