HTTPHeader.html 63 KB

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