TwitterException.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:14 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>TwitterException (twitter4j-core 4.0.7 API)</title>
  8. <meta name="date" content="2018-08-16">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="TwitterException (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="class-use/TwitterException.html">Use</a></li>
  45. <li><a href="package-tree.html">Tree</a></li>
  46. <li><a href="../deprecated-list.html">Deprecated</a></li>
  47. <li><a href="../index-all.html">Index</a></li>
  48. <li><a href="../help-doc.html">Help</a></li>
  49. </ul>
  50. </div>
  51. <div class="subNav">
  52. <ul class="navList">
  53. <li><a href="../twitter4j/TwitterBase.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/TwitterFactory.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/TwitterException.html" target="_top">Frames</a></li>
  58. <li><a href="TwitterException.html" target="_top">No&nbsp;Frames</a></li>
  59. </ul>
  60. <ul class="navList" id="allclasses_navbar_top">
  61. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  62. </ul>
  63. <div>
  64. <script type="text/javascript"><!--
  65. allClassesLink = document.getElementById("allclasses_navbar_top");
  66. if(window==top) {
  67. allClassesLink.style.display = "block";
  68. }
  69. else {
  70. allClassesLink.style.display = "none";
  71. }
  72. //-->
  73. </script>
  74. </div>
  75. <div>
  76. <ul class="subNavList">
  77. <li>Summary:&nbsp;</li>
  78. <li>Nested&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  81. <li><a href="#method.summary">Method</a></li>
  82. </ul>
  83. <ul class="subNavList">
  84. <li>Detail:&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  87. <li><a href="#method.detail">Method</a></li>
  88. </ul>
  89. </div>
  90. <a name="skip.navbar.top">
  91. <!-- -->
  92. </a></div>
  93. <!-- ========= END OF TOP NAVBAR ========= -->
  94. <!-- ======== START OF CLASS DATA ======== -->
  95. <div class="header">
  96. <div class="subTitle">twitter4j</div>
  97. <h2 title="Class TwitterException" class="title">Class TwitterException</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <ul class="inheritance">
  101. <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  102. <li>
  103. <ul class="inheritance">
  104. <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
  105. <li>
  106. <ul class="inheritance">
  107. <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
  108. <li>
  109. <ul class="inheritance">
  110. <li>twitter4j.TwitterException</li>
  111. </ul>
  112. </li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. <div class="description">
  119. <ul class="blockList">
  120. <li class="blockList">
  121. <dl>
  122. <dt>All Implemented Interfaces:</dt>
  123. <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../twitter4j/HttpResponseCode.html" title="interface in twitter4j">HttpResponseCode</a>, <a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></dd>
  124. </dl>
  125. <hr>
  126. <br>
  127. <pre>public class <span class="typeNameLabel">TwitterException</span>
  128. extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>
  129. implements <a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a>, <a href="../twitter4j/HttpResponseCode.html" title="interface in twitter4j">HttpResponseCode</a></pre>
  130. <div class="block">An exception class that will be thrown when TwitterAPI calls are failed.<br>
  131. In case the Twitter server returned HTTP error code, you can get the HTTP status code using getStatusCode() method.</div>
  132. <dl>
  133. <dt><span class="simpleTagLabel">Author:</span></dt>
  134. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  135. <dt><span class="seeLabel">See Also:</span></dt>
  136. <dd><a href="../serialized-form.html#twitter4j.TwitterException">Serialized Form</a></dd>
  137. </dl>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="summary">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- =========== FIELD SUMMARY =========== -->
  145. <ul class="blockList">
  146. <li class="blockList"><a name="field.summary">
  147. <!-- -->
  148. </a>
  149. <h3>Field Summary</h3>
  150. <ul class="blockList">
  151. <li class="blockList"><a name="fields.inherited.from.class.twitter4j.TwitterResponse">
  152. <!-- -->
  153. </a>
  154. <h3>Fields inherited from interface&nbsp;twitter4j.<a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></h3>
  155. <code><a href="../twitter4j/TwitterResponse.html#NONE">NONE</a>, <a href="../twitter4j/TwitterResponse.html#READ">READ</a>, <a href="../twitter4j/TwitterResponse.html#READ_WRITE">READ_WRITE</a>, <a href="../twitter4j/TwitterResponse.html#READ_WRITE_DIRECTMESSAGES">READ_WRITE_DIRECTMESSAGES</a></code></li>
  156. </ul>
  157. <ul class="blockList">
  158. <li class="blockList"><a name="fields.inherited.from.class.twitter4j.HttpResponseCode">
  159. <!-- -->
  160. </a>
  161. <h3>Fields inherited from interface&nbsp;twitter4j.<a href="../twitter4j/HttpResponseCode.html" title="interface in twitter4j">HttpResponseCode</a></h3>
  162. <code><a href="../twitter4j/HttpResponseCode.html#BAD_GATEWAY">BAD_GATEWAY</a>, <a href="../twitter4j/HttpResponseCode.html#BAD_REQUEST">BAD_REQUEST</a>, <a href="../twitter4j/HttpResponseCode.html#ENHANCE_YOUR_CLAIM">ENHANCE_YOUR_CLAIM</a>, <a href="../twitter4j/HttpResponseCode.html#FORBIDDEN">FORBIDDEN</a>, <a href="../twitter4j/HttpResponseCode.html#FOUND">FOUND</a>, <a href="../twitter4j/HttpResponseCode.html#GATEWAY_TIMEOUT">GATEWAY_TIMEOUT</a>, <a href="../twitter4j/HttpResponseCode.html#INTERNAL_SERVER_ERROR">INTERNAL_SERVER_ERROR</a>, <a href="../twitter4j/HttpResponseCode.html#MULTIPLE_CHOICES">MULTIPLE_CHOICES</a>, <a href="../twitter4j/HttpResponseCode.html#NOT_ACCEPTABLE">NOT_ACCEPTABLE</a>, <a href="../twitter4j/HttpResponseCode.html#NOT_FOUND">NOT_FOUND</a>, <a href="../twitter4j/HttpResponseCode.html#NOT_MODIFIED">NOT_MODIFIED</a>, <a href="../twitter4j/HttpResponseCode.html#OK">OK</a>, <a href="../twitter4j/HttpResponseCode.html#SERVICE_UNAVAILABLE">SERVICE_UNAVAILABLE</a>, <a href="../twitter4j/HttpResponseCode.html#TOO_MANY_REQUESTS">TOO_MANY_REQUESTS</a>, <a href="../twitter4j/HttpResponseCode.html#UNAUTHORIZED">UNAUTHORIZED</a>, <a href="../twitter4j/HttpResponseCode.html#UNPROCESSABLE_ENTITY">UNPROCESSABLE_ENTITY</a></code></li>
  163. </ul>
  164. </li>
  165. </ul>
  166. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  167. <ul class="blockList">
  168. <li class="blockList"><a name="constructor.summary">
  169. <!-- -->
  170. </a>
  171. <h3>Constructor Summary</h3>
  172. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  173. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  174. <tr>
  175. <th class="colOne" scope="col">Constructor and Description</th>
  176. </tr>
  177. <tr class="altColor">
  178. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#TwitterException-java.lang.Exception-">TwitterException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;cause)</code>&nbsp;</td>
  179. </tr>
  180. <tr class="rowColor">
  181. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#TwitterException-java.lang.String-">TwitterException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</code>&nbsp;</td>
  182. </tr>
  183. <tr class="altColor">
  184. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#TwitterException-java.lang.String-java.lang.Exception-int-">TwitterException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  185. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;cause,
  186. int&nbsp;statusCode)</code>&nbsp;</td>
  187. </tr>
  188. <tr class="rowColor">
  189. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#TwitterException-java.lang.String-twitter4j.HttpResponse-">TwitterException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  190. <a href="../twitter4j/HttpResponse.html" title="class in twitter4j">HttpResponse</a>&nbsp;res)</code>&nbsp;</td>
  191. </tr>
  192. <tr class="altColor">
  193. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#TwitterException-java.lang.String-java.lang.Throwable-">TwitterException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  194. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</code>&nbsp;</td>
  195. </tr>
  196. </table>
  197. </li>
  198. </ul>
  199. <!-- ========== METHOD SUMMARY =========== -->
  200. <ul class="blockList">
  201. <li class="blockList"><a name="method.summary">
  202. <!-- -->
  203. </a>
  204. <h3>Method Summary</h3>
  205. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  206. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  207. <tr>
  208. <th class="colFirst" scope="col">Modifier and Type</th>
  209. <th class="colLast" scope="col">Method and Description</th>
  210. </tr>
  211. <tr id="i0" class="altColor">
  212. <td class="colFirst"><code>boolean</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>&nbsp;</td>
  214. </tr>
  215. <tr id="i1" class="rowColor">
  216. <td class="colFirst"><code>boolean</code></td>
  217. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#exceededRateLimitation--">exceededRateLimitation</a></span>()</code>
  218. <div class="block">Tests if the exception is caused by rate limitation exceed</div>
  219. </td>
  220. </tr>
  221. <tr id="i2" class="altColor">
  222. <td class="colFirst"><code>int</code></td>
  223. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getAccessLevel--">getAccessLevel</a></span>()</code>&nbsp;</td>
  224. </tr>
  225. <tr id="i3" class="rowColor">
  226. <td class="colFirst"><code>int</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getErrorCode--">getErrorCode</a></span>()</code>&nbsp;</td>
  228. </tr>
  229. <tr id="i4" class="altColor">
  230. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  231. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getErrorMessage--">getErrorMessage</a></span>()</code>
  232. <div class="block">Returns error message from the API if available.</div>
  233. </td>
  234. </tr>
  235. <tr id="i5" class="rowColor">
  236. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  237. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getExceptionCode--">getExceptionCode</a></span>()</code>
  238. <div class="block">Returns a hexadecimal representation of this exception stacktrace.<br>
  239. An exception code is a hexadecimal representation of the stacktrace which enables it easier to Google known issues.<br>
  240. Format : XXXXXXXX:YYYYYYYY[ XX:YY]<br>
  241. Where XX is a hash code of stacktrace without line number<br>
  242. YY is a hash code of stacktrace excluding line number<br>
  243. [-XX:YY] will appear when this instance a root cause</div>
  244. </td>
  245. </tr>
  246. <tr id="i6" class="altColor">
  247. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getMessage--">getMessage</a></span>()</code>&nbsp;</td>
  249. </tr>
  250. <tr id="i7" class="rowColor">
  251. <td class="colFirst"><code><a href="../twitter4j/RateLimitStatus.html" title="interface in twitter4j">RateLimitStatus</a></code></td>
  252. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getRateLimitStatus--">getRateLimitStatus</a></span>()</code>
  253. <div class="block">Returns the current rate limit status if available.</div>
  254. </td>
  255. </tr>
  256. <tr id="i8" class="altColor">
  257. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  258. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getResponseHeader-java.lang.String-">getResponseHeader</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</td>
  259. </tr>
  260. <tr id="i9" class="rowColor">
  261. <td class="colFirst"><code>int</code></td>
  262. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getRetryAfter--">getRetryAfter</a></span>()</code>
  263. <div class="block">Returns int value of "Retry-After" response header (Search API) or seconds_until_reset (REST API).</div>
  264. </td>
  265. </tr>
  266. <tr id="i10" class="altColor">
  267. <td class="colFirst"><code>int</code></td>
  268. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#getStatusCode--">getStatusCode</a></span>()</code>&nbsp;</td>
  269. </tr>
  270. <tr id="i11" class="rowColor">
  271. <td class="colFirst"><code>int</code></td>
  272. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
  273. </tr>
  274. <tr id="i12" class="altColor">
  275. <td class="colFirst"><code>boolean</code></td>
  276. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#isCausedByNetworkIssue--">isCausedByNetworkIssue</a></span>()</code>
  277. <div class="block">Tests if the exception is caused by network issue</div>
  278. </td>
  279. </tr>
  280. <tr id="i13" class="rowColor">
  281. <td class="colFirst"><code>boolean</code></td>
  282. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#isErrorMessageAvailable--">isErrorMessageAvailable</a></span>()</code>
  283. <div class="block">Tests if error message from the API is available</div>
  284. </td>
  285. </tr>
  286. <tr id="i14" class="altColor">
  287. <td class="colFirst"><code>boolean</code></td>
  288. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#resourceNotFound--">resourceNotFound</a></span>()</code>
  289. <div class="block">Tests if the exception is caused by non-existing resource</div>
  290. </td>
  291. </tr>
  292. <tr id="i15" class="rowColor">
  293. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  294. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterException.html#toString--">toString</a></span>()</code>&nbsp;</td>
  295. </tr>
  296. </table>
  297. <ul class="blockList">
  298. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
  299. <!-- -->
  300. </a>
  301. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
  302. <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a></code></li>
  303. </ul>
  304. <ul class="blockList">
  305. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  306. <!-- -->
  307. </a>
  308. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  309. <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  310. </ul>
  311. </li>
  312. </ul>
  313. </li>
  314. </ul>
  315. </div>
  316. <div class="details">
  317. <ul class="blockList">
  318. <li class="blockList">
  319. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  320. <ul class="blockList">
  321. <li class="blockList"><a name="constructor.detail">
  322. <!-- -->
  323. </a>
  324. <h3>Constructor Detail</h3>
  325. <a name="TwitterException-java.lang.String-java.lang.Throwable-">
  326. <!-- -->
  327. </a>
  328. <ul class="blockList">
  329. <li class="blockList">
  330. <h4>TwitterException</h4>
  331. <pre>public&nbsp;TwitterException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  332. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;cause)</pre>
  333. </li>
  334. </ul>
  335. <a name="TwitterException-java.lang.String-">
  336. <!-- -->
  337. </a>
  338. <ul class="blockList">
  339. <li class="blockList">
  340. <h4>TwitterException</h4>
  341. <pre>public&nbsp;TwitterException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</pre>
  342. </li>
  343. </ul>
  344. <a name="TwitterException-java.lang.Exception-">
  345. <!-- -->
  346. </a>
  347. <ul class="blockList">
  348. <li class="blockList">
  349. <h4>TwitterException</h4>
  350. <pre>public&nbsp;TwitterException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;cause)</pre>
  351. </li>
  352. </ul>
  353. <a name="TwitterException-java.lang.String-twitter4j.HttpResponse-">
  354. <!-- -->
  355. </a>
  356. <ul class="blockList">
  357. <li class="blockList">
  358. <h4>TwitterException</h4>
  359. <pre>public&nbsp;TwitterException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  360. <a href="../twitter4j/HttpResponse.html" title="class in twitter4j">HttpResponse</a>&nbsp;res)</pre>
  361. </li>
  362. </ul>
  363. <a name="TwitterException-java.lang.String-java.lang.Exception-int-">
  364. <!-- -->
  365. </a>
  366. <ul class="blockListLast">
  367. <li class="blockList">
  368. <h4>TwitterException</h4>
  369. <pre>public&nbsp;TwitterException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
  370. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;cause,
  371. int&nbsp;statusCode)</pre>
  372. </li>
  373. </ul>
  374. </li>
  375. </ul>
  376. <!-- ============ METHOD DETAIL ========== -->
  377. <ul class="blockList">
  378. <li class="blockList"><a name="method.detail">
  379. <!-- -->
  380. </a>
  381. <h3>Method Detail</h3>
  382. <a name="getMessage--">
  383. <!-- -->
  384. </a>
  385. <ul class="blockList">
  386. <li class="blockList">
  387. <h4>getMessage</h4>
  388. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getMessage()</pre>
  389. <dl>
  390. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  391. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></dd>
  392. </dl>
  393. </li>
  394. </ul>
  395. <a name="getStatusCode--">
  396. <!-- -->
  397. </a>
  398. <ul class="blockList">
  399. <li class="blockList">
  400. <h4>getStatusCode</h4>
  401. <pre>public&nbsp;int&nbsp;getStatusCode()</pre>
  402. </li>
  403. </ul>
  404. <a name="getErrorCode--">
  405. <!-- -->
  406. </a>
  407. <ul class="blockList">
  408. <li class="blockList">
  409. <h4>getErrorCode</h4>
  410. <pre>public&nbsp;int&nbsp;getErrorCode()</pre>
  411. </li>
  412. </ul>
  413. <a name="getResponseHeader-java.lang.String-">
  414. <!-- -->
  415. </a>
  416. <ul class="blockList">
  417. <li class="blockList">
  418. <h4>getResponseHeader</h4>
  419. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResponseHeader(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
  420. </li>
  421. </ul>
  422. <a name="getRateLimitStatus--">
  423. <!-- -->
  424. </a>
  425. <ul class="blockList">
  426. <li class="blockList">
  427. <h4>getRateLimitStatus</h4>
  428. <pre>public&nbsp;<a href="../twitter4j/RateLimitStatus.html" title="interface in twitter4j">RateLimitStatus</a>&nbsp;getRateLimitStatus()</pre>
  429. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../twitter4j/TwitterResponse.html#getRateLimitStatus--">TwitterResponse</a></code></span></div>
  430. <div class="block">Returns the current rate limit status if available.</div>
  431. <dl>
  432. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  433. <dd><code><a href="../twitter4j/TwitterResponse.html#getRateLimitStatus--">getRateLimitStatus</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></code></dd>
  434. <dt><span class="returnLabel">Returns:</span></dt>
  435. <dd>current rate limit status</dd>
  436. </dl>
  437. </li>
  438. </ul>
  439. <a name="getAccessLevel--">
  440. <!-- -->
  441. </a>
  442. <ul class="blockList">
  443. <li class="blockList">
  444. <h4>getAccessLevel</h4>
  445. <pre>public&nbsp;int&nbsp;getAccessLevel()</pre>
  446. <dl>
  447. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  448. <dd><code><a href="../twitter4j/TwitterResponse.html#getAccessLevel--">getAccessLevel</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></code></dd>
  449. <dt><span class="returnLabel">Returns:</span></dt>
  450. <dd>application permission model</dd>
  451. <dt><span class="seeLabel">See Also:</span></dt>
  452. <dd><a href="https://dev.twitter.com/pages/application-permission-model-faq#how-do-we-know-what-the-access-level-of-a-user-token-is">Application Permission Model FAQ - How do we know what the access level of a user token is?</a></dd>
  453. </dl>
  454. </li>
  455. </ul>
  456. <a name="getRetryAfter--">
  457. <!-- -->
  458. </a>
  459. <ul class="blockList">
  460. <li class="blockList">
  461. <h4>getRetryAfter</h4>
  462. <pre>public&nbsp;int&nbsp;getRetryAfter()</pre>
  463. <div class="block">Returns int value of "Retry-After" response header (Search API) or seconds_until_reset (REST API).
  464. An application that exceeds the rate limitations of the Search API will receive HTTP 420 response codes to requests. It is a best
  465. practice to watch for this error condition and honor the Retry-After header that instructs the application when it is safe to
  466. continue. The Retry-After header's value is the number of seconds your application should wait before submitting another query (for
  467. example: Retry-After: 67).<br>
  468. Check if getStatusCode() == 503 before calling this method to ensure that you are actually exceeding rate limitation with query
  469. apis.<br></div>
  470. <dl>
  471. <dt><span class="returnLabel">Returns:</span></dt>
  472. <dd>instructs the application when it is safe to continue in seconds</dd>
  473. <dt><span class="simpleTagLabel">Since:</span></dt>
  474. <dd>Twitter4J 2.1.0</dd>
  475. <dt><span class="seeLabel">See Also:</span></dt>
  476. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  477. </dl>
  478. </li>
  479. </ul>
  480. <a name="isCausedByNetworkIssue--">
  481. <!-- -->
  482. </a>
  483. <ul class="blockList">
  484. <li class="blockList">
  485. <h4>isCausedByNetworkIssue</h4>
  486. <pre>public&nbsp;boolean&nbsp;isCausedByNetworkIssue()</pre>
  487. <div class="block">Tests if the exception is caused by network issue</div>
  488. <dl>
  489. <dt><span class="returnLabel">Returns:</span></dt>
  490. <dd>if the exception is caused by network issue</dd>
  491. <dt><span class="simpleTagLabel">Since:</span></dt>
  492. <dd>Twitter4J 2.1.2</dd>
  493. </dl>
  494. </li>
  495. </ul>
  496. <a name="exceededRateLimitation--">
  497. <!-- -->
  498. </a>
  499. <ul class="blockList">
  500. <li class="blockList">
  501. <h4>exceededRateLimitation</h4>
  502. <pre>public&nbsp;boolean&nbsp;exceededRateLimitation()</pre>
  503. <div class="block">Tests if the exception is caused by rate limitation exceed</div>
  504. <dl>
  505. <dt><span class="returnLabel">Returns:</span></dt>
  506. <dd>if the exception is caused by rate limitation exceed</dd>
  507. <dt><span class="simpleTagLabel">Since:</span></dt>
  508. <dd>Twitter4J 2.1.2</dd>
  509. <dt><span class="seeLabel">See Also:</span></dt>
  510. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  511. </dl>
  512. </li>
  513. </ul>
  514. <a name="resourceNotFound--">
  515. <!-- -->
  516. </a>
  517. <ul class="blockList">
  518. <li class="blockList">
  519. <h4>resourceNotFound</h4>
  520. <pre>public&nbsp;boolean&nbsp;resourceNotFound()</pre>
  521. <div class="block">Tests if the exception is caused by non-existing resource</div>
  522. <dl>
  523. <dt><span class="returnLabel">Returns:</span></dt>
  524. <dd>if the exception is caused by non-existing resource</dd>
  525. <dt><span class="simpleTagLabel">Since:</span></dt>
  526. <dd>Twitter4J 2.1.2</dd>
  527. </dl>
  528. </li>
  529. </ul>
  530. <a name="getExceptionCode--">
  531. <!-- -->
  532. </a>
  533. <ul class="blockList">
  534. <li class="blockList">
  535. <h4>getExceptionCode</h4>
  536. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getExceptionCode()</pre>
  537. <div class="block">Returns a hexadecimal representation of this exception stacktrace.<br>
  538. An exception code is a hexadecimal representation of the stacktrace which enables it easier to Google known issues.<br>
  539. Format : XXXXXXXX:YYYYYYYY[ XX:YY]<br>
  540. Where XX is a hash code of stacktrace without line number<br>
  541. YY is a hash code of stacktrace excluding line number<br>
  542. [-XX:YY] will appear when this instance a root cause</div>
  543. <dl>
  544. <dt><span class="returnLabel">Returns:</span></dt>
  545. <dd>a hexadecimal representation of this exception stacktrace</dd>
  546. </dl>
  547. </li>
  548. </ul>
  549. <a name="getErrorMessage--">
  550. <!-- -->
  551. </a>
  552. <ul class="blockList">
  553. <li class="blockList">
  554. <h4>getErrorMessage</h4>
  555. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getErrorMessage()</pre>
  556. <div class="block">Returns error message from the API if available.</div>
  557. <dl>
  558. <dt><span class="returnLabel">Returns:</span></dt>
  559. <dd>error message from the API</dd>
  560. <dt><span class="simpleTagLabel">Since:</span></dt>
  561. <dd>Twitter4J 2.2.3</dd>
  562. </dl>
  563. </li>
  564. </ul>
  565. <a name="isErrorMessageAvailable--">
  566. <!-- -->
  567. </a>
  568. <ul class="blockList">
  569. <li class="blockList">
  570. <h4>isErrorMessageAvailable</h4>
  571. <pre>public&nbsp;boolean&nbsp;isErrorMessageAvailable()</pre>
  572. <div class="block">Tests if error message from the API is available</div>
  573. <dl>
  574. <dt><span class="returnLabel">Returns:</span></dt>
  575. <dd>true if error message from the API is available</dd>
  576. <dt><span class="simpleTagLabel">Since:</span></dt>
  577. <dd>Twitter4J 2.2.3</dd>
  578. </dl>
  579. </li>
  580. </ul>
  581. <a name="equals-java.lang.Object-">
  582. <!-- -->
  583. </a>
  584. <ul class="blockList">
  585. <li class="blockList">
  586. <h4>equals</h4>
  587. <pre>public&nbsp;boolean&nbsp;equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
  588. <dl>
  589. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  590. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
  591. </dl>
  592. </li>
  593. </ul>
  594. <a name="hashCode--">
  595. <!-- -->
  596. </a>
  597. <ul class="blockList">
  598. <li class="blockList">
  599. <h4>hashCode</h4>
  600. <pre>public&nbsp;int&nbsp;hashCode()</pre>
  601. <dl>
  602. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  603. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
  604. </dl>
  605. </li>
  606. </ul>
  607. <a name="toString--">
  608. <!-- -->
  609. </a>
  610. <ul class="blockListLast">
  611. <li class="blockList">
  612. <h4>toString</h4>
  613. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
  614. <dl>
  615. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  616. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></dd>
  617. </dl>
  618. </li>
  619. </ul>
  620. </li>
  621. </ul>
  622. </li>
  623. </ul>
  624. </div>
  625. </div>
  626. <!-- ========= END OF CLASS DATA ========= -->
  627. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  628. <div class="bottomNav"><a name="navbar.bottom">
  629. <!-- -->
  630. </a>
  631. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  632. <a name="navbar.bottom.firstrow">
  633. <!-- -->
  634. </a>
  635. <ul class="navList" title="Navigation">
  636. <li><a href="../overview-summary.html">Overview</a></li>
  637. <li><a href="package-summary.html">Package</a></li>
  638. <li class="navBarCell1Rev">Class</li>
  639. <li><a href="class-use/TwitterException.html">Use</a></li>
  640. <li><a href="package-tree.html">Tree</a></li>
  641. <li><a href="../deprecated-list.html">Deprecated</a></li>
  642. <li><a href="../index-all.html">Index</a></li>
  643. <li><a href="../help-doc.html">Help</a></li>
  644. </ul>
  645. </div>
  646. <div class="subNav">
  647. <ul class="navList">
  648. <li><a href="../twitter4j/TwitterBase.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  649. <li><a href="../twitter4j/TwitterFactory.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  650. </ul>
  651. <ul class="navList">
  652. <li><a href="../index.html?twitter4j/TwitterException.html" target="_top">Frames</a></li>
  653. <li><a href="TwitterException.html" target="_top">No&nbsp;Frames</a></li>
  654. </ul>
  655. <ul class="navList" id="allclasses_navbar_bottom">
  656. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  657. </ul>
  658. <div>
  659. <script type="text/javascript"><!--
  660. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  661. if(window==top) {
  662. allClassesLink.style.display = "block";
  663. }
  664. else {
  665. allClassesLink.style.display = "none";
  666. }
  667. //-->
  668. </script>
  669. </div>
  670. <div>
  671. <ul class="subNavList">
  672. <li>Summary:&nbsp;</li>
  673. <li>Nested&nbsp;|&nbsp;</li>
  674. <li>Field&nbsp;|&nbsp;</li>
  675. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  676. <li><a href="#method.summary">Method</a></li>
  677. </ul>
  678. <ul class="subNavList">
  679. <li>Detail:&nbsp;</li>
  680. <li>Field&nbsp;|&nbsp;</li>
  681. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  682. <li><a href="#method.detail">Method</a></li>
  683. </ul>
  684. </div>
  685. <a name="skip.navbar.bottom">
  686. <!-- -->
  687. </a></div>
  688. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  689. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  690. </body>
  691. </html>