HTTPHeader.html 56 KB

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