HTTPHeader.html 72 KB

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