AFError.html 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>AFError Enumeration 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/Enum/AFError" class="dashAnchor"></a>
  16. <a title="AFError Enumeration Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (86% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. AFError Enumeration 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/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>AFError</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AFError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
  304. </div>
  305. </div>
  306. <p><code>AFError</code> is the error type returned by Alamofire. It encompasses a few different types of errors, each with
  307. their own associated reasons.</p>
  308. <ul>
  309. <li>invalidURL: Returned when a <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> type fails to create a valid <code>URL</code>.</li>
  310. <li>parameterEncodingFailed: Returned when a parameter encoding object throws an error during the encoding process.</li>
  311. <li>multipartEncodingFailed: Returned when some step in the multipart encoding process fails.</li>
  312. <li>responseValidationFailed: Returned when a <code>validate()</code> call fails.</li>
  313. <li>responseSerializationFailed: Returned when a response serializer encounters an error in the serialization process.</li>
  314. </ul>
  315. </div>
  316. </section>
  317. <section class="section">
  318. <div class="section-content">
  319. <div class="task-group">
  320. <ul class="item-container">
  321. <li class="item">
  322. <div>
  323. <code>
  324. <a name="/s:9Alamofire7AFErrorO30ParameterEncodingFailureReasonO"></a>
  325. <a name="//apple_ref/swift/Enum/ParameterEncodingFailureReason" class="dashAnchor"></a>
  326. <a class="token" href="#/s:9Alamofire7AFErrorO30ParameterEncodingFailureReasonO">ParameterEncodingFailureReason</a>
  327. </code>
  328. </div>
  329. <div class="height-container">
  330. <div class="pointer-container"></div>
  331. <section class="section">
  332. <div class="pointer"></div>
  333. <div class="abstract">
  334. <p>The underlying reason the parameter encoding error occurred.</p>
  335. <ul>
  336. <li>missingURL: The URL request did not have a URL to encode.</li>
  337. <li>jsonEncodingFailed: JSON serialization failed with an underlying system error during the
  338. encoding process.</li>
  339. <li>propertyListEncodingFailed: Property list serialization failed with an underlying system error during
  340. encoding process.</li>
  341. </ul>
  342. <a href="../Enums/AFError/ParameterEncodingFailureReason.html" class="slightly-smaller">See more</a>
  343. </div>
  344. <div class="declaration">
  345. <h4>Declaration</h4>
  346. <div class="language">
  347. <p class="aside-title">Swift</p>
  348. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ParameterEncodingFailureReason</span></code></pre>
  349. </div>
  350. </div>
  351. </section>
  352. </div>
  353. </li>
  354. <li class="item">
  355. <div>
  356. <code>
  357. <a name="/s:9Alamofire7AFErrorO30MultipartEncodingFailureReasonO"></a>
  358. <a name="//apple_ref/swift/Enum/MultipartEncodingFailureReason" class="dashAnchor"></a>
  359. <a class="token" href="#/s:9Alamofire7AFErrorO30MultipartEncodingFailureReasonO">MultipartEncodingFailureReason</a>
  360. </code>
  361. </div>
  362. <div class="height-container">
  363. <div class="pointer-container"></div>
  364. <section class="section">
  365. <div class="pointer"></div>
  366. <div class="abstract">
  367. <p>The underlying reason the multipart encoding error occurred.</p>
  368. <ul>
  369. <li>bodyPartURLInvalid: The <code>fileURL</code> provided for reading an encodable body part isn&rsquo;t a
  370. file URL.</li>
  371. <li>bodyPartFilenameInvalid: The filename of the <code>fileURL</code> provided has either an empty
  372. <code>lastPathComponent</code> or `pathExtension.</li>
  373. <li>bodyPartFileNotReachable: The file at the <code>fileURL</code> provided was not reachable.</li>
  374. <li>bodyPartFileNotReachableWithError: Attempting to check the reachability of the <code>fileURL</code> provided threw
  375. an error.</li>
  376. <li>bodyPartFileIsDirectory: The file at the <code>fileURL</code> provided is actually a directory.</li>
  377. <li>bodyPartFileSizeNotAvailable: The size of the file at the <code>fileURL</code> provided was not returned by
  378. the system.</li>
  379. <li>bodyPartFileSizeQueryFailedWithError: The attempt to find the size of the file at the <code>fileURL</code> provided
  380. threw an error.</li>
  381. <li>bodyPartInputStreamCreationFailed: An <code>InputStream</code> could not be created for the provided <code>fileURL</code>.</li>
  382. <li>outputStreamCreationFailed: An <code>OutputStream</code> could not be created when attempting to write the
  383. encoded data to disk.</li>
  384. <li>outputStreamFileAlreadyExists: The encoded body data could not be writtent disk because a file
  385. already exists at the provided <code>fileURL</code>.</li>
  386. <li>outputStreamURLInvalid: The <code>fileURL</code> provided for writing the encoded body data to disk is
  387. not a file URL.</li>
  388. <li>outputStreamWriteFailed: The attempt to write the encoded body data to disk failed with an
  389. underlying error.</li>
  390. <li>inputStreamReadFailed: The attempt to read an encoded body part <code>InputStream</code> failed with
  391. underlying system error.</li>
  392. </ul>
  393. <a href="../Enums/AFError/MultipartEncodingFailureReason.html" class="slightly-smaller">See more</a>
  394. </div>
  395. <div class="declaration">
  396. <h4>Declaration</h4>
  397. <div class="language">
  398. <p class="aside-title">Swift</p>
  399. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MultipartEncodingFailureReason</span></code></pre>
  400. </div>
  401. </div>
  402. </section>
  403. </div>
  404. </li>
  405. <li class="item">
  406. <div>
  407. <code>
  408. <a name="/s:9Alamofire7AFErrorO31ResponseValidationFailureReasonO"></a>
  409. <a name="//apple_ref/swift/Enum/ResponseValidationFailureReason" class="dashAnchor"></a>
  410. <a class="token" href="#/s:9Alamofire7AFErrorO31ResponseValidationFailureReasonO">ResponseValidationFailureReason</a>
  411. </code>
  412. </div>
  413. <div class="height-container">
  414. <div class="pointer-container"></div>
  415. <section class="section">
  416. <div class="pointer"></div>
  417. <div class="abstract">
  418. <p>The underlying reason the response validation error occurred.</p>
  419. <ul>
  420. <li>dataFileNil: The data file containing the server response did not exist.</li>
  421. <li>dataFileReadFailed: The data file containing the server response could not be read.</li>
  422. <li>missingContentType: The response did not contain a <code>Content-Type</code> and the <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO22acceptableContentTypesSaySSGSgvp">acceptableContentTypes</a></code>
  423. provided did not contain wildcard type.</li>
  424. <li>unacceptableContentType: The response <code>Content-Type</code> did not match any type in the provided
  425. <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO22acceptableContentTypesSaySSGSgvp">acceptableContentTypes</a></code>.</li>
  426. <li>unacceptableStatusCode: The response status code was not acceptable.</li>
  427. </ul>
  428. <a href="../Enums/AFError/ResponseValidationFailureReason.html" class="slightly-smaller">See more</a>
  429. </div>
  430. <div class="declaration">
  431. <h4>Declaration</h4>
  432. <div class="language">
  433. <p class="aside-title">Swift</p>
  434. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ResponseValidationFailureReason</span></code></pre>
  435. </div>
  436. </div>
  437. </section>
  438. </div>
  439. </li>
  440. <li class="item">
  441. <div>
  442. <code>
  443. <a name="/s:9Alamofire7AFErrorO34ResponseSerializationFailureReasonO"></a>
  444. <a name="//apple_ref/swift/Enum/ResponseSerializationFailureReason" class="dashAnchor"></a>
  445. <a class="token" href="#/s:9Alamofire7AFErrorO34ResponseSerializationFailureReasonO">ResponseSerializationFailureReason</a>
  446. </code>
  447. </div>
  448. <div class="height-container">
  449. <div class="pointer-container"></div>
  450. <section class="section">
  451. <div class="pointer"></div>
  452. <div class="abstract">
  453. <p>The underlying reason the response serialization error occurred.</p>
  454. <ul>
  455. <li>inputDataNil: The server response contained no data.</li>
  456. <li>inputDataNilOrZeroLength: The server response contained no data or the data was zero length.</li>
  457. <li>inputFileNil: The file containing the server response did not exist.</li>
  458. <li>inputFileReadFailed: The file containing the server response could not be read.</li>
  459. <li>stringSerializationFailed: String serialization failed using the provided <code>String.Encoding</code>.</li>
  460. <li>jsonSerializationFailed: JSON serialization failed with an underlying system error.</li>
  461. <li>propertyListSerializationFailed: Property list serialization failed with an underlying system error.</li>
  462. </ul>
  463. <a href="../Enums/AFError/ResponseSerializationFailureReason.html" class="slightly-smaller">See more</a>
  464. </div>
  465. <div class="declaration">
  466. <h4>Declaration</h4>
  467. <div class="language">
  468. <p class="aside-title">Swift</p>
  469. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ResponseSerializationFailureReason</span></code></pre>
  470. </div>
  471. </div>
  472. </section>
  473. </div>
  474. </li>
  475. <li class="item">
  476. <div>
  477. <code>
  478. <a name="/s:9Alamofire7AFErrorO10invalidURLyAcA14URLConvertible_p_tcACmF"></a>
  479. <a name="//apple_ref/swift/Element/invalidURL(url:)" class="dashAnchor"></a>
  480. <a class="token" href="#/s:9Alamofire7AFErrorO10invalidURLyAcA14URLConvertible_p_tcACmF">invalidURL(url:)</a>
  481. </code>
  482. </div>
  483. <div class="height-container">
  484. <div class="pointer-container"></div>
  485. <section class="section">
  486. <div class="pointer"></div>
  487. <div class="abstract">
  488. <p>Undocumented</p>
  489. </div>
  490. <div class="declaration">
  491. <h4>Declaration</h4>
  492. <div class="language">
  493. <p class="aside-title">Swift</p>
  494. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">invalidURL</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">)</span></code></pre>
  495. </div>
  496. </div>
  497. </section>
  498. </div>
  499. </li>
  500. <li class="item">
  501. <div>
  502. <code>
  503. <a name="/s:9Alamofire7AFErrorO23parameterEncodingFailedyA2C09ParameterD13FailureReasonO_tcACmF"></a>
  504. <a name="//apple_ref/swift/Element/parameterEncodingFailed(reason:)" class="dashAnchor"></a>
  505. <a class="token" href="#/s:9Alamofire7AFErrorO23parameterEncodingFailedyA2C09ParameterD13FailureReasonO_tcACmF">parameterEncodingFailed(reason:)</a>
  506. </code>
  507. </div>
  508. <div class="height-container">
  509. <div class="pointer-container"></div>
  510. <section class="section">
  511. <div class="pointer"></div>
  512. <div class="abstract">
  513. <p>Undocumented</p>
  514. </div>
  515. <div class="declaration">
  516. <h4>Declaration</h4>
  517. <div class="language">
  518. <p class="aside-title">Swift</p>
  519. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">parameterEncodingFailed</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError/ParameterEncodingFailureReason.html">ParameterEncodingFailureReason</a></span><span class="p">)</span></code></pre>
  520. </div>
  521. </div>
  522. </section>
  523. </div>
  524. </li>
  525. <li class="item">
  526. <div>
  527. <code>
  528. <a name="/s:9Alamofire7AFErrorO23multipartEncodingFailedyA2C09MultipartD13FailureReasonO_tcACmF"></a>
  529. <a name="//apple_ref/swift/Element/multipartEncodingFailed(reason:)" class="dashAnchor"></a>
  530. <a class="token" href="#/s:9Alamofire7AFErrorO23multipartEncodingFailedyA2C09MultipartD13FailureReasonO_tcACmF">multipartEncodingFailed(reason:)</a>
  531. </code>
  532. </div>
  533. <div class="height-container">
  534. <div class="pointer-container"></div>
  535. <section class="section">
  536. <div class="pointer"></div>
  537. <div class="abstract">
  538. <p>Undocumented</p>
  539. </div>
  540. <div class="declaration">
  541. <h4>Declaration</h4>
  542. <div class="language">
  543. <p class="aside-title">Swift</p>
  544. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">multipartEncodingFailed</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError/MultipartEncodingFailureReason.html">MultipartEncodingFailureReason</a></span><span class="p">)</span></code></pre>
  545. </div>
  546. </div>
  547. </section>
  548. </div>
  549. </li>
  550. <li class="item">
  551. <div>
  552. <code>
  553. <a name="/s:9Alamofire7AFErrorO24responseValidationFailedyA2C08ResponseD13FailureReasonO_tcACmF"></a>
  554. <a name="//apple_ref/swift/Element/responseValidationFailed(reason:)" class="dashAnchor"></a>
  555. <a class="token" href="#/s:9Alamofire7AFErrorO24responseValidationFailedyA2C08ResponseD13FailureReasonO_tcACmF">responseValidationFailed(reason:)</a>
  556. </code>
  557. </div>
  558. <div class="height-container">
  559. <div class="pointer-container"></div>
  560. <section class="section">
  561. <div class="pointer"></div>
  562. <div class="abstract">
  563. <p>Undocumented</p>
  564. </div>
  565. <div class="declaration">
  566. <h4>Declaration</h4>
  567. <div class="language">
  568. <p class="aside-title">Swift</p>
  569. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">responseValidationFailed</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError/ResponseValidationFailureReason.html">ResponseValidationFailureReason</a></span><span class="p">)</span></code></pre>
  570. </div>
  571. </div>
  572. </section>
  573. </div>
  574. </li>
  575. <li class="item">
  576. <div>
  577. <code>
  578. <a name="/s:9Alamofire7AFErrorO27responseSerializationFailedyA2C08ResponseD13FailureReasonO_tcACmF"></a>
  579. <a name="//apple_ref/swift/Element/responseSerializationFailed(reason:)" class="dashAnchor"></a>
  580. <a class="token" href="#/s:9Alamofire7AFErrorO27responseSerializationFailedyA2C08ResponseD13FailureReasonO_tcACmF">responseSerializationFailed(reason:)</a>
  581. </code>
  582. </div>
  583. <div class="height-container">
  584. <div class="pointer-container"></div>
  585. <section class="section">
  586. <div class="pointer"></div>
  587. <div class="abstract">
  588. <p>Undocumented</p>
  589. </div>
  590. <div class="declaration">
  591. <h4>Declaration</h4>
  592. <div class="language">
  593. <p class="aside-title">Swift</p>
  594. <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">responseSerializationFailed</span><span class="p">(</span><span class="nv">reason</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError/ResponseSerializationFailureReason.html">ResponseSerializationFailureReason</a></span><span class="p">)</span></code></pre>
  595. </div>
  596. </div>
  597. </section>
  598. </div>
  599. </li>
  600. </ul>
  601. </div>
  602. <div class="task-group">
  603. <div class="task-name-container">
  604. <a name="/Error%20Booleans"></a>
  605. <a name="//apple_ref/swift/Section/Error Booleans" class="dashAnchor"></a>
  606. <a href="#/Error%20Booleans">
  607. <h3 class="section-name">Error Booleans</h3>
  608. </a>
  609. </div>
  610. <ul class="item-container">
  611. <li class="item">
  612. <div>
  613. <code>
  614. <a name="/s:9Alamofire7AFErrorO17isInvalidURLErrorSbvp"></a>
  615. <a name="//apple_ref/swift/Property/isInvalidURLError" class="dashAnchor"></a>
  616. <a class="token" href="#/s:9Alamofire7AFErrorO17isInvalidURLErrorSbvp">isInvalidURLError</a>
  617. </code>
  618. </div>
  619. <div class="height-container">
  620. <div class="pointer-container"></div>
  621. <section class="section">
  622. <div class="pointer"></div>
  623. <div class="abstract">
  624. <p>Returns whether the AFError is an invalid URL error.</p>
  625. </div>
  626. <div class="declaration">
  627. <h4>Declaration</h4>
  628. <div class="language">
  629. <p class="aside-title">Swift</p>
  630. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isInvalidURLError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  631. </div>
  632. </div>
  633. </section>
  634. </div>
  635. </li>
  636. <li class="item">
  637. <div>
  638. <code>
  639. <a name="/s:9Alamofire7AFErrorO24isParameterEncodingErrorSbvp"></a>
  640. <a name="//apple_ref/swift/Property/isParameterEncodingError" class="dashAnchor"></a>
  641. <a class="token" href="#/s:9Alamofire7AFErrorO24isParameterEncodingErrorSbvp">isParameterEncodingError</a>
  642. </code>
  643. </div>
  644. <div class="height-container">
  645. <div class="pointer-container"></div>
  646. <section class="section">
  647. <div class="pointer"></div>
  648. <div class="abstract">
  649. <p>Returns whether the AFError is a parameter encoding error. When <code>true</code>, the <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO15underlyingErrors0D0_pSgvp">underlyingError</a></code> property will
  650. contain the associated value.</p>
  651. </div>
  652. <div class="declaration">
  653. <h4>Declaration</h4>
  654. <div class="language">
  655. <p class="aside-title">Swift</p>
  656. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isParameterEncodingError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  657. </div>
  658. </div>
  659. </section>
  660. </div>
  661. </li>
  662. <li class="item">
  663. <div>
  664. <code>
  665. <a name="/s:9Alamofire7AFErrorO24isMultipartEncodingErrorSbvp"></a>
  666. <a name="//apple_ref/swift/Property/isMultipartEncodingError" class="dashAnchor"></a>
  667. <a class="token" href="#/s:9Alamofire7AFErrorO24isMultipartEncodingErrorSbvp">isMultipartEncodingError</a>
  668. </code>
  669. </div>
  670. <div class="height-container">
  671. <div class="pointer-container"></div>
  672. <section class="section">
  673. <div class="pointer"></div>
  674. <div class="abstract">
  675. <p>Returns whether the AFError is a multipart encoding error. When <code>true</code>, the <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO3url10Foundation3URLVSgvp">url</a></code> and <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO15underlyingErrors0D0_pSgvp">underlyingError</a></code> properties
  676. will contain the associated values.</p>
  677. </div>
  678. <div class="declaration">
  679. <h4>Declaration</h4>
  680. <div class="language">
  681. <p class="aside-title">Swift</p>
  682. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isMultipartEncodingError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  683. </div>
  684. </div>
  685. </section>
  686. </div>
  687. </li>
  688. <li class="item">
  689. <div>
  690. <code>
  691. <a name="/s:9Alamofire7AFErrorO25isResponseValidationErrorSbvp"></a>
  692. <a name="//apple_ref/swift/Property/isResponseValidationError" class="dashAnchor"></a>
  693. <a class="token" href="#/s:9Alamofire7AFErrorO25isResponseValidationErrorSbvp">isResponseValidationError</a>
  694. </code>
  695. </div>
  696. <div class="height-container">
  697. <div class="pointer-container"></div>
  698. <section class="section">
  699. <div class="pointer"></div>
  700. <div class="abstract">
  701. <p>Returns whether the <code>AFError</code> is a response validation error. When <code>true</code>, the <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO22acceptableContentTypesSaySSGSgvp">acceptableContentTypes</a></code>,
  702. <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO19responseContentTypeSSSgvp">responseContentType</a></code>, and <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO12responseCodeSiSgvp">responseCode</a></code> properties will contain the associated values.</p>
  703. </div>
  704. <div class="declaration">
  705. <h4>Declaration</h4>
  706. <div class="language">
  707. <p class="aside-title">Swift</p>
  708. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isResponseValidationError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  709. </div>
  710. </div>
  711. </section>
  712. </div>
  713. </li>
  714. <li class="item">
  715. <div>
  716. <code>
  717. <a name="/s:9Alamofire7AFErrorO28isResponseSerializationErrorSbvp"></a>
  718. <a name="//apple_ref/swift/Property/isResponseSerializationError" class="dashAnchor"></a>
  719. <a class="token" href="#/s:9Alamofire7AFErrorO28isResponseSerializationErrorSbvp">isResponseSerializationError</a>
  720. </code>
  721. </div>
  722. <div class="height-container">
  723. <div class="pointer-container"></div>
  724. <section class="section">
  725. <div class="pointer"></div>
  726. <div class="abstract">
  727. <p>Returns whether the <code>AFError</code> is a response serialization error. When <code>true</code>, the <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO20failedStringEncodingSS10FoundationE0E0VSgvp">failedStringEncoding</a></code> and
  728. <code><a href="../Enums/AFError.html#/s:9Alamofire7AFErrorO15underlyingErrors0D0_pSgvp">underlyingError</a></code> properties will contain the associated values.</p>
  729. </div>
  730. <div class="declaration">
  731. <h4>Declaration</h4>
  732. <div class="language">
  733. <p class="aside-title">Swift</p>
  734. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isResponseSerializationError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  735. </div>
  736. </div>
  737. </section>
  738. </div>
  739. </li>
  740. </ul>
  741. </div>
  742. <div class="task-group">
  743. <div class="task-name-container">
  744. <a name="/Convenience%20Properties"></a>
  745. <a name="//apple_ref/swift/Section/Convenience Properties" class="dashAnchor"></a>
  746. <a href="#/Convenience%20Properties">
  747. <h3 class="section-name">Convenience Properties</h3>
  748. </a>
  749. </div>
  750. <ul class="item-container">
  751. <li class="item">
  752. <div>
  753. <code>
  754. <a name="/s:9Alamofire7AFErrorO14urlConvertibleAA14URLConvertible_pSgvp"></a>
  755. <a name="//apple_ref/swift/Property/urlConvertible" class="dashAnchor"></a>
  756. <a class="token" href="#/s:9Alamofire7AFErrorO14urlConvertibleAA14URLConvertible_pSgvp">urlConvertible</a>
  757. </code>
  758. </div>
  759. <div class="height-container">
  760. <div class="pointer-container"></div>
  761. <section class="section">
  762. <div class="pointer"></div>
  763. <div class="abstract">
  764. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> associated with the error.</p>
  765. </div>
  766. <div class="declaration">
  767. <h4>Declaration</h4>
  768. <div class="language">
  769. <p class="aside-title">Swift</p>
  770. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">urlConvertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  771. </div>
  772. </div>
  773. </section>
  774. </div>
  775. </li>
  776. <li class="item">
  777. <div>
  778. <code>
  779. <a name="/s:9Alamofire7AFErrorO3url10Foundation3URLVSgvp"></a>
  780. <a name="//apple_ref/swift/Property/url" class="dashAnchor"></a>
  781. <a class="token" href="#/s:9Alamofire7AFErrorO3url10Foundation3URLVSgvp">url</a>
  782. </code>
  783. </div>
  784. <div class="height-container">
  785. <div class="pointer-container"></div>
  786. <section class="section">
  787. <div class="pointer"></div>
  788. <div class="abstract">
  789. <p>The <code>URL</code> associated with the error.</p>
  790. </div>
  791. <div class="declaration">
  792. <h4>Declaration</h4>
  793. <div class="language">
  794. <p class="aside-title">Swift</p>
  795. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  796. </div>
  797. </div>
  798. </section>
  799. </div>
  800. </li>
  801. <li class="item">
  802. <div>
  803. <code>
  804. <a name="/s:9Alamofire7AFErrorO15underlyingErrors0D0_pSgvp"></a>
  805. <a name="//apple_ref/swift/Property/underlyingError" class="dashAnchor"></a>
  806. <a class="token" href="#/s:9Alamofire7AFErrorO15underlyingErrors0D0_pSgvp">underlyingError</a>
  807. </code>
  808. </div>
  809. <div class="height-container">
  810. <div class="pointer-container"></div>
  811. <section class="section">
  812. <div class="pointer"></div>
  813. <div class="abstract">
  814. <p>The <code>Error</code> returned by a system framework associated with a <code>.parameterEncodingFailed</code>,
  815. <code>.multipartEncodingFailed</code> or <code>.responseSerializationFailed</code> error.</p>
  816. </div>
  817. <div class="declaration">
  818. <h4>Declaration</h4>
  819. <div class="language">
  820. <p class="aside-title">Swift</p>
  821. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">underlyingError</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  822. </div>
  823. </div>
  824. </section>
  825. </div>
  826. </li>
  827. <li class="item">
  828. <div>
  829. <code>
  830. <a name="/s:9Alamofire7AFErrorO22acceptableContentTypesSaySSGSgvp"></a>
  831. <a name="//apple_ref/swift/Property/acceptableContentTypes" class="dashAnchor"></a>
  832. <a class="token" href="#/s:9Alamofire7AFErrorO22acceptableContentTypesSaySSGSgvp">acceptableContentTypes</a>
  833. </code>
  834. </div>
  835. <div class="height-container">
  836. <div class="pointer-container"></div>
  837. <section class="section">
  838. <div class="pointer"></div>
  839. <div class="abstract">
  840. <p>The acceptable <code>Content-Type</code>s of a <code>.responseValidationFailed</code> error.</p>
  841. </div>
  842. <div class="declaration">
  843. <h4>Declaration</h4>
  844. <div class="language">
  845. <p class="aside-title">Swift</p>
  846. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  847. </div>
  848. </div>
  849. </section>
  850. </div>
  851. </li>
  852. <li class="item">
  853. <div>
  854. <code>
  855. <a name="/s:9Alamofire7AFErrorO19responseContentTypeSSSgvp"></a>
  856. <a name="//apple_ref/swift/Property/responseContentType" class="dashAnchor"></a>
  857. <a class="token" href="#/s:9Alamofire7AFErrorO19responseContentTypeSSSgvp">responseContentType</a>
  858. </code>
  859. </div>
  860. <div class="height-container">
  861. <div class="pointer-container"></div>
  862. <section class="section">
  863. <div class="pointer"></div>
  864. <div class="abstract">
  865. <p>The response <code>Content-Type</code> of a <code>.responseValidationFailed</code> error.</p>
  866. </div>
  867. <div class="declaration">
  868. <h4>Declaration</h4>
  869. <div class="language">
  870. <p class="aside-title">Swift</p>
  871. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">responseContentType</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  872. </div>
  873. </div>
  874. </section>
  875. </div>
  876. </li>
  877. <li class="item">
  878. <div>
  879. <code>
  880. <a name="/s:9Alamofire7AFErrorO12responseCodeSiSgvp"></a>
  881. <a name="//apple_ref/swift/Property/responseCode" class="dashAnchor"></a>
  882. <a class="token" href="#/s:9Alamofire7AFErrorO12responseCodeSiSgvp">responseCode</a>
  883. </code>
  884. </div>
  885. <div class="height-container">
  886. <div class="pointer-container"></div>
  887. <section class="section">
  888. <div class="pointer"></div>
  889. <div class="abstract">
  890. <p>The response code of a <code>.responseValidationFailed</code> error.</p>
  891. </div>
  892. <div class="declaration">
  893. <h4>Declaration</h4>
  894. <div class="language">
  895. <p class="aside-title">Swift</p>
  896. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">responseCode</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  897. </div>
  898. </div>
  899. </section>
  900. </div>
  901. </li>
  902. <li class="item">
  903. <div>
  904. <code>
  905. <a name="/s:9Alamofire7AFErrorO20failedStringEncodingSS10FoundationE0E0VSgvp"></a>
  906. <a name="//apple_ref/swift/Property/failedStringEncoding" class="dashAnchor"></a>
  907. <a class="token" href="#/s:9Alamofire7AFErrorO20failedStringEncodingSS10FoundationE0E0VSgvp">failedStringEncoding</a>
  908. </code>
  909. </div>
  910. <div class="height-container">
  911. <div class="pointer-container"></div>
  912. <section class="section">
  913. <div class="pointer"></div>
  914. <div class="abstract">
  915. <p>The <code>String.Encoding</code> associated with a failed <code>.stringResponse()</code> call.</p>
  916. </div>
  917. <div class="declaration">
  918. <h4>Declaration</h4>
  919. <div class="language">
  920. <p class="aside-title">Swift</p>
  921. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">failedStringEncoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  922. </div>
  923. </div>
  924. </section>
  925. </div>
  926. </li>
  927. </ul>
  928. </div>
  929. <div class="task-group">
  930. <div class="task-name-container">
  931. <a name="/Error%20Descriptions"></a>
  932. <a name="//apple_ref/swift/Section/Error Descriptions" class="dashAnchor"></a>
  933. <a href="#/Error%20Descriptions">
  934. <h3 class="section-name">Error Descriptions</h3>
  935. </a>
  936. </div>
  937. <ul class="item-container">
  938. <li class="item">
  939. <div>
  940. <code>
  941. <a name="/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp"></a>
  942. <a name="//apple_ref/swift/Property/errorDescription" class="dashAnchor"></a>
  943. <a class="token" href="#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp">errorDescription</a>
  944. </code>
  945. </div>
  946. <div class="height-container">
  947. <div class="pointer-container"></div>
  948. <section class="section">
  949. <div class="pointer"></div>
  950. <div class="abstract">
  951. </div>
  952. <div class="declaration">
  953. <h4>Declaration</h4>
  954. <div class="language">
  955. <p class="aside-title">Swift</p>
  956. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">errorDescription</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  957. </div>
  958. </div>
  959. </section>
  960. </div>
  961. </li>
  962. </ul>
  963. </div>
  964. </div>
  965. </section>
  966. </article>
  967. </div>
  968. <section class="footer">
  969. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-11-24)</p>
  970. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  971. </section>
  972. </body>
  973. </div>
  974. </html>