HTTPHeaders.html 71 KB

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