HTTPHeader.html 58 KB

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