HTTPHeader.html 75 KB

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