HTTPHeader.html 72 KB

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