Classes.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Classes 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 title="Classes Reference"></a>
  16. <header class="header">
  17. <p class="header-col header-col--primary">
  18. <a class="header-link" href="index.html">
  19. Alamofire Docs
  20. </a>
  21. (87% documented)
  22. </p>
  23. <p class="header-col--secondary">
  24. <form role="search" action="search.json">
  25. <input type="text" placeholder="Search documentation" data-typeahead>
  26. </form>
  27. </p>
  28. <p class="header-col header-col--secondary">
  29. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  30. <img class="header-icon" src="img/gh.png"/>
  31. View on GitHub
  32. </a>
  33. </p>
  34. <p class="header-col header-col--secondary">
  35. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  36. <img class="header-icon" src="img/dash.png"/>
  37. Install in Dash
  38. </a>
  39. </p>
  40. </header>
  41. <p class="breadcrumbs">
  42. <a class="breadcrumb" href="index.html">Alamofire Reference</a>
  43. <img class="carat" src="img/carat.png" />
  44. Classes Reference
  45. </p>
  46. <div class="content-wrapper">
  47. <nav class="navigation">
  48. <ul class="nav-groups">
  49. <li class="nav-group-name">
  50. <a class="nav-group-name-link" href="Classes.html">Classes</a>
  51. <ul class="nav-group-tasks">
  52. <li class="nav-group-task">
  53. <a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
  54. </li>
  55. <li class="nav-group-task">
  56. <a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
  57. </li>
  58. <li class="nav-group-task">
  59. <a class="nav-group-task-link" href="Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  60. </li>
  61. <li class="nav-group-task">
  62. <a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  66. </li>
  67. <li class="nav-group-task">
  68. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  69. </li>
  70. <li class="nav-group-task">
  71. <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  72. </li>
  73. <li class="nav-group-task">
  74. <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
  75. </li>
  76. <li class="nav-group-task">
  77. <a class="nav-group-task-link" href="Classes/Request/ValidationResult.html">– ValidationResult</a>
  78. </li>
  79. <li class="nav-group-task">
  80. <a class="nav-group-task-link" href="Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  81. </li>
  82. <li class="nav-group-task">
  83. <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
  84. </li>
  85. <li class="nav-group-task">
  86. <a class="nav-group-task-link" href="Classes/SessionManager.html">SessionManager</a>
  87. </li>
  88. <li class="nav-group-task">
  89. <a class="nav-group-task-link" href="Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  90. </li>
  91. <li class="nav-group-task">
  92. <a class="nav-group-task-link" href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  93. </li>
  94. <li class="nav-group-task">
  95. <a class="nav-group-task-link" href="Classes/TaskDelegate.html">TaskDelegate</a>
  96. </li>
  97. <li class="nav-group-task">
  98. <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
  99. </li>
  100. </ul>
  101. </li>
  102. <li class="nav-group-name">
  103. <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
  104. <ul class="nav-group-tasks">
  105. <li class="nav-group-task">
  106. <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
  107. </li>
  108. <li class="nav-group-task">
  109. <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  110. </li>
  111. <li class="nav-group-task">
  112. <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  113. </li>
  114. <li class="nav-group-task">
  115. <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  116. </li>
  117. <li class="nav-group-task">
  118. <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  119. </li>
  120. <li class="nav-group-task">
  121. <a class="nav-group-task-link" href="Enums/HTTPMethod.html">HTTPMethod</a>
  122. </li>
  123. <li class="nav-group-task">
  124. <a class="nav-group-task-link" href="Enums/Result.html">Result</a>
  125. </li>
  126. <li class="nav-group-task">
  127. <a class="nav-group-task-link" href="Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="nav-group-name">
  132. <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
  133. <ul class="nav-group-tasks">
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="Extensions/Notification/Name.html">– Name</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="Extensions/Notification/Key.html">– Key</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="Extensions/String.html">String</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
  154. </li>
  155. </ul>
  156. </li>
  157. <li class="nav-group-name">
  158. <a class="nav-group-name-link" href="Functions.html">Functions</a>
  159. <ul class="nav-group-tasks">
  160. <li class="nav-group-task">
  161. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  162. </li>
  163. <li class="nav-group-task">
  164. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  165. </li>
  166. <li class="nav-group-task">
  167. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  168. </li>
  169. <li class="nav-group-task">
  170. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  171. </li>
  172. <li class="nav-group-task">
  173. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  174. </li>
  175. <li class="nav-group-task">
  176. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  177. </li>
  178. <li class="nav-group-task">
  179. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  180. </li>
  181. <li class="nav-group-task">
  182. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  183. </li>
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  207. </li>
  208. </ul>
  209. </li>
  210. <li class="nav-group-name">
  211. <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
  212. <ul class="nav-group-tasks">
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  233. </li>
  234. </ul>
  235. </li>
  236. <li class="nav-group-name">
  237. <a class="nav-group-name-link" href="Structs.html">Structures</a>
  238. <ul class="nav-group-tasks">
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="Structs/Timeline.html">Timeline</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
  271. </li>
  272. </ul>
  273. </li>
  274. <li class="nav-group-name">
  275. <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
  276. <ul class="nav-group-tasks">
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  285. </li>
  286. </ul>
  287. </li>
  288. </ul>
  289. </nav>
  290. <article class="main-content">
  291. <section class="section">
  292. <div class="section-content">
  293. <h1>Classes</h1>
  294. <p>The following classes are available globally.</p>
  295. </div>
  296. </section>
  297. <section class="section">
  298. <div class="section-content">
  299. <div class="task-group">
  300. <ul class="item-container">
  301. <li class="item">
  302. <div>
  303. <code>
  304. <a name="/c:@M@Alamofire@objc(cs)SessionDelegate"></a>
  305. <a name="//apple_ref/swift/Class/SessionDelegate" class="dashAnchor"></a>
  306. <a class="token" href="#/c:@M@Alamofire@objc(cs)SessionDelegate">SessionDelegate</a>
  307. </code>
  308. </div>
  309. <div class="height-container">
  310. <div class="pointer-container"></div>
  311. <section class="section">
  312. <div class="pointer"></div>
  313. <div class="abstract">
  314. <p>Responsible for handling all delegate callbacks for the underlying session.</p>
  315. <a href="Classes/SessionDelegate.html" class="slightly-smaller">See more</a>
  316. </div>
  317. <div class="declaration">
  318. <h4>Declaration</h4>
  319. <div class="language">
  320. <p class="aside-title">Swift</p>
  321. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SessionDelegate</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
  322. </div>
  323. </div>
  324. </section>
  325. </div>
  326. </li>
  327. </ul>
  328. </div>
  329. <div class="task-group">
  330. <ul class="item-container">
  331. <li class="item">
  332. <div>
  333. <code>
  334. <a name="/s:9Alamofire7RequestC"></a>
  335. <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
  336. <a class="token" href="#/s:9Alamofire7RequestC">Request</a>
  337. </code>
  338. </div>
  339. <div class="height-container">
  340. <div class="pointer-container"></div>
  341. <section class="section">
  342. <div class="pointer"></div>
  343. <div class="abstract">
  344. <p>Responsible for sending a request and receiving the response and associated data from the server, as well as
  345. managing its underlying <code>URLSessionTask</code>.</p>
  346. <a href="Classes/Request.html" class="slightly-smaller">See more</a>
  347. </div>
  348. <div class="declaration">
  349. <h4>Declaration</h4>
  350. <div class="language">
  351. <p class="aside-title">Swift</p>
  352. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  353. </div>
  354. </div>
  355. </section>
  356. </div>
  357. </li>
  358. </ul>
  359. </div>
  360. <div class="task-group">
  361. <ul class="item-container">
  362. <li class="item">
  363. <div>
  364. <code>
  365. <a name="/s:9Alamofire11DataRequestC"></a>
  366. <a name="//apple_ref/swift/Class/DataRequest" class="dashAnchor"></a>
  367. <a class="token" href="#/s:9Alamofire11DataRequestC">DataRequest</a>
  368. </code>
  369. </div>
  370. <div class="height-container">
  371. <div class="pointer-container"></div>
  372. <section class="section">
  373. <div class="pointer"></div>
  374. <div class="abstract">
  375. <p>Specific type of <code><a href="Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDataTask</code>.</p>
  376. <a href="Classes/DataRequest.html" class="slightly-smaller">See more</a>
  377. </div>
  378. <div class="declaration">
  379. <h4>Declaration</h4>
  380. <div class="language">
  381. <p class="aside-title">Swift</p>
  382. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">DataRequest</span><span class="p">:</span> <span class="kt"><a href="Classes/Request.html">Request</a></span></code></pre>
  383. </div>
  384. </div>
  385. </section>
  386. </div>
  387. </li>
  388. </ul>
  389. </div>
  390. <div class="task-group">
  391. <ul class="item-container">
  392. <li class="item">
  393. <div>
  394. <code>
  395. <a name="/s:9Alamofire15DownloadRequestC"></a>
  396. <a name="//apple_ref/swift/Class/DownloadRequest" class="dashAnchor"></a>
  397. <a class="token" href="#/s:9Alamofire15DownloadRequestC">DownloadRequest</a>
  398. </code>
  399. </div>
  400. <div class="height-container">
  401. <div class="pointer-container"></div>
  402. <section class="section">
  403. <div class="pointer"></div>
  404. <div class="abstract">
  405. <p>Specific type of <code><a href="Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDownloadTask</code>.</p>
  406. <a href="Classes/DownloadRequest.html" class="slightly-smaller">See more</a>
  407. </div>
  408. <div class="declaration">
  409. <h4>Declaration</h4>
  410. <div class="language">
  411. <p class="aside-title">Swift</p>
  412. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span><span class="p">:</span> <span class="kt"><a href="Classes/Request.html">Request</a></span></code></pre>
  413. </div>
  414. </div>
  415. </section>
  416. </div>
  417. </li>
  418. </ul>
  419. </div>
  420. <div class="task-group">
  421. <ul class="item-container">
  422. <li class="item">
  423. <div>
  424. <code>
  425. <a name="/s:9Alamofire13UploadRequestC"></a>
  426. <a name="//apple_ref/swift/Class/UploadRequest" class="dashAnchor"></a>
  427. <a class="token" href="#/s:9Alamofire13UploadRequestC">UploadRequest</a>
  428. </code>
  429. </div>
  430. <div class="height-container">
  431. <div class="pointer-container"></div>
  432. <section class="section">
  433. <div class="pointer"></div>
  434. <div class="abstract">
  435. <p>Specific type of <code><a href="Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionUploadTask</code>.</p>
  436. <a href="Classes/UploadRequest.html" class="slightly-smaller">See more</a>
  437. </div>
  438. <div class="declaration">
  439. <h4>Declaration</h4>
  440. <div class="language">
  441. <p class="aside-title">Swift</p>
  442. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">UploadRequest</span><span class="p">:</span> <span class="kt"><a href="Classes/DataRequest.html">DataRequest</a></span></code></pre>
  443. </div>
  444. </div>
  445. </section>
  446. </div>
  447. </li>
  448. </ul>
  449. </div>
  450. <div class="task-group">
  451. <ul class="item-container">
  452. <li class="item">
  453. <div>
  454. <code>
  455. <a name="/s:9Alamofire13StreamRequestC"></a>
  456. <a name="//apple_ref/swift/Class/StreamRequest" class="dashAnchor"></a>
  457. <a class="token" href="#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  458. </code>
  459. </div>
  460. <div class="height-container">
  461. <div class="pointer-container"></div>
  462. <section class="section">
  463. <div class="pointer"></div>
  464. <div class="abstract">
  465. <p>Specific type of <code><a href="Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionStreamTask</code>.</p>
  466. </div>
  467. <div class="declaration">
  468. <h4>Declaration</h4>
  469. <div class="language">
  470. <p class="aside-title">Swift</p>
  471. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">StreamRequest</span><span class="p">:</span> <span class="kt"><a href="Classes/Request.html">Request</a></span></code></pre>
  472. </div>
  473. </div>
  474. </section>
  475. </div>
  476. </li>
  477. </ul>
  478. </div>
  479. <div class="task-group">
  480. <ul class="item-container">
  481. <li class="item">
  482. <div>
  483. <code>
  484. <a name="/s:9Alamofire14SessionManagerC"></a>
  485. <a name="//apple_ref/swift/Class/SessionManager" class="dashAnchor"></a>
  486. <a class="token" href="#/s:9Alamofire14SessionManagerC">SessionManager</a>
  487. </code>
  488. </div>
  489. <div class="height-container">
  490. <div class="pointer-container"></div>
  491. <section class="section">
  492. <div class="pointer"></div>
  493. <div class="abstract">
  494. <p>Responsible for creating and managing <code><a href="Classes/Request.html">Request</a></code> objects, as well as their underlying <code>NSURLSession</code>.</p>
  495. <a href="Classes/SessionManager.html" class="slightly-smaller">See more</a>
  496. </div>
  497. <div class="declaration">
  498. <h4>Declaration</h4>
  499. <div class="language">
  500. <p class="aside-title">Swift</p>
  501. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SessionManager</span></code></pre>
  502. </div>
  503. </div>
  504. </section>
  505. </div>
  506. </li>
  507. </ul>
  508. </div>
  509. <div class="task-group">
  510. <ul class="item-container">
  511. <li class="item">
  512. <div>
  513. <code>
  514. <a name="/s:9Alamofire17MultipartFormDataC"></a>
  515. <a name="//apple_ref/swift/Class/MultipartFormData" class="dashAnchor"></a>
  516. <a class="token" href="#/s:9Alamofire17MultipartFormDataC">MultipartFormData</a>
  517. </code>
  518. </div>
  519. <div class="height-container">
  520. <div class="pointer-container"></div>
  521. <section class="section">
  522. <div class="pointer"></div>
  523. <div class="abstract">
  524. <p>Constructs <code>multipart/form-data</code> for uploads within an HTTP or HTTPS body. There are currently two ways to encode
  525. multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead
  526. to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the
  527. data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for
  528. larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.</p>
  529. <p>For more information on <code>multipart/form-data</code> in general, please refer to the RFC-2388 and RFC-2045 specs as well
  530. and the w3 form documentation.</p>
  531. <ul>
  532. <li><a href="https://www.ietf.org/rfc/rfc2388.txt">https://www.ietf.org/rfc/rfc2388.txt</a></li>
  533. <li><a href="https://www.ietf.org/rfc/rfc2045.txt">https://www.ietf.org/rfc/rfc2045.txt</a></li>
  534. <li><a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13">https://www.w3.org/TR/html401/interact/forms.html#h-17.13</a></li>
  535. </ul>
  536. <a href="Classes/MultipartFormData.html" class="slightly-smaller">See more</a>
  537. </div>
  538. <div class="declaration">
  539. <h4>Declaration</h4>
  540. <div class="language">
  541. <p class="aside-title">Swift</p>
  542. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">MultipartFormData</span></code></pre>
  543. </div>
  544. </div>
  545. </section>
  546. </div>
  547. </li>
  548. </ul>
  549. </div>
  550. <div class="task-group">
  551. <ul class="item-container">
  552. <li class="item">
  553. <div>
  554. <code>
  555. <a name="/s:9Alamofire24ServerTrustPolicyManagerC"></a>
  556. <a name="//apple_ref/swift/Class/ServerTrustPolicyManager" class="dashAnchor"></a>
  557. <a class="token" href="#/s:9Alamofire24ServerTrustPolicyManagerC">ServerTrustPolicyManager</a>
  558. </code>
  559. </div>
  560. <div class="height-container">
  561. <div class="pointer-container"></div>
  562. <section class="section">
  563. <div class="pointer"></div>
  564. <div class="abstract">
  565. <p>Responsible for managing the mapping of <code><a href="Enums/ServerTrustPolicy.html">ServerTrustPolicy</a></code> objects to a given host.</p>
  566. <a href="Classes/ServerTrustPolicyManager.html" class="slightly-smaller">See more</a>
  567. </div>
  568. <div class="declaration">
  569. <h4>Declaration</h4>
  570. <div class="language">
  571. <p class="aside-title">Swift</p>
  572. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">ServerTrustPolicyManager</span></code></pre>
  573. </div>
  574. </div>
  575. </section>
  576. </div>
  577. </li>
  578. </ul>
  579. </div>
  580. <div class="task-group">
  581. <ul class="item-container">
  582. <li class="item">
  583. <div>
  584. <code>
  585. <a name="/s:9Alamofire26NetworkReachabilityManagerC"></a>
  586. <a name="//apple_ref/swift/Class/NetworkReachabilityManager" class="dashAnchor"></a>
  587. <a class="token" href="#/s:9Alamofire26NetworkReachabilityManagerC">NetworkReachabilityManager</a>
  588. </code>
  589. </div>
  590. <div class="height-container">
  591. <div class="pointer-container"></div>
  592. <section class="section">
  593. <div class="pointer"></div>
  594. <div class="abstract">
  595. <p>The <code>NetworkReachabilityManager</code> class listens for reachability changes of hosts and addresses for both WWAN and
  596. WiFi network interfaces.</p>
  597. <p>Reachability can be used to determine background information about why a network operation failed, or to retry
  598. network requests when a connection is established. It should not be used to prevent a user from initiating a network
  599. request, as it&rsquo;s possible that an initial request may be required to establish reachability.</p>
  600. <a href="Classes/NetworkReachabilityManager.html" class="slightly-smaller">See more</a>
  601. </div>
  602. <div class="declaration">
  603. <h4>Declaration</h4>
  604. <div class="language">
  605. <p class="aside-title">Swift</p>
  606. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">NetworkReachabilityManager</span></code></pre>
  607. </div>
  608. </div>
  609. </section>
  610. </div>
  611. </li>
  612. </ul>
  613. </div>
  614. <div class="task-group">
  615. <ul class="item-container">
  616. <li class="item">
  617. <div>
  618. <code>
  619. <a name="/c:@M@Alamofire@objc(cs)TaskDelegate"></a>
  620. <a name="//apple_ref/swift/Class/TaskDelegate" class="dashAnchor"></a>
  621. <a class="token" href="#/c:@M@Alamofire@objc(cs)TaskDelegate">TaskDelegate</a>
  622. </code>
  623. </div>
  624. <div class="height-container">
  625. <div class="pointer-container"></div>
  626. <section class="section">
  627. <div class="pointer"></div>
  628. <div class="abstract">
  629. <p>The task delegate is responsible for handling all delegate callbacks for the underlying task as well as
  630. executing all operations attached to the serial operation queue upon task completion.</p>
  631. <a href="Classes/TaskDelegate.html" class="slightly-smaller">See more</a>
  632. </div>
  633. <div class="declaration">
  634. <h4>Declaration</h4>
  635. <div class="language">
  636. <p class="aside-title">Swift</p>
  637. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">TaskDelegate</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
  638. </div>
  639. </div>
  640. </section>
  641. </div>
  642. </li>
  643. </ul>
  644. </div>
  645. </div>
  646. </section>
  647. </article>
  648. </div>
  649. <section class="footer">
  650. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-12-03)</p>
  651. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  652. </section>
  653. </body>
  654. </div>
  655. </html>