TwitterBase.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  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>TwitterBase (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="TwitterBase (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/TwitterBase.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/TwitterAPIMonitor.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/TwitterException.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/TwitterBase.html" target="_top">Frames</a></li>
  58. <li><a href="TwitterBase.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 TwitterBase" class="title">Interface TwitterBase</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Known Subinterfaces:</dt>
  105. <dd><a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a></dd>
  106. </dl>
  107. <hr>
  108. <br>
  109. <pre>public interface <span class="typeNameLabel">TwitterBase</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Since:</span></dt>
  112. <dd>Twitter4J 2.2.0</dd>
  113. <dt><span class="simpleTagLabel">Author:</span></dt>
  114. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  115. </dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="method.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Method Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  129. <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>
  130. <tr>
  131. <th class="colFirst" scope="col">Modifier and Type</th>
  132. <th class="colLast" scope="col">Method and Description</th>
  133. </tr>
  134. <tr id="i0" class="altColor">
  135. <td class="colFirst"><code>void</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#addRateLimitStatusListener-twitter4j.RateLimitStatusListener-">addRateLimitStatusListener</a></span>(<a href="../twitter4j/RateLimitStatusListener.html" title="interface in twitter4j">RateLimitStatusListener</a>&nbsp;listener)</code>
  137. <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a></code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getAuthorization--">getAuthorization</a></span>()</code>
  143. <div class="block">Returns the authorization scheme for this instance.<br>
  144. The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization</div>
  145. </td>
  146. </tr>
  147. <tr id="i2" class="altColor">
  148. <td class="colFirst"><code><a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a></code></td>
  149. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getConfiguration--">getConfiguration</a></span>()</code>
  150. <div class="block">Returns the configuration associated with this instance</div>
  151. </td>
  152. </tr>
  153. <tr id="i3" class="rowColor">
  154. <td class="colFirst"><code>long</code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getId--">getId</a></span>()</code>
  156. <div class="block">Returns authenticating user's user id.<br>
  157. This method may internally call verifyCredentials() on the first invocation if<br>
  158. - this instance is authenticated by Basic and email address is supplied instead of screen name, or
  159. - this instance is authenticated by OAuth.<br></div>
  160. </td>
  161. </tr>
  162. <tr id="i4" class="altColor">
  163. <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>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getScreenName--">getScreenName</a></span>()</code>
  165. <div class="block">Returns authenticating user's screen name.<br>
  166. This method may internally call verifyCredentials() on the first invocation if<br>
  167. - this instance is authenticated by Basic and email address is supplied instead of screen name, or
  168. - this instance is authenticated by OAuth.<br>
  169. Note that this method returns a transiently cached (will be lost upon serialization) screen name while it is possible to change a user's screen name.<br></div>
  170. </td>
  171. </tr>
  172. <tr id="i5" class="rowColor">
  173. <td class="colFirst"><code>void</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#onRateLimitReached-twitter4j.util.function.Consumer-">onRateLimitReached</a></span>(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a>&lt;<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>&gt;&nbsp;action)</code>
  175. <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
  176. </td>
  177. </tr>
  178. <tr id="i6" class="altColor">
  179. <td class="colFirst"><code>void</code></td>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#onRateLimitStatus-twitter4j.util.function.Consumer-">onRateLimitStatus</a></span>(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a>&lt;<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>&gt;&nbsp;action)</code>
  181. <div class="block">Registers a lambda action for account associated rate limits</div>
  182. </td>
  183. </tr>
  184. </table>
  185. </li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </div>
  190. <div class="details">
  191. <ul class="blockList">
  192. <li class="blockList">
  193. <!-- ============ METHOD DETAIL ========== -->
  194. <ul class="blockList">
  195. <li class="blockList"><a name="method.detail">
  196. <!-- -->
  197. </a>
  198. <h3>Method Detail</h3>
  199. <a name="getScreenName--">
  200. <!-- -->
  201. </a>
  202. <ul class="blockList">
  203. <li class="blockList">
  204. <h4>getScreenName</h4>
  205. <pre><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;getScreenName()
  206. throws <a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a>,
  207. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
  208. <div class="block">Returns authenticating user's screen name.<br>
  209. This method may internally call verifyCredentials() on the first invocation if<br>
  210. - this instance is authenticated by Basic and email address is supplied instead of screen name, or
  211. - this instance is authenticated by OAuth.<br>
  212. Note that this method returns a transiently cached (will be lost upon serialization) screen name while it is possible to change a user's screen name.<br></div>
  213. <dl>
  214. <dt><span class="returnLabel">Returns:</span></dt>
  215. <dd>the authenticating screen name</dd>
  216. <dt><span class="throwsLabel">Throws:</span></dt>
  217. <dd><code><a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when verifyCredentials threw an exception.</dd>
  218. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if no credentials are supplied. i.e.) this is an anonymous Twitter instance</dd>
  219. <dt><span class="simpleTagLabel">Since:</span></dt>
  220. <dd>Twitter4J 2.1.1</dd>
  221. </dl>
  222. </li>
  223. </ul>
  224. <a name="getId--">
  225. <!-- -->
  226. </a>
  227. <ul class="blockList">
  228. <li class="blockList">
  229. <h4>getId</h4>
  230. <pre>long&nbsp;getId()
  231. throws <a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a>,
  232. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
  233. <div class="block">Returns authenticating user's user id.<br>
  234. This method may internally call verifyCredentials() on the first invocation if<br>
  235. - this instance is authenticated by Basic and email address is supplied instead of screen name, or
  236. - this instance is authenticated by OAuth.<br></div>
  237. <dl>
  238. <dt><span class="returnLabel">Returns:</span></dt>
  239. <dd>the authenticating user's id</dd>
  240. <dt><span class="throwsLabel">Throws:</span></dt>
  241. <dd><code><a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when verifyCredentials threw an exception.</dd>
  242. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if no credentials are supplied. i.e.) this is an anonymous Twitter instance</dd>
  243. <dt><span class="simpleTagLabel">Since:</span></dt>
  244. <dd>Twitter4J 2.1.1</dd>
  245. </dl>
  246. </li>
  247. </ul>
  248. <a name="addRateLimitStatusListener-twitter4j.RateLimitStatusListener-">
  249. <!-- -->
  250. </a>
  251. <ul class="blockList">
  252. <li class="blockList">
  253. <h4>addRateLimitStatusListener</h4>
  254. <pre>void&nbsp;addRateLimitStatusListener(<a href="../twitter4j/RateLimitStatusListener.html" title="interface in twitter4j">RateLimitStatusListener</a>&nbsp;listener)</pre>
  255. <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
  256. <dl>
  257. <dt><span class="paramLabel">Parameters:</span></dt>
  258. <dd><code>listener</code> - the listener to be added</dd>
  259. <dt><span class="simpleTagLabel">Since:</span></dt>
  260. <dd>Twitter4J 2.1.12</dd>
  261. <dt><span class="seeLabel">See Also:</span></dt>
  262. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  263. </dl>
  264. </li>
  265. </ul>
  266. <a name="onRateLimitStatus-twitter4j.util.function.Consumer-">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>onRateLimitStatus</h4>
  272. <pre>void&nbsp;onRateLimitStatus(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a>&lt;<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>&gt;&nbsp;action)</pre>
  273. <div class="block">Registers a lambda action for account associated rate limits</div>
  274. <dl>
  275. <dt><span class="paramLabel">Parameters:</span></dt>
  276. <dd><code>action</code> - the action to be added</dd>
  277. <dt><span class="simpleTagLabel">Since:</span></dt>
  278. <dd>Twitter4J 4.0.4</dd>
  279. <dt><span class="seeLabel">See Also:</span></dt>
  280. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  281. </dl>
  282. </li>
  283. </ul>
  284. <a name="onRateLimitReached-twitter4j.util.function.Consumer-">
  285. <!-- -->
  286. </a>
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <h4>onRateLimitReached</h4>
  290. <pre>void&nbsp;onRateLimitReached(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a>&lt;<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>&gt;&nbsp;action)</pre>
  291. <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
  292. <dl>
  293. <dt><span class="paramLabel">Parameters:</span></dt>
  294. <dd><code>action</code> - the action to be added</dd>
  295. <dt><span class="simpleTagLabel">Since:</span></dt>
  296. <dd>Twitter4J 4.0.4</dd>
  297. <dt><span class="seeLabel">See Also:</span></dt>
  298. <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. <a name="getAuthorization--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>getAuthorization</h4>
  308. <pre><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a>&nbsp;getAuthorization()</pre>
  309. <div class="block">Returns the authorization scheme for this instance.<br>
  310. The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization</div>
  311. <dl>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>the authorization scheme for this instance</dd>
  314. </dl>
  315. </li>
  316. </ul>
  317. <a name="getConfiguration--">
  318. <!-- -->
  319. </a>
  320. <ul class="blockListLast">
  321. <li class="blockList">
  322. <h4>getConfiguration</h4>
  323. <pre><a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a>&nbsp;getConfiguration()</pre>
  324. <div class="block">Returns the configuration associated with this instance</div>
  325. <dl>
  326. <dt><span class="returnLabel">Returns:</span></dt>
  327. <dd>configuration associated with this instance</dd>
  328. <dt><span class="simpleTagLabel">Since:</span></dt>
  329. <dd>Twitter4J 2.1.8</dd>
  330. </dl>
  331. </li>
  332. </ul>
  333. </li>
  334. </ul>
  335. </li>
  336. </ul>
  337. </div>
  338. </div>
  339. <!-- ========= END OF CLASS DATA ========= -->
  340. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  341. <div class="bottomNav"><a name="navbar.bottom">
  342. <!-- -->
  343. </a>
  344. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  345. <a name="navbar.bottom.firstrow">
  346. <!-- -->
  347. </a>
  348. <ul class="navList" title="Navigation">
  349. <li><a href="../overview-summary.html">Overview</a></li>
  350. <li><a href="package-summary.html">Package</a></li>
  351. <li class="navBarCell1Rev">Class</li>
  352. <li><a href="class-use/TwitterBase.html">Use</a></li>
  353. <li><a href="package-tree.html">Tree</a></li>
  354. <li><a href="../deprecated-list.html">Deprecated</a></li>
  355. <li><a href="../index-all.html">Index</a></li>
  356. <li><a href="../help-doc.html">Help</a></li>
  357. </ul>
  358. </div>
  359. <div class="subNav">
  360. <ul class="navList">
  361. <li><a href="../twitter4j/TwitterAPIMonitor.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  362. <li><a href="../twitter4j/TwitterException.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  363. </ul>
  364. <ul class="navList">
  365. <li><a href="../index.html?twitter4j/TwitterBase.html" target="_top">Frames</a></li>
  366. <li><a href="TwitterBase.html" target="_top">No&nbsp;Frames</a></li>
  367. </ul>
  368. <ul class="navList" id="allclasses_navbar_bottom">
  369. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  370. </ul>
  371. <div>
  372. <script type="text/javascript"><!--
  373. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  374. if(window==top) {
  375. allClassesLink.style.display = "block";
  376. }
  377. else {
  378. allClassesLink.style.display = "none";
  379. }
  380. //-->
  381. </script>
  382. </div>
  383. <div>
  384. <ul class="subNavList">
  385. <li>Summary:&nbsp;</li>
  386. <li>Nested&nbsp;|&nbsp;</li>
  387. <li>Field&nbsp;|&nbsp;</li>
  388. <li>Constr&nbsp;|&nbsp;</li>
  389. <li><a href="#method.summary">Method</a></li>
  390. </ul>
  391. <ul class="subNavList">
  392. <li>Detail:&nbsp;</li>
  393. <li>Field&nbsp;|&nbsp;</li>
  394. <li>Constr&nbsp;|&nbsp;</li>
  395. <li><a href="#method.detail">Method</a></li>
  396. </ul>
  397. </div>
  398. <a name="skip.navbar.bottom">
  399. <!-- -->
  400. </a></div>
  401. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  402. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  403. </body>
  404. </html>