HTTPHeader.html 62 KB

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