HTTPHeaders.html 72 KB

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