AFError.html 56 KB

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