HTTPHeader.html 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178
  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 Docs
  21. </a>
  22. (75% 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%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  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/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/MultipartUpload.html">MultipartUpload</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  181. </li>
  182. </ul>
  183. </li>
  184. <li class="nav-group-name">
  185. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  186. <ul class="nav-group-tasks">
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  216. </li>
  217. </ul>
  218. </li>
  219. <li class="nav-group-name">
  220. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  221. <ul class="nav-group-tasks">
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  259. </li>
  260. </ul>
  261. </li>
  262. <li class="nav-group-name">
  263. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  264. <ul class="nav-group-tasks">
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/SessionStateProvider.html">SessionStateProvider</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  327. </li>
  328. </ul>
  329. </li>
  330. <li class="nav-group-name">
  331. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  332. <ul class="nav-group-tasks">
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  377. </li>
  378. </ul>
  379. </li>
  380. <li class="nav-group-name">
  381. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  382. <ul class="nav-group-tasks">
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  388. </li>
  389. <li class="nav-group-task">
  390. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  391. </li>
  392. <li class="nav-group-task">
  393. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </nav>
  399. <article class="main-content">
  400. <section class="section">
  401. <div class="section-content">
  402. <h1>HTTPHeader</h1>
  403. <div class="declaration">
  404. <div class="language">
  405. <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>
  406. </div>
  407. </div>
  408. <p>A representation of a single HTTP header&rsquo;s name / value pair.</p>
  409. </div>
  410. </section>
  411. <section class="section">
  412. <div class="section-content">
  413. <div class="task-group">
  414. <ul class="item-container">
  415. <li class="item">
  416. <div>
  417. <code>
  418. <a name="/s:9Alamofire10HTTPHeaderV4nameSSvp"></a>
  419. <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
  420. <a class="token" href="#/s:9Alamofire10HTTPHeaderV4nameSSvp">name</a>
  421. </code>
  422. </div>
  423. <div class="height-container">
  424. <div class="pointer-container"></div>
  425. <section class="section">
  426. <div class="pointer"></div>
  427. <div class="abstract">
  428. <p>Name of the header.</p>
  429. </div>
  430. <div class="declaration">
  431. <h4>Declaration</h4>
  432. <div class="language">
  433. <p class="aside-title">Swift</p>
  434. <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>
  435. </div>
  436. </div>
  437. </section>
  438. </div>
  439. </li>
  440. <li class="item">
  441. <div>
  442. <code>
  443. <a name="/s:9Alamofire10HTTPHeaderV5valueSSvp"></a>
  444. <a name="//apple_ref/swift/Property/value" class="dashAnchor"></a>
  445. <a class="token" href="#/s:9Alamofire10HTTPHeaderV5valueSSvp">value</a>
  446. </code>
  447. </div>
  448. <div class="height-container">
  449. <div class="pointer-container"></div>
  450. <section class="section">
  451. <div class="pointer"></div>
  452. <div class="abstract">
  453. <p>Value of the header.</p>
  454. </div>
  455. <div class="declaration">
  456. <h4>Declaration</h4>
  457. <div class="language">
  458. <p class="aside-title">Swift</p>
  459. <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>
  460. </div>
  461. </div>
  462. </section>
  463. </div>
  464. </li>
  465. <li class="item">
  466. <div>
  467. <code>
  468. <a name="/s:9Alamofire10HTTPHeaderV4name5valueACSS_SStcfc"></a>
  469. <a name="//apple_ref/swift/Method/init(name:value:)" class="dashAnchor"></a>
  470. <a class="token" href="#/s:9Alamofire10HTTPHeaderV4name5valueACSS_SStcfc">init(name:value:)</a>
  471. </code>
  472. </div>
  473. <div class="height-container">
  474. <div class="pointer-container"></div>
  475. <section class="section">
  476. <div class="pointer"></div>
  477. <div class="abstract">
  478. <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>
  479. </div>
  480. <div class="declaration">
  481. <h4>Declaration</h4>
  482. <div class="language">
  483. <p class="aside-title">Swift</p>
  484. <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>
  485. </div>
  486. </div>
  487. <div>
  488. <h4>Parameters</h4>
  489. <table class="graybox">
  490. <tbody>
  491. <tr>
  492. <td>
  493. <code>
  494. <em>name</em>
  495. </code>
  496. </td>
  497. <td>
  498. <div>
  499. <p>The name of the header.</p>
  500. </div>
  501. </td>
  502. </tr>
  503. <tr>
  504. <td>
  505. <code>
  506. <em>value</em>
  507. </code>
  508. </td>
  509. <td>
  510. <div>
  511. <p>The value of the header.</p>
  512. </div>
  513. </td>
  514. </tr>
  515. </tbody>
  516. </table>
  517. </div>
  518. </section>
  519. </div>
  520. </li>
  521. </ul>
  522. </div>
  523. <div class="task-group">
  524. <div class="task-name-container">
  525. <a name="/HTTPHeader"></a>
  526. <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
  527. <a href="#/HTTPHeader">
  528. <h3 class="section-name">HTTPHeader</h3>
  529. </a>
  530. </div>
  531. <ul class="item-container">
  532. <li class="item">
  533. <div>
  534. <code>
  535. <a name="/s:s23CustomStringConvertibleP11descriptionSSvp"></a>
  536. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  537. <a class="token" href="#/s:s23CustomStringConvertibleP11descriptionSSvp">description</a>
  538. </code>
  539. </div>
  540. <div class="height-container">
  541. <div class="pointer-container"></div>
  542. <section class="section">
  543. <div class="pointer"></div>
  544. <div class="abstract">
  545. </div>
  546. <div class="declaration">
  547. <h4>Declaration</h4>
  548. <div class="language">
  549. <p class="aside-title">Swift</p>
  550. <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>
  551. </div>
  552. </div>
  553. </section>
  554. </div>
  555. </li>
  556. </ul>
  557. </div>
  558. <div class="task-group">
  559. <div class="task-name-container">
  560. <a name="/HTTPHeader2"></a>
  561. <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
  562. <a href="#/HTTPHeader2">
  563. <h3 class="section-name">HTTPHeader</h3>
  564. </a>
  565. </div>
  566. <ul class="item-container">
  567. <li class="item">
  568. <div>
  569. <code>
  570. <a name="/s:9Alamofire10HTTPHeaderV13acceptCharsetyACSSFZ"></a>
  571. <a name="//apple_ref/swift/Method/acceptCharset(_:)" class="dashAnchor"></a>
  572. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13acceptCharsetyACSSFZ">acceptCharset(_:)</a>
  573. </code>
  574. </div>
  575. <div class="height-container">
  576. <div class="pointer-container"></div>
  577. <section class="section">
  578. <div class="pointer"></div>
  579. <div class="abstract">
  580. <p>Returns an <code>Accept-Charset</code> header.</p>
  581. </div>
  582. <div class="declaration">
  583. <h4>Declaration</h4>
  584. <div class="language">
  585. <p class="aside-title">Swift</p>
  586. <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>
  587. </div>
  588. </div>
  589. <div>
  590. <h4>Parameters</h4>
  591. <table class="graybox">
  592. <tbody>
  593. <tr>
  594. <td>
  595. <code>
  596. <em>value</em>
  597. </code>
  598. </td>
  599. <td>
  600. <div>
  601. <p>The <code>Accept-Charset</code> value.</p>
  602. </div>
  603. </td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. </div>
  608. <div>
  609. <h4>Return Value</h4>
  610. <p>The header.</p>
  611. </div>
  612. </section>
  613. </div>
  614. </li>
  615. <li class="item">
  616. <div>
  617. <code>
  618. <a name="/s:9Alamofire10HTTPHeaderV14acceptLanguageyACSSFZ"></a>
  619. <a name="//apple_ref/swift/Method/acceptLanguage(_:)" class="dashAnchor"></a>
  620. <a class="token" href="#/s:9Alamofire10HTTPHeaderV14acceptLanguageyACSSFZ">acceptLanguage(_:)</a>
  621. </code>
  622. </div>
  623. <div class="height-container">
  624. <div class="pointer-container"></div>
  625. <section class="section">
  626. <div class="pointer"></div>
  627. <div class="abstract">
  628. <p>Returns an <code>Accept-Language</code> header.</p>
  629. <p>Alamofire offers a default Accept-Language header that accumulates and encodes the system&rsquo;s preferred languages.
  630. Use <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ">HTTPHeader.defaultAcceptLanguage</a></code>.</p>
  631. </div>
  632. <div class="declaration">
  633. <h4>Declaration</h4>
  634. <div class="language">
  635. <p class="aside-title">Swift</p>
  636. <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>
  637. </div>
  638. </div>
  639. <div>
  640. <h4>Parameters</h4>
  641. <table class="graybox">
  642. <tbody>
  643. <tr>
  644. <td>
  645. <code>
  646. <em>value</em>
  647. </code>
  648. </td>
  649. <td>
  650. <div>
  651. <p>The <code>Accept-Language</code> value.</p>
  652. </div>
  653. </td>
  654. </tr>
  655. </tbody>
  656. </table>
  657. </div>
  658. <div>
  659. <h4>Return Value</h4>
  660. <p>The header.</p>
  661. </div>
  662. </section>
  663. </div>
  664. </li>
  665. <li class="item">
  666. <div>
  667. <code>
  668. <a name="/s:9Alamofire10HTTPHeaderV14acceptEncodingyACSSFZ"></a>
  669. <a name="//apple_ref/swift/Method/acceptEncoding(_:)" class="dashAnchor"></a>
  670. <a class="token" href="#/s:9Alamofire10HTTPHeaderV14acceptEncodingyACSSFZ">acceptEncoding(_:)</a>
  671. </code>
  672. </div>
  673. <div class="height-container">
  674. <div class="pointer-container"></div>
  675. <section class="section">
  676. <div class="pointer"></div>
  677. <div class="abstract">
  678. <p>Returns an <code>Accept-Encoding</code> header.</p>
  679. <p>Alamofire offers a default accept encoding value that provides the most common values. Use
  680. <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ">HTTPHeader.defaultAcceptEncoding</a></code>.</p>
  681. </div>
  682. <div class="declaration">
  683. <h4>Declaration</h4>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <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>
  687. </div>
  688. </div>
  689. <div>
  690. <h4>Parameters</h4>
  691. <table class="graybox">
  692. <tbody>
  693. <tr>
  694. <td>
  695. <code>
  696. <em>value</em>
  697. </code>
  698. </td>
  699. <td>
  700. <div>
  701. <p>The <code>Accept-Encoding</code> value.</p>
  702. </div>
  703. </td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. </div>
  708. <div>
  709. <h4>Return Value</h4>
  710. <p>The header</p>
  711. </div>
  712. </section>
  713. </div>
  714. </li>
  715. <li class="item">
  716. <div>
  717. <code>
  718. <a name="/s:9Alamofire10HTTPHeaderV13authorization8username8passwordACSS_SStFZ"></a>
  719. <a name="//apple_ref/swift/Method/authorization(username:password:)" class="dashAnchor"></a>
  720. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorization8username8passwordACSS_SStFZ">authorization(username:password:)</a>
  721. </code>
  722. </div>
  723. <div class="height-container">
  724. <div class="pointer-container"></div>
  725. <section class="section">
  726. <div class="pointer"></div>
  727. <div class="abstract">
  728. <p>Returns a <code>Basic</code> <code>Authorization</code> header using the <code>username</code> and <code>password</code> provided.</p>
  729. </div>
  730. <div class="declaration">
  731. <h4>Declaration</h4>
  732. <div class="language">
  733. <p class="aside-title">Swift</p>
  734. <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>
  735. </div>
  736. </div>
  737. <div>
  738. <h4>Parameters</h4>
  739. <table class="graybox">
  740. <tbody>
  741. <tr>
  742. <td>
  743. <code>
  744. <em>username</em>
  745. </code>
  746. </td>
  747. <td>
  748. <div>
  749. <p>The username of the header.</p>
  750. </div>
  751. </td>
  752. </tr>
  753. <tr>
  754. <td>
  755. <code>
  756. <em>password</em>
  757. </code>
  758. </td>
  759. <td>
  760. <div>
  761. <p>The password of the header.</p>
  762. </div>
  763. </td>
  764. </tr>
  765. </tbody>
  766. </table>
  767. </div>
  768. <div>
  769. <h4>Return Value</h4>
  770. <p>The header.</p>
  771. </div>
  772. </section>
  773. </div>
  774. </li>
  775. <li class="item">
  776. <div>
  777. <code>
  778. <a name="/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ"></a>
  779. <a name="//apple_ref/swift/Method/authorization(bearerToken:)" class="dashAnchor"></a>
  780. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ">authorization(bearerToken:)</a>
  781. </code>
  782. </div>
  783. <div class="height-container">
  784. <div class="pointer-container"></div>
  785. <section class="section">
  786. <div class="pointer"></div>
  787. <div class="abstract">
  788. <p>Returns a <code>Bearer</code> <code>Authorization</code> header using the <code>bearerToken</code> provided</p>
  789. </div>
  790. <div class="declaration">
  791. <h4>Declaration</h4>
  792. <div class="language">
  793. <p class="aside-title">Swift</p>
  794. <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>
  795. </div>
  796. </div>
  797. <div>
  798. <h4>Parameters</h4>
  799. <table class="graybox">
  800. <tbody>
  801. <tr>
  802. <td>
  803. <code>
  804. <em>bearerToken</em>
  805. </code>
  806. </td>
  807. <td>
  808. <div>
  809. <p>The bearer token.</p>
  810. </div>
  811. </td>
  812. </tr>
  813. </tbody>
  814. </table>
  815. </div>
  816. <div>
  817. <h4>Return Value</h4>
  818. <p>The header.</p>
  819. </div>
  820. </section>
  821. </div>
  822. </li>
  823. <li class="item">
  824. <div>
  825. <code>
  826. <a name="/s:9Alamofire10HTTPHeaderV13authorizationyACSSFZ"></a>
  827. <a name="//apple_ref/swift/Method/authorization(_:)" class="dashAnchor"></a>
  828. <a class="token" href="#/s:9Alamofire10HTTPHeaderV13authorizationyACSSFZ">authorization(_:)</a>
  829. </code>
  830. </div>
  831. <div class="height-container">
  832. <div class="pointer-container"></div>
  833. <section class="section">
  834. <div class="pointer"></div>
  835. <div class="abstract">
  836. <p>Returns an <code>Authorization</code> header.</p>
  837. <p>Alamofire provides built-in methods to produce <code>Authorization</code> headers. For a Basic <code>Authorization</code> header use
  838. <code>HTTPHeader.authorization(username: password:)</code>. For a Bearer <code>Authorization</code> header, use
  839. <code><a href="../Structs/HTTPHeader.html#/s:9Alamofire10HTTPHeaderV13authorization11bearerTokenACSS_tFZ">HTTPHeader.authorization(bearerToken:)</a></code>.</p>
  840. </div>
  841. <div class="declaration">
  842. <h4>Declaration</h4>
  843. <div class="language">
  844. <p class="aside-title">Swift</p>
  845. <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>
  846. </div>
  847. </div>
  848. <div>
  849. <h4>Parameters</h4>
  850. <table class="graybox">
  851. <tbody>
  852. <tr>
  853. <td>
  854. <code>
  855. <em>value</em>
  856. </code>
  857. </td>
  858. <td>
  859. <div>
  860. <p>The <code>Authorization</code> value.</p>
  861. </div>
  862. </td>
  863. </tr>
  864. </tbody>
  865. </table>
  866. </div>
  867. <div>
  868. <h4>Return Value</h4>
  869. <p>The header.</p>
  870. </div>
  871. </section>
  872. </div>
  873. </li>
  874. <li class="item">
  875. <div>
  876. <code>
  877. <a name="/s:9Alamofire10HTTPHeaderV18contentDispositionyACSSFZ"></a>
  878. <a name="//apple_ref/swift/Method/contentDisposition(_:)" class="dashAnchor"></a>
  879. <a class="token" href="#/s:9Alamofire10HTTPHeaderV18contentDispositionyACSSFZ">contentDisposition(_:)</a>
  880. </code>
  881. </div>
  882. <div class="height-container">
  883. <div class="pointer-container"></div>
  884. <section class="section">
  885. <div class="pointer"></div>
  886. <div class="abstract">
  887. <p>Returns a <code>Content-Disposition</code> header.</p>
  888. </div>
  889. <div class="declaration">
  890. <h4>Declaration</h4>
  891. <div class="language">
  892. <p class="aside-title">Swift</p>
  893. <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>
  894. </div>
  895. </div>
  896. <div>
  897. <h4>Parameters</h4>
  898. <table class="graybox">
  899. <tbody>
  900. <tr>
  901. <td>
  902. <code>
  903. <em>value</em>
  904. </code>
  905. </td>
  906. <td>
  907. <div>
  908. <p>The <code>Content-Disposition</code> value.</p>
  909. </div>
  910. </td>
  911. </tr>
  912. </tbody>
  913. </table>
  914. </div>
  915. <div>
  916. <h4>Return Value</h4>
  917. <p>The header.</p>
  918. </div>
  919. </section>
  920. </div>
  921. </li>
  922. <li class="item">
  923. <div>
  924. <code>
  925. <a name="/s:9Alamofire10HTTPHeaderV11contentTypeyACSSFZ"></a>
  926. <a name="//apple_ref/swift/Method/contentType(_:)" class="dashAnchor"></a>
  927. <a class="token" href="#/s:9Alamofire10HTTPHeaderV11contentTypeyACSSFZ">contentType(_:)</a>
  928. </code>
  929. </div>
  930. <div class="height-container">
  931. <div class="pointer-container"></div>
  932. <section class="section">
  933. <div class="pointer"></div>
  934. <div class="abstract">
  935. <p>Returns a <code>Content-Type</code> header.</p>
  936. <p>All Alamofire <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>s set the <code>Content-Type</code> of the request, so it may not be necessary to manually
  937. set this value.</p>
  938. </div>
  939. <div class="declaration">
  940. <h4>Declaration</h4>
  941. <div class="language">
  942. <p class="aside-title">Swift</p>
  943. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">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>
  944. </div>
  945. </div>
  946. <div>
  947. <h4>Parameters</h4>
  948. <table class="graybox">
  949. <tbody>
  950. <tr>
  951. <td>
  952. <code>
  953. <em>value</em>
  954. </code>
  955. </td>
  956. <td>
  957. <div>
  958. <p>The <code>Content-Type</code> value.</p>
  959. </div>
  960. </td>
  961. </tr>
  962. </tbody>
  963. </table>
  964. </div>
  965. <div>
  966. <h4>Return Value</h4>
  967. <p>The header.</p>
  968. </div>
  969. </section>
  970. </div>
  971. </li>
  972. <li class="item">
  973. <div>
  974. <code>
  975. <a name="/s:9Alamofire10HTTPHeaderV9userAgentyACSSFZ"></a>
  976. <a name="//apple_ref/swift/Method/userAgent(_:)" class="dashAnchor"></a>
  977. <a class="token" href="#/s:9Alamofire10HTTPHeaderV9userAgentyACSSFZ">userAgent(_:)</a>
  978. </code>
  979. </div>
  980. <div class="height-container">
  981. <div class="pointer-container"></div>
  982. <section class="section">
  983. <div class="pointer"></div>
  984. <div class="abstract">
  985. <p>Returns a <code>User-Agent</code> header.</p>
  986. </div>
  987. <div class="declaration">
  988. <h4>Declaration</h4>
  989. <div class="language">
  990. <p class="aside-title">Swift</p>
  991. <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>
  992. </div>
  993. </div>
  994. <div>
  995. <h4>Parameters</h4>
  996. <table class="graybox">
  997. <tbody>
  998. <tr>
  999. <td>
  1000. <code>
  1001. <em>value</em>
  1002. </code>
  1003. </td>
  1004. <td>
  1005. <div>
  1006. <p>The <code>User-Agent</code> value.</p>
  1007. </div>
  1008. </td>
  1009. </tr>
  1010. </tbody>
  1011. </table>
  1012. </div>
  1013. <div>
  1014. <h4>Return Value</h4>
  1015. <p>The header.</p>
  1016. </div>
  1017. </section>
  1018. </div>
  1019. </li>
  1020. </ul>
  1021. </div>
  1022. <div class="task-group">
  1023. <div class="task-name-container">
  1024. <a name="/Defaults"></a>
  1025. <a name="//apple_ref/swift/Section/Defaults" class="dashAnchor"></a>
  1026. <a href="#/Defaults">
  1027. <h3 class="section-name">Defaults</h3>
  1028. </a>
  1029. </div>
  1030. <ul class="item-container">
  1031. <li class="item">
  1032. <div>
  1033. <code>
  1034. <a name="/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ"></a>
  1035. <a name="//apple_ref/swift/Variable/defaultAcceptEncoding" class="dashAnchor"></a>
  1036. <a class="token" href="#/s:9Alamofire10HTTPHeaderV21defaultAcceptEncodingACvpZ">defaultAcceptEncoding</a>
  1037. </code>
  1038. </div>
  1039. <div class="height-container">
  1040. <div class="pointer-container"></div>
  1041. <section class="section">
  1042. <div class="pointer"></div>
  1043. <div class="abstract">
  1044. <p>Returns Alamofire&rsquo;s default <code>Accept-Encoding</code> header, appropriate for the encodings supporte by particular OS
  1045. versions.</p>
  1046. <p>See the <a href="https://tools.ietf.org/html/rfc7230#section-4.2.3">Accept-Encoding HTTP header documentation</a> .</p>
  1047. </div>
  1048. <div class="declaration">
  1049. <h4>Declaration</h4>
  1050. <div class="language">
  1051. <p class="aside-title">Swift</p>
  1052. <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>
  1053. </div>
  1054. </div>
  1055. </section>
  1056. </div>
  1057. </li>
  1058. <li class="item">
  1059. <div>
  1060. <code>
  1061. <a name="/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ"></a>
  1062. <a name="//apple_ref/swift/Variable/defaultAcceptLanguage" class="dashAnchor"></a>
  1063. <a class="token" href="#/s:9Alamofire10HTTPHeaderV21defaultAcceptLanguageACvpZ">defaultAcceptLanguage</a>
  1064. </code>
  1065. </div>
  1066. <div class="height-container">
  1067. <div class="pointer-container"></div>
  1068. <section class="section">
  1069. <div class="pointer"></div>
  1070. <div class="abstract">
  1071. <p>Returns Alamofire&rsquo;s default <code>Accept-Language</code> header, generated by querying <code>Locale</code> for the user&rsquo;s
  1072. <code>preferredLanguages</code>.</p>
  1073. <p>See the <a href="https://tools.ietf.org/html/rfc7231#section-5.3.5">Accept-Language HTTP header documentation</a>.</p>
  1074. </div>
  1075. <div class="declaration">
  1076. <h4>Declaration</h4>
  1077. <div class="language">
  1078. <p class="aside-title">Swift</p>
  1079. <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>
  1080. </div>
  1081. </div>
  1082. </section>
  1083. </div>
  1084. </li>
  1085. <li class="item">
  1086. <div>
  1087. <code>
  1088. <a name="/s:9Alamofire10HTTPHeaderV16defaultUserAgentACvpZ"></a>
  1089. <a name="//apple_ref/swift/Variable/defaultUserAgent" class="dashAnchor"></a>
  1090. <a class="token" href="#/s:9Alamofire10HTTPHeaderV16defaultUserAgentACvpZ">defaultUserAgent</a>
  1091. </code>
  1092. </div>
  1093. <div class="height-container">
  1094. <div class="pointer-container"></div>
  1095. <section class="section">
  1096. <div class="pointer"></div>
  1097. <div class="abstract">
  1098. <p>Returns Alamofire&rsquo;s default <code>User-Agent</code> header.</p>
  1099. <p>See the <a href="https://tools.ietf.org/html/rfc7231#section-5.5.3">User-Agent header documentation</a>.</p>
  1100. <p>Example: <code>iOS Example/1.0 (org.alamofire.iOS-Example; build:1; iOS 12.0.0) Alamofire/5.0.0</code></p>
  1101. </div>
  1102. <div class="declaration">
  1103. <h4>Declaration</h4>
  1104. <div class="language">
  1105. <p class="aside-title">Swift</p>
  1106. <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>
  1107. </div>
  1108. </div>
  1109. </section>
  1110. </div>
  1111. </li>
  1112. </ul>
  1113. </div>
  1114. </div>
  1115. </section>
  1116. </article>
  1117. </div>
  1118. <section class="footer">
  1119. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-03-29)</p>
  1120. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1121. </section>
  1122. </body>
  1123. </div>
  1124. </html>