HTTPHeader.html 76 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>HTTPHeader 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/HTTPHeader" class="dashAnchor"></a>
  16. <a title="HTTPHeader 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.11.0 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. HTTPHeader 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/OfflineRetrier.html">OfflineRetrier</a>
  138. </li>
  139. <li class="nav-group-task">
  140. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  141. </li>
  142. <li class="nav-group-task">
  143. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  144. </li>
  145. <li class="nav-group-task">
  146. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  147. </li>
  148. <li class="nav-group-task">
  149. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  150. </li>
  151. <li class="nav-group-task">
  152. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  153. </li>
  154. <li class="nav-group-task">
  155. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  156. </li>
  157. <li class="nav-group-task">
  158. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  159. </li>
  160. <li class="nav-group-task">
  161. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  162. </li>
  163. <li class="nav-group-task">
  164. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  165. </li>
  166. <li class="nav-group-task">
  167. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  168. </li>
  169. <li class="nav-group-task">
  170. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  171. </li>
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="../Classes/Session/RequestSetup.html">– RequestSetup</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  230. </li>
  231. </ul>
  232. </li>
  233. <li class="nav-group-name">
  234. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  235. <ul class="nav-group-tasks">
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  271. </li>
  272. </ul>
  273. </li>
  274. <li class="nav-group-name">
  275. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  276. <ul class="nav-group-tasks">
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
  333. </li>
  334. </ul>
  335. </li>
  336. <li class="nav-group-name">
  337. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  338. <ul class="nav-group-tasks">
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
  413. </li>
  414. </ul>
  415. </li>
  416. <li class="nav-group-name">
  417. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  418. <ul class="nav-group-tasks">
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  430. </li>
  431. <li class="nav-group-task">
  432. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  433. </li>
  434. <li class="nav-group-task">
  435. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  436. </li>
  437. <li class="nav-group-task">
  438. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  439. </li>
  440. <li class="nav-group-task">
  441. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
  442. </li>
  443. <li class="nav-group-task">
  444. <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
  445. </li>
  446. <li class="nav-group-task">
  447. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  448. </li>
  449. <li class="nav-group-task">
  450. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  451. </li>
  452. <li class="nav-group-task">
  453. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  454. </li>
  455. <li class="nav-group-task">
  456. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  457. </li>
  458. <li class="nav-group-task">
  459. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  460. </li>
  461. <li class="nav-group-task">
  462. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  463. </li>
  464. <li class="nav-group-task">
  465. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  466. </li>
  467. <li class="nav-group-task">
  468. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  469. </li>
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  490. </li>
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  529. </li>
  530. </ul>
  531. </li>
  532. <li class="nav-group-name">
  533. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  534. <ul class="nav-group-tasks">
  535. <li class="nav-group-task">
  536. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  537. </li>
  538. <li class="nav-group-task">
  539. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  540. </li>
  541. <li class="nav-group-task">
  542. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  543. </li>
  544. <li class="nav-group-task">
  545. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  546. </li>
  547. <li class="nav-group-task">
  548. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  549. </li>
  550. <li class="nav-group-task">
  551. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  552. </li>
  553. <li class="nav-group-task">
  554. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  555. </li>
  556. </ul>
  557. </li>
  558. </ul>
  559. </nav>
  560. <article class="main-content">
  561. <section class="section">
  562. <div class="section-content top-matter">
  563. <h1>HTTPHeader</h1>
  564. <div class="declaration">
  565. <div class="language">
  566. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeader</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>
  567. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeader</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  568. </div>
  569. </div>
  570. <p>A representation of a single HTTP header&rsquo;s name / value pair.</p>
  571. </div>
  572. </section>
  573. <section class="section">
  574. <div class="section-content">
  575. <div class="task-group">
  576. <ul class="item-container">
  577. <li class="item">
  578. <div>
  579. <code>
  580. <a name="/s:9Alamofire10HTTPHeaderV4nameSSvp"></a>
  581. <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
  582. <a class="token" href="#/s:9Alamofire10HTTPHeaderV4nameSSvp">name</a>
  583. </code>
  584. </div>
  585. <div class="height-container">
  586. <div class="pointer-container"></div>
  587. <section class="section">
  588. <div class="pointer"></div>
  589. <div class="abstract">
  590. <p>Name of the header.</p>
  591. </div>
  592. <div class="declaration">
  593. <h4>Declaration</h4>
  594. <div class="language">
  595. <p class="aside-title">Swift</p>
  596. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  597. </div>
  598. </div>
  599. </section>
  600. </div>
  601. </li>
  602. <li class="item">
  603. <div>
  604. <code>
  605. <a name="/s:9Alamofire10HTTPHeaderV5valueSSvp"></a>
  606. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  607. <a class="token" href="#/s:9Alamofire10HTTPHeaderV5valueSSvp">value</a>
  608. </code>
  609. </div>
  610. <div class="height-container">
  611. <div class="pointer-container"></div>
  612. <section class="section">
  613. <div class="pointer"></div>
  614. <div class="abstract">
  615. <p>Value of the header.</p>
  616. </div>
  617. <div class="declaration">
  618. <h4>Declaration</h4>
  619. <div class="language">
  620. <p class="aside-title">Swift</p>
  621. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  622. </div>
  623. </div>
  624. </section>
  625. </div>
  626. </li>
  627. <li class="item">
  628. <div>
  629. <code>
  630. <a name="/s:9Alamofire10HTTPHeaderV4name5valueACSS_SStcfc"></a>
  631. <a name="//apple_ref/swift/Method/init(name:value:)" class="dashAnchor"></a>
  632. <a class="token" href="#/s:9Alamofire10HTTPHeaderV4name5valueACSS_SStcfc">init(name:<wbr>value:<wbr>)</a>
  633. </code>
  634. </div>
  635. <div class="height-container">
  636. <div class="pointer-container"></div>
  637. <section class="section">
  638. <div class="pointer"></div>
  639. <div class="abstract">
  640. <p>Creates an instance from the given <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV4nameSSvp">name</a></code> and <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV5valueSSvp">value</a></code>.</p>
  641. </div>
  642. <div class="declaration">
  643. <h4>Declaration</h4>
  644. <div class="language">
  645. <p class="aside-title">Swift</p>
  646. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</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>
  647. </div>
  648. </div>
  649. <div>
  650. <h4>Parameters</h4>
  651. <table class="graybox">
  652. <tbody>
  653. <tr>
  654. <td>
  655. <code>
  656. <em>name</em>
  657. </code>
  658. </td>
  659. <td>
  660. <div>
  661. <p>The name of the header.</p>
  662. </div>
  663. </td>
  664. </tr>
  665. <tr>
  666. <td>
  667. <code>
  668. <em>value</em>
  669. </code>
  670. </td>
  671. <td>
  672. <div>
  673. <p>The value of the header.</p>
  674. </div>
  675. </td>
  676. </tr>
  677. </tbody>
  678. </table>
  679. </div>
  680. </section>
  681. </div>
  682. </li>
  683. </ul>
  684. </div>
  685. <div class="task-group">
  686. <div class="task-name-container">
  687. <a name="/HTTPHeader"></a>
  688. <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
  689. <div class="section-name-container">
  690. <a class="section-name-link" href="#/HTTPHeader"></a>
  691. <h3 class="section-name"><span>HTTPHeader</span>
  692. </h3>
  693. </div>
  694. </div>
  695. <ul class="item-container">
  696. <li class="item">
  697. <div>
  698. <code>
  699. <a name="/s:s23CustomStringConvertibleP11descriptionSSvp"></a>
  700. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  701. <a class="token" href="#/s:s23CustomStringConvertibleP11descriptionSSvp">description</a>
  702. </code>
  703. </div>
  704. <div class="height-container">
  705. <div class="pointer-container"></div>
  706. <section class="section">
  707. <div class="pointer"></div>
  708. <div class="abstract">
  709. </div>
  710. <div class="declaration">
  711. <h4>Declaration</h4>
  712. <div class="language">
  713. <p class="aside-title">Swift</p>
  714. <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>
  715. </div>
  716. </div>
  717. </section>
  718. </div>
  719. </li>
  720. <li class="item">
  721. <div>
  722. <code>
  723. <a name="/s:9Alamofire10HTTPHeaderV6acceptyACSSFZ"></a>
  724. <a name="//apple_ref/swift/Method/accept(_:)" class="dashAnchor"></a>
  725. <a class="token" href="#/s:9Alamofire10HTTPHeaderV6acceptyACSSFZ">accept(_:<wbr>)</a>
  726. </code>
  727. </div>
  728. <div class="height-container">
  729. <div class="pointer-container"></div>
  730. <section class="section">
  731. <div class="pointer"></div>
  732. <div class="abstract">
  733. <p>Returns an <code>Accept</code> header.</p>
  734. </div>
  735. <div class="declaration">
  736. <h4>Declaration</h4>
  737. <div class="language">
  738. <p class="aside-title">Swift</p>
  739. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">accept</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  740. </div>
  741. </div>
  742. <div>
  743. <h4>Parameters</h4>
  744. <table class="graybox">
  745. <tbody>
  746. <tr>
  747. <td>
  748. <code>
  749. <em>value</em>
  750. </code>
  751. </td>
  752. <td>
  753. <div>
  754. <p>The <code>Accept</code> value.</p>
  755. </div>
  756. </td>
  757. </tr>
  758. </tbody>
  759. </table>
  760. </div>
  761. <div>
  762. <h4>Return Value</h4>
  763. <p>The header.</p>
  764. </div>
  765. </section>
  766. </div>
  767. </li>
  768. <li class="item">
  769. <div>
  770. <code>
  771. <a name="/s:9Alamofire10HTTPHeaderV13acceptCharsetyACSSFZ"></a>
  772. <a name="//apple_ref/swift/Method/acceptCharset(_:)" class="dashAnchor"></a>
  773. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13acceptCharsetyACSSFZ">acceptCharset(_:<wbr>)</a>
  774. </code>
  775. </div>
  776. <div class="height-container">
  777. <div class="pointer-container"></div>
  778. <section class="section">
  779. <div class="pointer"></div>
  780. <div class="abstract">
  781. <p>Returns an <code>Accept-Charset</code> header.</p>
  782. </div>
  783. <div class="declaration">
  784. <h4>Declaration</h4>
  785. <div class="language">
  786. <p class="aside-title">Swift</p>
  787. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">acceptCharset</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  788. </div>
  789. </div>
  790. <div>
  791. <h4>Parameters</h4>
  792. <table class="graybox">
  793. <tbody>
  794. <tr>
  795. <td>
  796. <code>
  797. <em>value</em>
  798. </code>
  799. </td>
  800. <td>
  801. <div>
  802. <p>The <code>Accept-Charset</code> value.</p>
  803. </div>
  804. </td>
  805. </tr>
  806. </tbody>
  807. </table>
  808. </div>
  809. <div>
  810. <h4>Return Value</h4>
  811. <p>The header.</p>
  812. </div>
  813. </section>
  814. </div>
  815. </li>
  816. <li class="item">
  817. <div>
  818. <code>
  819. <a name="/s:9Alamofire10HTTPHeaderV14acceptLanguageyACSSFZ"></a>
  820. <a name="//apple_ref/swift/Method/acceptLanguage(_:)" class="dashAnchor"></a>
  821. <a class="token" href="#/s:9Alamofire10HTTPHeaderV14acceptLanguageyACSSFZ">acceptLanguage(_:<wbr>)</a>
  822. </code>
  823. </div>
  824. <div class="height-container">
  825. <div class="pointer-container"></div>
  826. <section class="section">
  827. <div class="pointer"></div>
  828. <div class="abstract">
  829. <p>Returns an <code>Accept-Language</code> header.</p>
  830. <p>Alamofire offers a default Accept-Language header that accumulates and encodes the system&rsquo;s preferred languages.
  831. Use <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ">HTTPHeader.defaultAcceptLanguage</a></code>.</p>
  832. </div>
  833. <div class="declaration">
  834. <h4>Declaration</h4>
  835. <div class="language">
  836. <p class="aside-title">Swift</p>
  837. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">acceptLanguage</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  838. </div>
  839. </div>
  840. <div>
  841. <h4>Parameters</h4>
  842. <table class="graybox">
  843. <tbody>
  844. <tr>
  845. <td>
  846. <code>
  847. <em>value</em>
  848. </code>
  849. </td>
  850. <td>
  851. <div>
  852. <p>The <code>Accept-Language</code> value.</p>
  853. </div>
  854. </td>
  855. </tr>
  856. </tbody>
  857. </table>
  858. </div>
  859. <div>
  860. <h4>Return Value</h4>
  861. <p>The header.</p>
  862. </div>
  863. </section>
  864. </div>
  865. </li>
  866. <li class="item">
  867. <div>
  868. <code>
  869. <a name="/s:9Alamofire10HTTPHeaderV14acceptEncodingyACSSFZ"></a>
  870. <a name="//apple_ref/swift/Method/acceptEncoding(_:)" class="dashAnchor"></a>
  871. <a class="token" href="#/s:9Alamofire10HTTPHeaderV14acceptEncodingyACSSFZ">acceptEncoding(_:<wbr>)</a>
  872. </code>
  873. </div>
  874. <div class="height-container">
  875. <div class="pointer-container"></div>
  876. <section class="section">
  877. <div class="pointer"></div>
  878. <div class="abstract">
  879. <p>Returns an <code>Accept-Encoding</code> header.</p>
  880. <p>Alamofire offers a default accept encoding value that provides the most common values. Use
  881. <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ">HTTPHeader.defaultAcceptEncoding</a></code>.</p>
  882. </div>
  883. <div class="declaration">
  884. <h4>Declaration</h4>
  885. <div class="language">
  886. <p class="aside-title">Swift</p>
  887. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">acceptEncoding</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  888. </div>
  889. </div>
  890. <div>
  891. <h4>Parameters</h4>
  892. <table class="graybox">
  893. <tbody>
  894. <tr>
  895. <td>
  896. <code>
  897. <em>value</em>
  898. </code>
  899. </td>
  900. <td>
  901. <div>
  902. <p>The <code>Accept-Encoding</code> value.</p>
  903. </div>
  904. </td>
  905. </tr>
  906. </tbody>
  907. </table>
  908. </div>
  909. <div>
  910. <h4>Return Value</h4>
  911. <p>The header</p>
  912. </div>
  913. </section>
  914. </div>
  915. </li>
  916. <li class="item">
  917. <div>
  918. <code>
  919. <a name="/s:9Alamofire10HTTPHeaderV13authorization8username8passwordACSS_SStFZ"></a>
  920. <a name="//apple_ref/swift/Method/authorization(username:password:)" class="dashAnchor"></a>
  921. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorization8username8passwordACSS_SStFZ">authorization(username:<wbr>password:<wbr>)</a>
  922. </code>
  923. </div>
  924. <div class="height-container">
  925. <div class="pointer-container"></div>
  926. <section class="section">
  927. <div class="pointer"></div>
  928. <div class="abstract">
  929. <p>Returns a <code>Basic</code> <code>Authorization</code> header using the <code>username</code> and <code>password</code> provided.</p>
  930. </div>
  931. <div class="declaration">
  932. <h4>Declaration</h4>
  933. <div class="language">
  934. <p class="aside-title">Swift</p>
  935. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authorization</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  936. </div>
  937. </div>
  938. <div>
  939. <h4>Parameters</h4>
  940. <table class="graybox">
  941. <tbody>
  942. <tr>
  943. <td>
  944. <code>
  945. <em>username</em>
  946. </code>
  947. </td>
  948. <td>
  949. <div>
  950. <p>The username of the header.</p>
  951. </div>
  952. </td>
  953. </tr>
  954. <tr>
  955. <td>
  956. <code>
  957. <em>password</em>
  958. </code>
  959. </td>
  960. <td>
  961. <div>
  962. <p>The password of the header.</p>
  963. </div>
  964. </td>
  965. </tr>
  966. </tbody>
  967. </table>
  968. </div>
  969. <div>
  970. <h4>Return Value</h4>
  971. <p>The header.</p>
  972. </div>
  973. </section>
  974. </div>
  975. </li>
  976. <li class="item">
  977. <div>
  978. <code>
  979. <a name="/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ"></a>
  980. <a name="//apple_ref/swift/Method/authorization(bearerToken:)" class="dashAnchor"></a>
  981. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ">authorization(bearerToken:<wbr>)</a>
  982. </code>
  983. </div>
  984. <div class="height-container">
  985. <div class="pointer-container"></div>
  986. <section class="section">
  987. <div class="pointer"></div>
  988. <div class="abstract">
  989. <p>Returns a <code>Bearer</code> <code>Authorization</code> header using the <code>bearerToken</code> provided.</p>
  990. </div>
  991. <div class="declaration">
  992. <h4>Declaration</h4>
  993. <div class="language">
  994. <p class="aside-title">Swift</p>
  995. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authorization</span><span class="p">(</span><span class="nv">bearerToken</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  996. </div>
  997. </div>
  998. <div>
  999. <h4>Parameters</h4>
  1000. <table class="graybox">
  1001. <tbody>
  1002. <tr>
  1003. <td>
  1004. <code>
  1005. <em>bearerToken</em>
  1006. </code>
  1007. </td>
  1008. <td>
  1009. <div>
  1010. <p>The bearer token.</p>
  1011. </div>
  1012. </td>
  1013. </tr>
  1014. </tbody>
  1015. </table>
  1016. </div>
  1017. <div>
  1018. <h4>Return Value</h4>
  1019. <p>The header.</p>
  1020. </div>
  1021. </section>
  1022. </div>
  1023. </li>
  1024. <li class="item">
  1025. <div>
  1026. <code>
  1027. <a name="/s:9Alamofire10HTTPHeaderV13authorizationyACSSFZ"></a>
  1028. <a name="//apple_ref/swift/Method/authorization(_:)" class="dashAnchor"></a>
  1029. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorizationyACSSFZ">authorization(_:<wbr>)</a>
  1030. </code>
  1031. </div>
  1032. <div class="height-container">
  1033. <div class="pointer-container"></div>
  1034. <section class="section">
  1035. <div class="pointer"></div>
  1036. <div class="abstract">
  1037. <p>Returns an <code>Authorization</code> header.</p>
  1038. <p>Alamofire provides built-in methods to produce <code>Authorization</code> headers. For a Basic <code>Authorization</code> header use
  1039. <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV13authorization8username8passwordACSS_SStFZ">HTTPHeader.authorization(username:password:)</a></code>. For a Bearer <code>Authorization</code> header, use
  1040. <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ">HTTPHeader.authorization(bearerToken:)</a></code>.</p>
  1041. </div>
  1042. <div class="declaration">
  1043. <h4>Declaration</h4>
  1044. <div class="language">
  1045. <p class="aside-title">Swift</p>
  1046. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">authorization</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1047. </div>
  1048. </div>
  1049. <div>
  1050. <h4>Parameters</h4>
  1051. <table class="graybox">
  1052. <tbody>
  1053. <tr>
  1054. <td>
  1055. <code>
  1056. <em>value</em>
  1057. </code>
  1058. </td>
  1059. <td>
  1060. <div>
  1061. <p>The <code>Authorization</code> value.</p>
  1062. </div>
  1063. </td>
  1064. </tr>
  1065. </tbody>
  1066. </table>
  1067. </div>
  1068. <div>
  1069. <h4>Return Value</h4>
  1070. <p>The header.</p>
  1071. </div>
  1072. </section>
  1073. </div>
  1074. </li>
  1075. <li class="item">
  1076. <div>
  1077. <code>
  1078. <a name="/s:9Alamofire10HTTPHeaderV18contentDispositionyACSSFZ"></a>
  1079. <a name="//apple_ref/swift/Method/contentDisposition(_:)" class="dashAnchor"></a>
  1080. <a class="token" href="#/s:9Alamofire10HTTPHeaderV18contentDispositionyACSSFZ">contentDisposition(_:<wbr>)</a>
  1081. </code>
  1082. </div>
  1083. <div class="height-container">
  1084. <div class="pointer-container"></div>
  1085. <section class="section">
  1086. <div class="pointer"></div>
  1087. <div class="abstract">
  1088. <p>Returns a <code>Content-Disposition</code> header.</p>
  1089. </div>
  1090. <div class="declaration">
  1091. <h4>Declaration</h4>
  1092. <div class="language">
  1093. <p class="aside-title">Swift</p>
  1094. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">contentDisposition</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1095. </div>
  1096. </div>
  1097. <div>
  1098. <h4>Parameters</h4>
  1099. <table class="graybox">
  1100. <tbody>
  1101. <tr>
  1102. <td>
  1103. <code>
  1104. <em>value</em>
  1105. </code>
  1106. </td>
  1107. <td>
  1108. <div>
  1109. <p>The <code>Content-Disposition</code> value.</p>
  1110. </div>
  1111. </td>
  1112. </tr>
  1113. </tbody>
  1114. </table>
  1115. </div>
  1116. <div>
  1117. <h4>Return Value</h4>
  1118. <p>The header.</p>
  1119. </div>
  1120. </section>
  1121. </div>
  1122. </li>
  1123. <li class="item">
  1124. <div>
  1125. <code>
  1126. <a name="/s:9Alamofire10HTTPHeaderV15contentEncodingyACSSFZ"></a>
  1127. <a name="//apple_ref/swift/Method/contentEncoding(_:)" class="dashAnchor"></a>
  1128. <a class="token" href="#/s:9Alamofire10HTTPHeaderV15contentEncodingyACSSFZ">contentEncoding(_:<wbr>)</a>
  1129. </code>
  1130. </div>
  1131. <div class="height-container">
  1132. <div class="pointer-container"></div>
  1133. <section class="section">
  1134. <div class="pointer"></div>
  1135. <div class="abstract">
  1136. <p>Returns a <code>Content-Encoding</code> header.</p>
  1137. </div>
  1138. <div class="declaration">
  1139. <h4>Declaration</h4>
  1140. <div class="language">
  1141. <p class="aside-title">Swift</p>
  1142. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">contentEncoding</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1143. </div>
  1144. </div>
  1145. <div>
  1146. <h4>Parameters</h4>
  1147. <table class="graybox">
  1148. <tbody>
  1149. <tr>
  1150. <td>
  1151. <code>
  1152. <em>value</em>
  1153. </code>
  1154. </td>
  1155. <td>
  1156. <div>
  1157. <p>The <code>Content-Encoding</code>.</p>
  1158. </div>
  1159. </td>
  1160. </tr>
  1161. </tbody>
  1162. </table>
  1163. </div>
  1164. <div>
  1165. <h4>Return Value</h4>
  1166. <p>The header.</p>
  1167. </div>
  1168. </section>
  1169. </div>
  1170. </li>
  1171. <li class="item">
  1172. <div>
  1173. <code>
  1174. <a name="/s:9Alamofire10HTTPHeaderV11contentTypeyACSSFZ"></a>
  1175. <a name="//apple_ref/swift/Method/contentType(_:)" class="dashAnchor"></a>
  1176. <a class="token" href="#/s:9Alamofire10HTTPHeaderV11contentTypeyACSSFZ">contentType(_:<wbr>)</a>
  1177. </code>
  1178. </div>
  1179. <div class="height-container">
  1180. <div class="pointer-container"></div>
  1181. <section class="section">
  1182. <div class="pointer"></div>
  1183. <div class="abstract">
  1184. <p>Returns a <code>Content-Type</code> header.</p>
  1185. <p>All Alamofire <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>s and <code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code>s set the <code>Content-Type</code> of the request, so it may not
  1186. be necessary to manually set this value.</p>
  1187. </div>
  1188. <div class="declaration">
  1189. <h4>Declaration</h4>
  1190. <div class="language">
  1191. <p class="aside-title">Swift</p>
  1192. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">contentType</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1193. </div>
  1194. </div>
  1195. <div>
  1196. <h4>Parameters</h4>
  1197. <table class="graybox">
  1198. <tbody>
  1199. <tr>
  1200. <td>
  1201. <code>
  1202. <em>value</em>
  1203. </code>
  1204. </td>
  1205. <td>
  1206. <div>
  1207. <p>The <code>Content-Type</code> value.</p>
  1208. </div>
  1209. </td>
  1210. </tr>
  1211. </tbody>
  1212. </table>
  1213. </div>
  1214. <div>
  1215. <h4>Return Value</h4>
  1216. <p>The header.</p>
  1217. </div>
  1218. </section>
  1219. </div>
  1220. </li>
  1221. <li class="item">
  1222. <div>
  1223. <code>
  1224. <a name="/s:9Alamofire10HTTPHeaderV9userAgentyACSSFZ"></a>
  1225. <a name="//apple_ref/swift/Method/userAgent(_:)" class="dashAnchor"></a>
  1226. <a class="token" href="#/s:9Alamofire10HTTPHeaderV9userAgentyACSSFZ">userAgent(_:<wbr>)</a>
  1227. </code>
  1228. </div>
  1229. <div class="height-container">
  1230. <div class="pointer-container"></div>
  1231. <section class="section">
  1232. <div class="pointer"></div>
  1233. <div class="abstract">
  1234. <p>Returns a <code>User-Agent</code> header.</p>
  1235. </div>
  1236. <div class="declaration">
  1237. <h4>Declaration</h4>
  1238. <div class="language">
  1239. <p class="aside-title">Swift</p>
  1240. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">userAgent</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1241. </div>
  1242. </div>
  1243. <div>
  1244. <h4>Parameters</h4>
  1245. <table class="graybox">
  1246. <tbody>
  1247. <tr>
  1248. <td>
  1249. <code>
  1250. <em>value</em>
  1251. </code>
  1252. </td>
  1253. <td>
  1254. <div>
  1255. <p>The <code>User-Agent</code> value.</p>
  1256. </div>
  1257. </td>
  1258. </tr>
  1259. </tbody>
  1260. </table>
  1261. </div>
  1262. <div>
  1263. <h4>Return Value</h4>
  1264. <p>The header.</p>
  1265. </div>
  1266. </section>
  1267. </div>
  1268. </li>
  1269. <li class="item">
  1270. <div>
  1271. <code>
  1272. <a name="/s:9Alamofire10HTTPHeaderV17websocketProtocolyACSSFZ"></a>
  1273. <a name="//apple_ref/swift/Method/websocketProtocol(_:)" class="dashAnchor"></a>
  1274. <a class="token" href="#/s:9Alamofire10HTTPHeaderV17websocketProtocolyACSSFZ">websocketProtocol(_:<wbr>)</a>
  1275. </code>
  1276. </div>
  1277. <div class="height-container">
  1278. <div class="pointer-container"></div>
  1279. <section class="section">
  1280. <div class="pointer"></div>
  1281. <div class="abstract">
  1282. <p>Returns a <code>Sec-WebSocket-Protocol</code> header.</p>
  1283. </div>
  1284. <div class="declaration">
  1285. <h4>Declaration</h4>
  1286. <div class="language">
  1287. <p class="aside-title">Swift</p>
  1288. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">websocketProtocol</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">HTTPHeader</span></code></pre>
  1289. </div>
  1290. </div>
  1291. <div>
  1292. <h4>Parameters</h4>
  1293. <table class="graybox">
  1294. <tbody>
  1295. <tr>
  1296. <td>
  1297. <code>
  1298. <em>value</em>
  1299. </code>
  1300. </td>
  1301. <td>
  1302. <div>
  1303. <p>The <code>Sec-WebSocket-Protocol</code> value.</p>
  1304. </div>
  1305. </td>
  1306. </tr>
  1307. </tbody>
  1308. </table>
  1309. </div>
  1310. <div>
  1311. <h4>Return Value</h4>
  1312. <p>The header.</p>
  1313. </div>
  1314. </section>
  1315. </div>
  1316. </li>
  1317. </ul>
  1318. </div>
  1319. <div class="task-group">
  1320. <div class="task-name-container">
  1321. <a name="/Defaults"></a>
  1322. <a name="//apple_ref/swift/Section/Defaults" class="dashAnchor"></a>
  1323. <div class="section-name-container">
  1324. <a class="section-name-link" href="#/Defaults"></a>
  1325. <h3 class="section-name"><span>Defaults</span>
  1326. </h3>
  1327. </div>
  1328. </div>
  1329. <ul class="item-container">
  1330. <li class="item">
  1331. <div>
  1332. <code>
  1333. <a name="/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ"></a>
  1334. <a name="//apple_ref/swift/Variable/defaultAcceptEncoding" class="dashAnchor"></a>
  1335. <a class="token" href="#/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ">defaultAcceptEncoding</a>
  1336. </code>
  1337. </div>
  1338. <div class="height-container">
  1339. <div class="pointer-container"></div>
  1340. <section class="section">
  1341. <div class="pointer"></div>
  1342. <div class="abstract">
  1343. <p>Returns Alamofire&rsquo;s default <code>Accept-Encoding</code> header, appropriate for the encodings supported by particular OS
  1344. versions.</p>
  1345. <p>See the <a href="https://tools.ietf.org/html/rfc7230#section-4.2.3">Accept-Encoding HTTP header documentation</a> .</p>
  1346. </div>
  1347. <div class="declaration">
  1348. <h4>Declaration</h4>
  1349. <div class="language">
  1350. <p class="aside-title">Swift</p>
  1351. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultAcceptEncoding</span><span class="p">:</span> <span class="kt">HTTPHeader</span></code></pre>
  1352. </div>
  1353. </div>
  1354. </section>
  1355. </div>
  1356. </li>
  1357. <li class="item">
  1358. <div>
  1359. <code>
  1360. <a name="/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ"></a>
  1361. <a name="//apple_ref/swift/Variable/defaultAcceptLanguage" class="dashAnchor"></a>
  1362. <a class="token" href="#/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ">defaultAcceptLanguage</a>
  1363. </code>
  1364. </div>
  1365. <div class="height-container">
  1366. <div class="pointer-container"></div>
  1367. <section class="section">
  1368. <div class="pointer"></div>
  1369. <div class="abstract">
  1370. <p>Returns Alamofire&rsquo;s default <code>Accept-Language</code> header, generated by querying <code>Locale</code> for the user&rsquo;s
  1371. <code>preferredLanguages</code>.</p>
  1372. <p>See the <a href="https://tools.ietf.org/html/rfc7231#section-5.3.5">Accept-Language HTTP header documentation</a>.</p>
  1373. </div>
  1374. <div class="declaration">
  1375. <h4>Declaration</h4>
  1376. <div class="language">
  1377. <p class="aside-title">Swift</p>
  1378. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultAcceptLanguage</span><span class="p">:</span> <span class="kt">HTTPHeader</span></code></pre>
  1379. </div>
  1380. </div>
  1381. </section>
  1382. </div>
  1383. </li>
  1384. <li class="item">
  1385. <div>
  1386. <code>
  1387. <a name="/s:9Alamofire10HTTPHeaderV16defaultUserAgentACvpZ"></a>
  1388. <a name="//apple_ref/swift/Variable/defaultUserAgent" class="dashAnchor"></a>
  1389. <a class="token" href="#/s:9Alamofire10HTTPHeaderV16defaultUserAgentACvpZ">defaultUserAgent</a>
  1390. </code>
  1391. </div>
  1392. <div class="height-container">
  1393. <div class="pointer-container"></div>
  1394. <section class="section">
  1395. <div class="pointer"></div>
  1396. <div class="abstract">
  1397. <p>Returns Alamofire&rsquo;s default <code>User-Agent</code> header.</p>
  1398. <p>See the <a href="https://tools.ietf.org/html/rfc7231#section-5.5.3">User-Agent header documentation</a>.</p>
  1399. <p>Example: <code>iOS Example/1.0 (org.alamofire.iOS-Example; build:1; iOS 13.0.0) Alamofire/5.0.0</code></p>
  1400. </div>
  1401. <div class="declaration">
  1402. <h4>Declaration</h4>
  1403. <div class="language">
  1404. <p class="aside-title">Swift</p>
  1405. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultUserAgent</span><span class="p">:</span> <span class="kt">HTTPHeader</span></code></pre>
  1406. </div>
  1407. </div>
  1408. </section>
  1409. </div>
  1410. </li>
  1411. </ul>
  1412. </div>
  1413. </div>
  1414. </section>
  1415. </article>
  1416. </div>
  1417. <section class="footer">
  1418. <p>&copy; 2025 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2025-12-20)</p>
  1419. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  1420. </section>
  1421. </body>
  1422. </html>