Extensions.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Extensions 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="Extensions 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%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. Extensions 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">Enums</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">Structs</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">Typealiases</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>Extensions</h1>
  294. <p>The following extensions 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="/s:SS"></a>
  305. <a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
  306. <a class="token" href="#/s:SS">String</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. <a href="Extensions/String.html" class="slightly-smaller">See more</a>
  315. </div>
  316. <div class="declaration">
  317. <h4>Declaration</h4>
  318. <div class="language">
  319. <p class="aside-title">Swift</p>
  320. <pre class="highlight"><code><span class="kd">struct</span> <span class="kt">String</span></code></pre>
  321. </div>
  322. </div>
  323. </section>
  324. </div>
  325. </li>
  326. <li class="item">
  327. <div>
  328. <code>
  329. <a name="/s:10Foundation3URLV"></a>
  330. <a name="//apple_ref/swift/Extension/URL" class="dashAnchor"></a>
  331. <a class="token" href="#/s:10Foundation3URLV">URL</a>
  332. </code>
  333. </div>
  334. <div class="height-container">
  335. <div class="pointer-container"></div>
  336. <section class="section">
  337. <div class="pointer"></div>
  338. <div class="abstract">
  339. <a href="Extensions/URL.html" class="slightly-smaller">See more</a>
  340. </div>
  341. <div class="declaration">
  342. <h4>Declaration</h4>
  343. <div class="language">
  344. <p class="aside-title">Swift</p>
  345. <pre class="highlight"><code><span class="kd">struct</span> <span class="kt">URL</span> <span class="p">:</span> <span class="kt">ReferenceConvertible</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
  346. </div>
  347. </div>
  348. </section>
  349. </div>
  350. </li>
  351. <li class="item">
  352. <div>
  353. <code>
  354. <a name="/s:10Foundation13URLComponentsV"></a>
  355. <a name="//apple_ref/swift/Extension/URLComponents" class="dashAnchor"></a>
  356. <a class="token" href="#/s:10Foundation13URLComponentsV">URLComponents</a>
  357. </code>
  358. </div>
  359. <div class="height-container">
  360. <div class="pointer-container"></div>
  361. <section class="section">
  362. <div class="pointer"></div>
  363. <div class="abstract">
  364. <a href="Extensions/URLComponents.html" class="slightly-smaller">See more</a>
  365. </div>
  366. <div class="declaration">
  367. <h4>Declaration</h4>
  368. <div class="language">
  369. <p class="aside-title">Swift</p>
  370. <pre class="highlight"><code><span class="kd">struct</span> <span class="kt">URLComponents</span> <span class="p">:</span> <span class="kt">ReferenceConvertible</span><span class="p">,</span> <span class="kt">Hashable</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
  371. </div>
  372. </div>
  373. </section>
  374. </div>
  375. </li>
  376. </ul>
  377. </div>
  378. <div class="task-group">
  379. <ul class="item-container">
  380. <li class="item">
  381. <div>
  382. <code>
  383. <a name="/s:10Foundation10URLRequestV"></a>
  384. <a name="//apple_ref/swift/Extension/URLRequest" class="dashAnchor"></a>
  385. <a class="token" href="#/s:10Foundation10URLRequestV">URLRequest</a>
  386. </code>
  387. </div>
  388. <div class="height-container">
  389. <div class="pointer-container"></div>
  390. <section class="section">
  391. <div class="pointer"></div>
  392. <div class="abstract">
  393. <a href="Extensions/URLRequest.html" class="slightly-smaller">See more</a>
  394. </div>
  395. </section>
  396. </div>
  397. </li>
  398. </ul>
  399. </div>
  400. <div class="task-group">
  401. <ul class="item-container">
  402. <li class="item">
  403. <div>
  404. <code>
  405. <a name="/s:10Foundation12NotificationV"></a>
  406. <a name="//apple_ref/swift/Extension/Notification" class="dashAnchor"></a>
  407. <a class="token" href="#/s:10Foundation12NotificationV">Notification</a>
  408. </code>
  409. </div>
  410. <div class="height-container">
  411. <div class="pointer-container"></div>
  412. <section class="section">
  413. <div class="pointer"></div>
  414. <div class="abstract">
  415. <a href="Extensions/Notification.html" class="slightly-smaller">See more</a>
  416. </div>
  417. </section>
  418. </div>
  419. </li>
  420. </ul>
  421. </div>
  422. </div>
  423. </section>
  424. </article>
  425. </div>
  426. <section class="footer">
  427. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-08-25)</p>
  428. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  429. </section>
  430. </body>
  431. </div>
  432. </html>