123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:14 JST 2018 -->
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title>TwitterBase (twitter4j-core 4.0.7 API)</title>
- <meta name="date" content="2018-08-16">
- <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
- <script type="text/javascript" src="../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="TwitterBase (twitter4j-core 4.0.7 API)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/TwitterBase.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../deprecated-list.html">Deprecated</a></li>
- <li><a href="../index-all.html">Index</a></li>
- <li><a href="../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../twitter4j/TwitterAPIMonitor.html" title="class in twitter4j"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../twitter4j/TwitterException.html" title="class in twitter4j"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?twitter4j/TwitterBase.html" target="_top">Frames</a></li>
- <li><a href="TwitterBase.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">twitter4j</div>
- <h2 title="Interface TwitterBase" class="title">Interface TwitterBase</h2>
- </div>
- <div class="contentContainer">
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Known Subinterfaces:</dt>
- <dd><a href="../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public interface <span class="typeNameLabel">TwitterBase</span></pre>
- <dl>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 2.2.0</dd>
- <dt><span class="simpleTagLabel">Author:</span></dt>
- <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <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> listener)</code>
- <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getAuthorization--">getAuthorization</a></span>()</code>
- <div class="block">Returns the authorization scheme for this instance.<br>
- The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code><a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getConfiguration--">getConfiguration</a></span>()</code>
- <div class="block">Returns the configuration associated with this instance</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getId--">getId</a></span>()</code>
- <div class="block">Returns authenticating user's user id.<br>
- This method may internally call verifyCredentials() on the first invocation if<br>
- - this instance is authenticated by Basic and email address is supplied instead of screen name, or
- - this instance is authenticated by OAuth.<br></div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <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>
- <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/TwitterBase.html#getScreenName--">getScreenName</a></span>()</code>
- <div class="block">Returns authenticating user's screen name.<br>
- This method may internally call verifyCredentials() on the first invocation if<br>
- - this instance is authenticated by Basic and email address is supplied instead of screen name, or
- - this instance is authenticated by OAuth.<br>
- 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>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <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><<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>> action)</code>
- <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <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><<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>> action)</code>
- <div class="block">Registers a lambda action for account associated rate limits</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getScreenName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getScreenName</h4>
- <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> getScreenName()
- throws <a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a>,
- <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>
- <div class="block">Returns authenticating user's screen name.<br>
- This method may internally call verifyCredentials() on the first invocation if<br>
- - this instance is authenticated by Basic and email address is supplied instead of screen name, or
- - this instance is authenticated by OAuth.<br>
- 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>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the authenticating screen name</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when verifyCredentials threw an exception.</dd>
- <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>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 2.1.1</dd>
- </dl>
- </li>
- </ul>
- <a name="getId--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getId</h4>
- <pre>long getId()
- throws <a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a>,
- <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>
- <div class="block">Returns authenticating user's user id.<br>
- This method may internally call verifyCredentials() on the first invocation if<br>
- - this instance is authenticated by Basic and email address is supplied instead of screen name, or
- - this instance is authenticated by OAuth.<br></div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the authenticating user's id</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when verifyCredentials threw an exception.</dd>
- <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>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 2.1.1</dd>
- </dl>
- </li>
- </ul>
- <a name="addRateLimitStatusListener-twitter4j.RateLimitStatusListener-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addRateLimitStatusListener</h4>
- <pre>void addRateLimitStatusListener(<a href="../twitter4j/RateLimitStatusListener.html" title="interface in twitter4j">RateLimitStatusListener</a> listener)</pre>
- <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>listener</code> - the listener to be added</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 2.1.12</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
- </dl>
- </li>
- </ul>
- <a name="onRateLimitStatus-twitter4j.util.function.Consumer-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onRateLimitStatus</h4>
- <pre>void onRateLimitStatus(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a><<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>> action)</pre>
- <div class="block">Registers a lambda action for account associated rate limits</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>action</code> - the action to be added</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 4.0.4</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
- </dl>
- </li>
- </ul>
- <a name="onRateLimitReached-twitter4j.util.function.Consumer-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onRateLimitReached</h4>
- <pre>void onRateLimitReached(<a href="../twitter4j/util/function/Consumer.html" title="interface in twitter4j.util.function">Consumer</a><<a href="../twitter4j/RateLimitStatusEvent.html" title="class in twitter4j">RateLimitStatusEvent</a>> action)</pre>
- <div class="block">Registers a RateLimitStatusListener for account associated rate limits</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>action</code> - the action to be added</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 4.0.4</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="https://dev.twitter.com/docs/rate-limiting">Rate Limiting | Twitter Developers</a></dd>
- </dl>
- </li>
- </ul>
- <a name="getAuthorization--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAuthorization</h4>
- <pre><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a> getAuthorization()</pre>
- <div class="block">Returns the authorization scheme for this instance.<br>
- The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the authorization scheme for this instance</dd>
- </dl>
- </li>
- </ul>
- <a name="getConfiguration--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>getConfiguration</h4>
- <pre><a href="../twitter4j/conf/Configuration.html" title="interface in twitter4j.conf">Configuration</a> getConfiguration()</pre>
- <div class="block">Returns the configuration associated with this instance</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>configuration associated with this instance</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>Twitter4J 2.1.8</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/TwitterBase.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../deprecated-list.html">Deprecated</a></li>
- <li><a href="../index-all.html">Index</a></li>
- <li><a href="../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../twitter4j/TwitterAPIMonitor.html" title="class in twitter4j"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../twitter4j/TwitterException.html" title="class in twitter4j"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?twitter4j/TwitterBase.html" target="_top">Frames</a></li>
- <li><a href="TwitterBase.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2018. All rights reserved.</small></p>
- </body>
- </html>
|