RateLimitStatus.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  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>RateLimitStatus (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="RateLimitStatus (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RateLimitStatus.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/QueryResult.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/RateLimitStatusEvent.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/RateLimitStatus.html" target="_top">Frames</a></li>
  58. <li><a href="RateLimitStatus.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>Constr&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>Constr&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="Interface RateLimitStatus" class="title">Interface RateLimitStatus</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Superinterfaces:</dt>
  105. <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></dd>
  106. </dl>
  107. <hr>
  108. <br>
  109. <pre>public interface <span class="typeNameLabel">RateLimitStatus</span>
  110. extends <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></pre>
  111. <div class="block">A data interface representing Twitter REST API's rate limit status</div>
  112. <dl>
  113. <dt><span class="simpleTagLabel">Author:</span></dt>
  114. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  115. <dt><span class="seeLabel">See Also:</span></dt>
  116. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  117. </dl>
  118. </li>
  119. </ul>
  120. </div>
  121. <div class="summary">
  122. <ul class="blockList">
  123. <li class="blockList">
  124. <!-- ========== METHOD SUMMARY =========== -->
  125. <ul class="blockList">
  126. <li class="blockList"><a name="method.summary">
  127. <!-- -->
  128. </a>
  129. <h3>Method Summary</h3>
  130. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  131. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  132. <tr>
  133. <th class="colFirst" scope="col">Modifier and Type</th>
  134. <th class="colLast" scope="col">Method and Description</th>
  135. </tr>
  136. <tr id="i0" class="altColor">
  137. <td class="colFirst"><code>int</code></td>
  138. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/RateLimitStatus.html#getLimit--">getLimit</a></span>()</code>
  139. <div class="block">Returns the current limit in effect<br>
  140. This value is identical to the &quot;X-Rate-Limit-Limit&quot; response header.</div>
  141. </td>
  142. </tr>
  143. <tr id="i1" class="rowColor">
  144. <td class="colFirst"><code>int</code></td>
  145. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/RateLimitStatus.html#getRemaining--">getRemaining</a></span>()</code>
  146. <div class="block">Returns the remaining number of API requests available.<br>
  147. This value is identical to the &quot;X-Rate-Limit-Remaining&quot; response header.</div>
  148. </td>
  149. </tr>
  150. <tr id="i2" class="altColor">
  151. <td class="colFirst"><code>int</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/RateLimitStatus.html#getResetTimeInSeconds--">getResetTimeInSeconds</a></span>()</code>
  153. <div class="block">Returns the seconds the current rate limiting period ends.<br>
  154. This should be a same as getResetTime().getTime()/1000.</div>
  155. </td>
  156. </tr>
  157. <tr id="i3" class="rowColor">
  158. <td class="colFirst"><code>int</code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/RateLimitStatus.html#getSecondsUntilReset--">getSecondsUntilReset</a></span>()</code>
  160. <div class="block">Returns the amount of seconds until the current rate limiting period ends.<br>
  161. This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.</div>
  162. </td>
  163. </tr>
  164. </table>
  165. </li>
  166. </ul>
  167. </li>
  168. </ul>
  169. </div>
  170. <div class="details">
  171. <ul class="blockList">
  172. <li class="blockList">
  173. <!-- ============ METHOD DETAIL ========== -->
  174. <ul class="blockList">
  175. <li class="blockList"><a name="method.detail">
  176. <!-- -->
  177. </a>
  178. <h3>Method Detail</h3>
  179. <a name="getRemaining--">
  180. <!-- -->
  181. </a>
  182. <ul class="blockList">
  183. <li class="blockList">
  184. <h4>getRemaining</h4>
  185. <pre>int&nbsp;getRemaining()</pre>
  186. <div class="block">Returns the remaining number of API requests available.<br>
  187. This value is identical to the &quot;X-Rate-Limit-Remaining&quot; response header.</div>
  188. <dl>
  189. <dt><span class="returnLabel">Returns:</span></dt>
  190. <dd>the remaining number of API requests available</dd>
  191. <dt><span class="simpleTagLabel">Since:</span></dt>
  192. <dd>Twitter4J 3.0.0</dd>
  193. </dl>
  194. </li>
  195. </ul>
  196. <a name="getLimit--">
  197. <!-- -->
  198. </a>
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <h4>getLimit</h4>
  202. <pre>int&nbsp;getLimit()</pre>
  203. <div class="block">Returns the current limit in effect<br>
  204. This value is identical to the &quot;X-Rate-Limit-Limit&quot; response header.</div>
  205. <dl>
  206. <dt><span class="returnLabel">Returns:</span></dt>
  207. <dd>the current limit in effect</dd>
  208. </dl>
  209. </li>
  210. </ul>
  211. <a name="getResetTimeInSeconds--">
  212. <!-- -->
  213. </a>
  214. <ul class="blockList">
  215. <li class="blockList">
  216. <h4>getResetTimeInSeconds</h4>
  217. <pre>int&nbsp;getResetTimeInSeconds()</pre>
  218. <div class="block">Returns the seconds the current rate limiting period ends.<br>
  219. This should be a same as getResetTime().getTime()/1000.</div>
  220. <dl>
  221. <dt><span class="returnLabel">Returns:</span></dt>
  222. <dd>the seconds the current rate limiting period ends</dd>
  223. <dt><span class="simpleTagLabel">Since:</span></dt>
  224. <dd>Twitter4J 2.0.9</dd>
  225. </dl>
  226. </li>
  227. </ul>
  228. <a name="getSecondsUntilReset--">
  229. <!-- -->
  230. </a>
  231. <ul class="blockListLast">
  232. <li class="blockList">
  233. <h4>getSecondsUntilReset</h4>
  234. <pre>int&nbsp;getSecondsUntilReset()</pre>
  235. <div class="block">Returns the amount of seconds until the current rate limiting period ends.<br>
  236. This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.</div>
  237. <dl>
  238. <dt><span class="returnLabel">Returns:</span></dt>
  239. <dd>the amount of seconds until next rate limiting period</dd>
  240. <dt><span class="simpleTagLabel">Since:</span></dt>
  241. <dd>Twitter4J 2.1.0</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. </li>
  246. </ul>
  247. </li>
  248. </ul>
  249. </div>
  250. </div>
  251. <!-- ========= END OF CLASS DATA ========= -->
  252. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  253. <div class="bottomNav"><a name="navbar.bottom">
  254. <!-- -->
  255. </a>
  256. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  257. <a name="navbar.bottom.firstrow">
  258. <!-- -->
  259. </a>
  260. <ul class="navList" title="Navigation">
  261. <li><a href="../overview-summary.html">Overview</a></li>
  262. <li><a href="package-summary.html">Package</a></li>
  263. <li class="navBarCell1Rev">Class</li>
  264. <li><a href="class-use/RateLimitStatus.html">Use</a></li>
  265. <li><a href="package-tree.html">Tree</a></li>
  266. <li><a href="../deprecated-list.html">Deprecated</a></li>
  267. <li><a href="../index-all.html">Index</a></li>
  268. <li><a href="../help-doc.html">Help</a></li>
  269. </ul>
  270. </div>
  271. <div class="subNav">
  272. <ul class="navList">
  273. <li><a href="../twitter4j/QueryResult.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  274. <li><a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  275. </ul>
  276. <ul class="navList">
  277. <li><a href="../index.html?twitter4j/RateLimitStatus.html" target="_top">Frames</a></li>
  278. <li><a href="RateLimitStatus.html" target="_top">No&nbsp;Frames</a></li>
  279. </ul>
  280. <ul class="navList" id="allclasses_navbar_bottom">
  281. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  282. </ul>
  283. <div>
  284. <script type="text/javascript"><!--
  285. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  286. if(window==top) {
  287. allClassesLink.style.display = "block";
  288. }
  289. else {
  290. allClassesLink.style.display = "none";
  291. }
  292. //-->
  293. </script>
  294. </div>
  295. <div>
  296. <ul class="subNavList">
  297. <li>Summary:&nbsp;</li>
  298. <li>Nested&nbsp;|&nbsp;</li>
  299. <li>Field&nbsp;|&nbsp;</li>
  300. <li>Constr&nbsp;|&nbsp;</li>
  301. <li><a href="#method.summary">Method</a></li>
  302. </ul>
  303. <ul class="subNavList">
  304. <li>Detail:&nbsp;</li>
  305. <li>Field&nbsp;|&nbsp;</li>
  306. <li>Constr&nbsp;|&nbsp;</li>
  307. <li><a href="#method.detail">Method</a></li>
  308. </ul>
  309. </div>
  310. <a name="skip.navbar.bottom">
  311. <!-- -->
  312. </a></div>
  313. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  314. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  315. </body>
  316. </html>