HTTPHeader.html 67 KB

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