HTTPHeader.html 58 KB

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